libyui
3.4.2
|
Helper class to manage keyboard shortcuts within one dialog and resolve keyboard shortcut conflicts. More...
#include <YShortcutManager.h>
Public Member Functions | |
YShortcutManager (YDialog *dialog) | |
Constructor. | |
virtual | ~YShortcutManager () |
Destructor. | |
void | checkShortcuts (bool autoResolve=true) |
Check the keyboard shortcuts of all children of this dialog (not for sub-dialogs!). More... | |
int | conflictCount () |
Returns the number of shortcut conflicts. More... | |
void | resolveAllConflicts () |
Resolve shortcut conflicts. More... | |
YDialog * | dialog () |
Returns the dialog this shortcut manager works on. | |
Protected Member Functions | |
void | clearShortcutList () |
Delete all members of the internal shortcut list, then empty the list. | |
void | findShortcutWidgets (YWidgetListConstIterator begin, YWidgetListConstIterator end) |
Recursively search all widgets between iterators 'begin' and 'end' (not those of any sub-dialogs!) for child widgets that could accept a keyboard shortcut and add these to _shortcutList. | |
void | resolveConflict (YShortcut *shortcut) |
Pick a new shortcut character for 'shortcut' - one that isn't marked as used in the '_used' array. More... | |
int | findShortestWizardButton (const YShortcutList &conflictList) |
Find the shortest wizard button in 'conflictList', if there is any. More... | |
unsigned | findShortestWidget (const YShortcutList &conflictList) |
Find the shortest widget in 'conflictList'. More... | |
Protected Attributes | |
YDialog * | _dialog |
The dialog this shortcut manager works on. | |
YShortcutList | _shortcutList |
List of all the shortcuts in this dialog. | |
int | _wanted [sizeof(char)<< 8] |
Counters for wanted shortcut characters. | |
bool | _used [sizeof(char)<< 8] |
Flags for used shortcut characters. | |
int | _conflictCount |
Counter for shortcut conflicts. | |
Helper class to manage keyboard shortcuts within one dialog and resolve keyboard shortcut conflicts.
Definition at line 38 of file YShortcutManager.h.
void YShortcutManager::checkShortcuts | ( | bool | autoResolve = true | ) |
Check the keyboard shortcuts of all children of this dialog (not for sub-dialogs!).
Call resolveAllConflicts() if 'autoResolve' is 'true'.
Definition at line 60 of file YShortcutManager.cc.
|
inline |
Returns the number of shortcut conflicts.
Valid only after checkShortcuts() or resolveAllConflicts().
Definition at line 63 of file YShortcutManager.h.
|
protected |
Find the shortest widget in 'conflictList'.
Buttons get priority if they have the same number of eligible shortcut characters as another widget.
Returns the index of the shortest widget.
Definition at line 332 of file YShortcutManager.cc.
|
protected |
Find the shortest wizard button in 'conflictList', if there is any.
Returns the index of that shortest wizard button or -1 if there is none.
Definition at line 307 of file YShortcutManager.cc.
void YShortcutManager::resolveAllConflicts | ( | ) |
Resolve shortcut conflicts.
Requires checkShortcuts() to be called first.
Note: This may or may not work. There is no general solution to that problem. This method tries its best, but you may end up with widgets that don't have any ( more ) shortcut.
Why? Just picture the following ( admittedly pathologic ) situation:
[& OK] [& OK] [& OK]
This will result in something like this:
[& OK] [O& K] [OK]
I.e. the first OK button will retain its preferred shortcut ( 'O' ), the second OK button's shortcut will be reassigned to 'K' and the third won't get any - there are simply not enough eligible shortcut characters.
This may even fail in much less pathological situations. This example is only supposed to give you a general idea why not to blindly rely on automatic shortcut resolving.
It's always best to resolve conflicts manually. This will generally result in much better shortcuts: Easier to memorize, less chance of picking characters that cannot really do a good job showing their shortcut like very narrow characters ( .e.g., 'i' ) or descender characters ( e.g., 'g', 'p', 'q' - imagine those underlined! ).
Definition at line 161 of file YShortcutManager.cc.
|
protected |
Pick a new shortcut character for 'shortcut' - one that isn't marked as used in the '_used' array.
Unset the conflict marker if that succeeded.
Definition at line 229 of file YShortcutManager.cc.