KShortcut Class Reference
#include <kshortcut.h>
Detailed Description
The KShortcut class is used to represent a keyboard shortcut to an action.A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key which will also activate the action it's associated to, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.
This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.
KAction *closeAction = KStdAction::close( this, SLOT( close() ), actionCollection() ); KShortcut closeShortcut = closeAction->shortcut(); closeShortcut.append( KKey(Key_Escape)); closeAction->setShortcut(closeShortcut);
Note that a shortcut cannot have more than 2 key combinations associated with it, so the above code would not do anything (and append() would return false) if the closeAction already had an key and alternate key.
Definition at line 543 of file kshortcut.h.
Public Types | |
enum | { MAX_SEQUENCES = 2 } |
Public Member Functions | |
KShortcut () | |
KShortcut (int keyQt) | |
KShortcut (const QKeySequence &keySeq) | |
KShortcut (const KKey &key) | |
KShortcut (const KKeySequence &keySeq) | |
KShortcut (const KShortcut &shortcut) | |
KShortcut (const char *shortcut) | |
KShortcut (const QString &shortcut) | |
void | clear () |
bool | init (int keyQt) |
bool | init (const QKeySequence &keySeq) |
bool | init (const KKey &key) |
bool | init (const KKeySequence &keySeq) |
bool | init (const KShortcut &shortcut) |
bool | init (const QString &shortcut) |
KShortcut & | operator= (const KShortcut &cut) |
uint | count () const |
const KKeySequence & | seq (uint i) const |
int | keyCodeQt () const |
bool | isNull () const |
int | compare (const KShortcut &shortcut) const |
bool | operator== (const KShortcut &cut) const |
bool | operator!= (const KShortcut &cut) const |
bool | operator< (const KShortcut &cut) const |
bool | contains (const KKey &key) const |
bool | contains (const KKeyNative &key) const |
bool | contains (const KKeySequence &keySeq) const |
bool | setSeq (uint i, const KKeySequence &keySeq) |
bool | append (const KKeySequence &keySeq) |
void | remove (const KKeySequence &keySeq) |
bool | append (const KKey &spec) |
bool | append (const KShortcut &cut) |
operator QKeySequence () const | |
QString | toString () const |
QString | toStringInternal (const KShortcut *pcutDefault=0) const |
operator int () const | |
Static Public Member Functions | |
static KShortcut & | null () |
Protected Attributes | |
uint | m_nSeqs |
KKeySequence | m_rgseq [MAX_SEQUENCES] |
Friends | |
class | KKeyNative |
Member Enumeration Documentation
|
The maximum number of key sequences that can be contained in a KShortcut.
Definition at line 550 of file kshortcut.h. |
Constructor & Destructor Documentation
|
Creates a new null shortcut.
Definition at line 402 of file kshortcut.cpp. |
|
Creates a new shortcut with the given Qt key code as the only key sequence.
Definition at line 403 of file kshortcut.cpp. |
|
Creates a new shortcut that contains only the given qt key sequence.
Definition at line 404 of file kshortcut.cpp. |
|
Creates a new shortcut that contains only the given key in its only sequence.
Definition at line 405 of file kshortcut.cpp. |
|
Creates a new shortcut that contains only the given key sequence.
Definition at line 406 of file kshortcut.cpp. |
|
Copies the given shortcut.
Definition at line 407 of file kshortcut.cpp. |
|
Creates a new key sequence that contains the given key sequence. The description consists of semicolon-separated keys as used in KKeySequence::KKeySequence(const QString&).
Definition at line 408 of file kshortcut.cpp. |
|
Creates a new key sequence that contains the given key sequence. The description consists of semicolon-separated keys as used in KKeySequence::KKeySequence(const QString&).
Definition at line 409 of file kshortcut.cpp. |
Member Function Documentation
|
Appends the sequences from the given shortcut.
Definition at line 606 of file kshortcut.cpp. |
|
Appends the given key.
Definition at line 596 of file kshortcut.cpp. |
|
Appends the given key sequence. This sets it as either the keysequence or the alternate keysequence. If the shortcut already has MAX_SEQUENCES sequences then this call does nothing, and returns false.
Definition at line 584 of file kshortcut.cpp. |
|
Clears the shortcut. The shortcut is null after calling this function.
Definition at line 415 of file kshortcut.cpp. |
|
Compares this object with the given shortcut. Returns a negative number if the given shortcut is larger, 0 if they are equal and a positive number this shortcut is larger. Shortcuts are compared by comparing the individual key sequences, starting from the beginning until an unequal key sequences has been found. If a shortcut contains more key sequences, it is considered larger.
Definition at line 519 of file kshortcut.cpp. |
|
Checks whether this shortcut contains the given sequence.
Definition at line 548 of file kshortcut.cpp. |
|
Checks whether this shortcut contains a sequence that starts with the given key.
Definition at line 534 of file kshortcut.cpp. |
|
Checks whether this shortcut contains a sequence that starts with the given key.
Definition at line 529 of file kshortcut.cpp. |
|
Returns the number of sequences that are in this shortcut.
Definition at line 497 of file kshortcut.cpp. |
|
Initializes the key sequence with the given key sequence. The description consists of semicolon-separated keys as used in KKeySequence::KKeySequence(const QString&).
Definition at line 459 of file kshortcut.cpp. |
|
Copies the given shortcut.
Definition at line 451 of file kshortcut.cpp. |
|
Initializes the shortcut with the given qt key sequence.
Definition at line 444 of file kshortcut.cpp. |
|
Initializes the shortcut with the given key as its only sequence.
Definition at line 437 of file kshortcut.cpp. |
|
Initializes the shortcut with the given qt key sequence.
Definition at line 430 of file kshortcut.cpp. |
|
Initializes the shortcut with the given Qt key code as the only key sequence.
Definition at line 420 of file kshortcut.cpp. |
|
Returns true if the shortcut is null (after clear() or empty constructor).
Definition at line 514 of file kshortcut.cpp. |
|
Returns the key code of the first key sequence, or null if there is no first key sequence.
Definition at line 507 of file kshortcut.cpp. |
|
Returns a null shortcut.
Definition at line 664 of file kshortcut.cpp. |
|
Converts this shortcut to a key sequence. The first key sequence will be taken. Definition at line 624 of file kshortcut.cpp. |
|
Compares the sequences of both shortcuts.
Definition at line 729 of file kshortcut.h. |
|
Compares the sequences of both shortcuts.
Definition at line 736 of file kshortcut.h. |
|
Copies the given shortcut over this shortcut.
Definition at line 665 of file kshortcut.h. |
|
Compares the sequences of both shortcuts.
Definition at line 722 of file kshortcut.h. |
|
Removes the given key sequence from this shortcut.
Definition at line 569 of file kshortcut.cpp. |
|
Returns the
Definition at line 502 of file kshortcut.cpp. |
|
Sets the
You can not introduce gaps in the list of sequences, so you must use an
Definition at line 557 of file kshortcut.cpp. |
|
Returns a description of the shortcut as semicolon-separated ket sequences, as returned by KKeySequence::toString().
Definition at line 632 of file kshortcut.cpp. |
The documentation for this class was generated from the following files: