YShortcut.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  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 Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YShortcut.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/


#ifndef YShortcut_h
#define YShortcut_h

#include <iosfwd>
#include <string>
#include <vector>

#include "YWidget.h"
#include "YItem.h"


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; }

    virtual bool isMenuItem() const { return false; }

    std::string shortcutString();

    std::string cleanShortcutString();

    static std::string cleanShortcutString( std::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();

    virtual std::string debugLabel() const { return _widget->debugLabel(); }

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

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

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

    static bool isValid( char c );

    static char normalized( char c );

    static std::string getShortcutString( const YWidget * widget );


protected:

    virtual std::string getShortcutString();


    // Data members

    YWidget *   _widget;               
    std::string _shortcutString;       
    bool    _shortcutStringCached; 

    std::string _cleanShortcutString;
    bool    _cleanShortcutStringCached; 

    int     _preferred;

    int     _shortcut;

    bool    _conflict;       
    bool    _isButton;       
    bool    _isWizardButton; 

    int     _distinctShortcutChars;
};



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

    virtual ~YItemShortcut() {}

    YItem * item() const { return _item; }

    virtual void setShortcut( char newShortcut );

    virtual bool isMenuItem() const { return _isMenuItem; }

    virtual std::string debugLabel() const
        { return cleanShortcutString( _item->debugLabel() ); }


protected:

    virtual std::string getShortcutString();


private:

    YItem * _item;
    bool    _isMenuItem;
};


std::ostream & operator<<( std::ostream & stream, const YShortcut * shortcut );


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


#endif // YShortcut_h