/data/gitorious.org/libyui/libyui-master/src/YShortcut.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ 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>
#include <vector>

using std::vector;
class YItem;


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

    virtual ~YShortcut();

    enum { None = 0 };

    YWidget * widget() const { return _widget; }
    
    const char * widgetClass() const { 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();

    virtual void setShortcut( char newShortcut );

    void clearShortcut();

    bool conflict() { return _conflict; }

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

    int distinctShortcutChars();

    bool hasValidShortcutChar();
    
    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( const YWidget * widget );

    
protected:

    virtual string getShortcutString();
    

    // Data members
    
    YWidget *   _widget;
    string      _shortcutString;
    bool        _shortcutStringCached;
    
    string      _cleanShortcutString;
    bool        _cleanShortcutStringCached;
    
    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;
};



class YItemShortcut: public YShortcut
{
public:
    YItemShortcut( YWidget * widget, YItem * item )
        : YShortcut( widget )
        , _item( item )
        {}

    virtual ~YItemShortcut() {}

    YItem * item() const { return _item; }

    virtual void setShortcut( char newShortcut );

protected:

    virtual string getShortcutString();


private:

    YItem * _item;
};


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


#endif // YShortcut_h