YShortcut.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:       YShortcut.h

  Author:     Stefan Hundhammer <sh@suse.de>

/-*/


#ifndef YShortcut_h
#define YShortcut_h

#include "YWidget.h"
#include <string>


class YShortcut
{
public:
    YShortcut( YWidget *shortcut_widget );

    virtual ~YShortcut();

    enum { None = 0 };

    YWidget *   widget() { return _widget; }
    
    const char *widgetClass() { return widget()->widgetClass(); }

    bool isButton() const { return _isButton; }

    bool isWizardButton() const { return _isWizardButton; }

    string shortcutString();

    string cleanShortcutString();

    static string cleanShortcutString( string shortcutString );

    char preferred();

    char shortcut();

    void setShortcut( char new_shortcut );

    void clearShortcut();

    bool conflict() { return _conflict; }

    void setConflict( bool newConflictState = true ) { _conflict = newConflictState; }

    int distinctShortcutChars();
    
    static char shortcutMarker() { return '&'; }

    static string::size_type findShortcutPos( const string & str, string::size_type start_pos = 0 );

    static char findShortcut( const string & str, string::size_type start_pos = 0 );

    static bool isValid( char c );

    static char normalized( char c );

    static string getShortcutString( YWidget * widget );

    
protected:

    string getShortcutString();
    

    // Data members
    
    YWidget *   _widget;
    string      _shortcut_string;
    bool        _shortcut_string_chached;
    
    string      _clean_shortcut_string;
    bool        _clean_shortcut_string_chached;
    
    int         _preferred;     // int to enable initializing with invalid char ( -1 )
    int         _shortcut;      // int to enable initializing with invalid char ( -1 )
    
    bool        _conflict;
    bool        _isButton;
    bool        _isWizardButton;
    int         _distinctShortcutChars;
};

typedef vector<YShortcut *>             YShortcutList;
typedef YShortcutList::iterator         YShortcutListIterator;


#endif // YShortcut_h

---