libyui  3.4.2
YItemShortcut Class Reference

Special case for widgets that can have multiple shortcuts based on items (like YDumbTab) More...

#include <YShortcut.h>

Inheritance diagram for YItemShortcut:
YShortcut

Public Member Functions

 YItemShortcut (YWidget *widget, YItem *item)
 Constructor.
 
virtual ~YItemShortcut ()
 Destructor.
 
YItemitem () const
 Return the associated item.
 
virtual void setShortcut (char newShortcut)
 Set (override) the shortcut character. More...
 
- Public Member Functions inherited from YShortcut
 YShortcut (YWidget *shortcut_widget)
 Constructor.
 
virtual ~YShortcut ()
 Destructor.
 
YWidgetwidget () const
 Returns the YWidget this shortcut data belong to.
 
const char * widgetClass () const
 Returns the textual representation of the widget class of the widget this shortcut data belongs to.
 
bool isButton () const
 Returns 'true' if the widget that is associated with this shortcut is a button (derived from YPushButton).
 
bool isWizardButton () const
 Returns 'true' if the widget that is associated with this shortcut is a wizard button (one of the navigation buttons of a wizard).
 
std::string shortcutString ()
 Returns the complete shortcut string (which may or may not contain "&"), i.e. More...
 
std::string cleanShortcutString ()
 Returns the shortcut string ( from the widget's shortcut property ) without any "&" markers.
 
char preferred ()
 The preferred shortcut character, i.e. More...
 
char shortcut ()
 The actual shortcut character. More...
 
void clearShortcut ()
 Clear the shortcut: Override the shortcut character with nothing. More...
 
bool conflict ()
 Query the internal 'conflict' marker. More...
 
void setConflict (bool newConflictState=true)
 Set or unset the internal 'conflict' marker.
 
int distinctShortcutChars ()
 Obtain the number of distinct valid shortcut characters in the shortcut string, i.e. More...
 
bool hasValidShortcutChar ()
 Return true if this shortcut contains any character that would be valid as a shortcut character.
 

Protected Member Functions

virtual std::string getShortcutString ()
 Obtain the the shortcut property of this shortcut's widget - the string that contains "&" to designate a shortcut.
 

Additional Inherited Members

- Public Types inherited from YShortcut
enum  { None = 0 }
 Marker for "no shortcut".
 
- Static Public Member Functions inherited from YShortcut
static std::string cleanShortcutString (std::string shortcutString)
 Static version of the above for general use: Returns the specified string without any "&" markers.
 
static char shortcutMarker ()
 Static function: Returns the character used for marking keyboard shortcuts.
 
static std::string::size_type findShortcutPos (const std::string &str, std::string::size_type start_pos=0)
 Static function: Find the next occurrence of the shortcut marker ('&') in a string, beginning at starting position start_pos. More...
 
static char findShortcut (const std::string &str, std::string::size_type start_pos=0)
 Static function: Find the next shortcut marker in a string, beginning at starting position start_pos. More...
 
static bool isValid (char c)
 Returns 'true' if 'c' is a valid shortcut character, i.e. More...
 
static char normalized (char c)
 Return the normalized version of shortcut character 'c', i.e. More...
 
static std::string getShortcutString (const YWidget *widget)
 Obtain a widget's shortcut property - the string that contains "&" to designate a shortcut.
 
- Protected Attributes inherited from YShortcut
YWidget_widget
 
std::string _shortcutString
 
bool _shortcutStringCached
 
std::string _cleanShortcutString
 
bool _cleanShortcutStringCached
 
int _preferred
 
int _shortcut
 
bool _conflict
 
bool _isButton
 
bool _isWizardButton
 
int _distinctShortcutChars
 

Detailed Description

Special case for widgets that can have multiple shortcuts based on items (like YDumbTab)

Definition at line 225 of file YShortcut.h.

Member Function Documentation

◆ setShortcut()

void YItemShortcut::setShortcut ( char  newShortcut)
virtual

Set (override) the shortcut character.

In this subclass, it will change the internally stored item.

Reimplemented from YShortcut.

Definition at line 320 of file YShortcut.cc.


The documentation for this class was generated from the following files: