KShortcut Class Reference
The KShortcut class is used to represent a keyboard shortcut to an action. More...
#include <kshortcut.h>
Public Types | |
enum | { MAX_SEQUENCES = 2 } |
Public Methods | |
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) | |
~KShortcut () | |
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) |
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 Methods | |
KShortcut & | null () |
Protected Attributes | |
uint | m_nSeqs |
KKeySequence | m_rgseq [MAX_SEQUENCES] |
Friends | |
class | KKeyNative |
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.
Definition at line 524 of file kshortcut.h.
Member Enumeration Documentation
|
The maximum number of key sequences that can be contained in a KShortcut.
Definition at line 531 of file kshortcut.h. |
Constructor & Destructor Documentation
|
Creates a new null shortcut.
Definition at line 416 of file kshortcut.cpp. References clear(). |
|
Creates a new shortcut with the given Qt key code as the only key sequence.
Definition at line 417 of file kshortcut.cpp. References init(). |
|
Creates a new shortcut that contains only the given qt key sequence.
Definition at line 418 of file kshortcut.cpp. References init(), and KStdAccel::key(). |
|
Creates a new shortcut that contains only the given key in its only sequence.
Definition at line 419 of file kshortcut.cpp. References init(), and KStdAccel::key(). |
|
Creates a new shortcut that contains only the given key sequence.
Definition at line 420 of file kshortcut.cpp. References init(). |
|
Copies the given shortcut.
Definition at line 421 of file kshortcut.cpp. References init(). |
|
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 422 of file kshortcut.cpp. References init(). |
|
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 423 of file kshortcut.cpp. References init(). |
Member Function Documentation
|
Clears the shortcut. The shortcut is null after calling this function.
Definition at line 429 of file kshortcut.cpp. |
|
Initializes the shortcut with the given Qt key code as the only key sequence.
Definition at line 434 of file kshortcut.cpp. References clear(), and KKeySequence::init(). Referenced by KAccel::insertItem(), KShortcut(), operator=(), KStdAccel::shortcutDefault3(), and KStdAccel::shortcutDefault4(). |
|
Initializes the shortcut with the given qt key sequence.
Definition at line 444 of file kshortcut.cpp. References KKeySequence::init(), and KStdAccel::key(). |
|
Initializes the shortcut with the given key as its only sequence.
Definition at line 451 of file kshortcut.cpp. References KKeySequence::init(). |
|
Initializes the shortcut with the given qt key sequence.
Definition at line 458 of file kshortcut.cpp. |
|
Copies the given shortcut.
Definition at line 465 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 473 of file kshortcut.cpp. References clear(), KKeyServer::Variations::count(), KKeyServer::Variations::init(), KKeySequence::init(), QString::isEmpty(), KStdAccel::key(), QString::length(), KKeyServer::Variations::m_rgkey, QString::mid(), QString::number(), QStringList::split(), and QString::startsWith(). |
|
Copies the given shortcut over this shortcut.
Definition at line 646 of file kshortcut.h. References init(). |
|
Returns the number of sequences that are in this shortcut.
Definition at line 511 of file kshortcut.cpp. Referenced by append(), contains(), operator QKeySequence(), and toString(). |
|
Returns the
Definition at line 516 of file kshortcut.cpp. References KKeySequence::null(). Referenced by append(). |
|
Returns the key code of the first key sequence, or null if there is no first key sequence.
Definition at line 521 of file kshortcut.cpp. References KKeySequence::keyCodeQt(). Referenced by KGlobalSettings::contextMenuKey(), KStdAccel::defaultKey(), and KStdAccel::key(). |
|
Returns true if the shortcut is null (after clear() or empty constructor).
Definition at line 528 of file kshortcut.cpp. Referenced by null(), and KCompletionBase::setKeyBinding(). |
|
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 533 of file kshortcut.cpp. References KKeySequence::compare(), m_nSeqs, and m_rgseq. Referenced by operator!=(), operator<(), and operator==(). |
|
Compares the sequences of both shortcuts.
Definition at line 703 of file kshortcut.h. References compare(). |
|
Compares the sequences of both shortcuts.
Definition at line 710 of file kshortcut.h. References compare(). |
|
Compares the sequences of both shortcuts.
Definition at line 717 of file kshortcut.h. References compare(). |
|
Checks whether this shortcut contains a sequence that starts with the given key.
Definition at line 543 of file kshortcut.cpp. References KStdAccel::key(). Referenced by append(), and KShortcutList::index(). |
|
Checks whether this shortcut contains a sequence that starts with the given key.
Definition at line 548 of file kshortcut.cpp. References KKeySequence::count(), count(), KKeySequence::isNull(), KKeySequence::key(), KKeyNative::key(), KStdAccel::key(), and KKey::simplify(). |
|
Checks whether this shortcut contains the given sequence.
Definition at line 562 of file kshortcut.cpp. References count(), and KKeySequence::isNull(). |
|
Sets the
You can not introduce gaps in the list of sequences, so you must use an
Definition at line 571 of file kshortcut.cpp. |
|
Appends the given key sequence.
Definition at line 583 of file kshortcut.cpp. References KKeySequence::isNull(). Referenced by KStdAccel::shortcutDefault3(), and KStdAccel::shortcutDefault4(). |
|
Appends the given key.
Definition at line 595 of file kshortcut.cpp. |
|
Appends the sequences from the given shortcut.
Definition at line 605 of file kshortcut.cpp. |
|
Converts this shortcut to a key sequence. The first key sequence will be taken. Definition at line 623 of file kshortcut.cpp. References count(), and KKeySequence::qt(). |
|
Returns a description of the shortcut as semicolon-separated ket sequences, as returned by KKeySequence::toString().
Definition at line 631 of file kshortcut.cpp. References count(), and KKeySequence::toString(). |
|
Returns a null shortcut.
Definition at line 663 of file kshortcut.cpp. References clear(), and isNull(). Referenced by KStdAccel::shortcut(), KGlobalAccel::shortcut(), and KAccel::shortcut(). |
The documentation for this class was generated from the following files: