Home · All Classes · All Functions · Overviews

QKeySequence Class Reference
[QtGui module]

The QKeySequence class encapsulates a key sequence as used by shortcuts. More...

 #include <QKeySequence>

Public Types

enum SequenceFormat { NativeText, PortableText }
enum SequenceMatch { NoMatch, PartialMatch, ExactMatch }
enum StandardKey { AddTab, Back, Bold, Close, ..., ZoomOut }

Public Functions

QKeySequence ()
QKeySequence ( const QString & key )
QKeySequence ( int k1, int k2 = 0, int k3 = 0, int k4 = 0 )
QKeySequence ( const QKeySequence & keysequence )
QKeySequence ( StandardKey key )
~QKeySequence ()
uint count () const
bool isEmpty () const
SequenceMatch matches ( const QKeySequence & seq ) const
QString toString ( SequenceFormat format = PortableText ) const
operator QVariant () const
bool operator!= ( const QKeySequence & other ) const
bool operator< ( const QKeySequence & other ) const
bool operator<= ( const QKeySequence & other ) const
QKeySequence & operator= ( const QKeySequence & other )
bool operator== ( const QKeySequence & other ) const
bool operator> ( const QKeySequence & other ) const
bool operator>= ( const QKeySequence & other ) const
int operator[] ( uint index ) const

Static Public Members

QKeySequence fromString ( const QString & str, SequenceFormat format = PortableText )
QList<QKeySequence> keyBindings ( StandardKey key )
QKeySequence mnemonic ( const QString & text )

Related Non-Members

QDataStream & operator<< ( QDataStream & stream, const QKeySequence & sequence )
QDataStream & operator>> ( QDataStream & stream, QKeySequence & sequence )

Detailed Description

The QKeySequence class encapsulates a key sequence as used by shortcuts.

In its most common form, a key sequence describes a combination of keys that must be used together to perform some action. Key sequences are used with QAction objects to specify which keyboard shortcuts can be used to trigger actions.

Key sequences can be constructed for use as keyboard shortcuts in three different ways:

For example, Ctrl P might be a sequence used as a shortcut for printing a document, and can be specified in any of the following ways:

 QKeySequence(Qt::CTRL + Qt::Key_P);

Note that, for letters, the case used in the specification string does not matter. In the above examples, the user does not need to hold down the Shift key to activate a shortcut specified with "Ctrl+P". However, for other keys, the use of Shift as an unspecified extra modifier key can lead to confusion for users of an application whose keyboards have different layouts to those used by the developers. See the Keyboard Layout Issues section below for more details.

It is preferable to use standard shortcuts where possible. When creating key sequences for non-standard shortcuts, you should use human-readable strings in preference to hard-coded integer values.

QKeySequence objects can be cast to a QString to obtain a human-readable translated version of the sequence. Similarly, the toString() function produces human-readable strings for use in menus. On Mac OS X, the appropriate symbols are used to describe keyboard shortcuts using special keys on the Macintosh keyboard.

An alternative way to specify hard-coded key codes is to use the Unicode code point of the character; for example, 'A' gives the same key sequence as Qt::Key_A.

Note: On Mac OS X, references to "Ctrl", Qt::CTRL, Qt::Control and Qt::ControlModifier correspond to the Command keys on the Macintosh keyboard, and references to "Meta", Qt::META, Qt::Meta and Qt::MetaModifier correspond to the Control keys. Developers on Mac OS X can use the same shortcut descriptions across all platforms, and their applications will automatically work as expected on Mac OS X.

Standard Shortcuts

QKeySequence defines many standard keyboard shortcuts to reduce the amount of effort required when setting up actions in a typical application. The table below shows some common key sequences that are often used for these standard shortcuts by applications on four widely-used platforms. Note that on Mac OS X, the Ctrl value corresponds to the Command keys on the Macintosh keyboard, and the Meta value corresponds to the Control keys.

StandardKeyWindowsMac OS XKDEGNOMES60
CloseCtrl+F4, Ctrl+WCtrl+W, Ctrl+F4Ctrl+WCtrl+W(none)
DeleteDelDel, Meta+DDel, Ctrl+DDel, Ctrl+DDel
CutCtrl+X, Shift+DelCtrl+XCtrl+X, F20, Shift+DelCtrl+X, F20, Shift+DelCtrl+X
CopyCtrl+C, Ctrl+InsCtrl+CCtrl+C, F16, Ctrl+InsCtrl+C, F16, Ctrl+InsCtrl+C
PasteCtrl+V, Shift+InsCtrl+VCtrl+V, F18, Shift+InsCtrl+V, F18, Shift+InsCtrl+V
UndoCtrl+Z, Alt+BackspaceCtrl+ZCtrl+Z, F14Ctrl+Z, F14Ctrl+Z
RedoCtrl+Y, Shift+Ctrl+Z, Alt+Shift+BackspaceCtrl+Shift+Z, Ctrl+YCtrl+Shift+ZCtrl+Shift+Z(none)
BackAlt+Left, BackspaceCtrl+[Alt+LeftAlt+Left(none)
ForwardAlt+Right, Shift+BackspaceCtrl+]Alt+RightAlt+Right(none)
RefreshF5F5F5Ctrl+R, F5(none)
AddTabCtrl+TCtrl+TCtrl+Shift+N, Ctrl+TCtrl+T(none)
NextChildCtrl+Tab, Forward, Ctrl+F6Ctrl+}, Forward, Ctrl+TabCtrl+Tab, Forward, Ctrl+CommaCtrl+Tab, Forward(none)
PreviousChildCtrl+Shift+Tab, Back, Ctrl+Shift+F6Ctrl+{, Back, Ctrl+Shift+TabCtrl+Shift+Tab, Back, Ctrl+PeriodCtrl+Shift+Tab, Back(none)
FindNextF3, Ctrl+GCtrl+GF3Ctrl+G, F3(none)
FindPreviousShift+F3, Ctrl+Shift+GCtrl+Shift+GShift+F3Ctrl+Shift+G, Shift+F3(none)
MoveToNextPagePgDownPgDown, Alt+PgDown, Meta+Down, Meta+PgDownPgDownPgDownPgDown
MoveToPreviousPagePgUpPgUp, Alt+PgUp, Meta+Up, Meta+PgUpPgUpPgUpPgUp
MoveToStartOfLineHomeCtrl+Left, Meta+LeftHomeHomeHome
MoveToEndOfLineEndCtrl+Right, Meta+RightEndEndEnd
MoveToStartOfBlock(none)Alt+Up, Meta+A(none)(none)(none)
MoveToEndOfBlock(none)Alt+Down, Meta+E(none)(none)(none)
MoveToStartOfDocumentCtrl+HomeCtrl+Up, HomeCtrl+HomeCtrl+HomeCtrl+Home
MoveToEndOfDocumentCtrl+EndCtrl+Down, EndCtrl+EndCtrl+EndCtrl+End
SelectStartOfBlock(none)Alt+Shift+Up, Meta+Shift+A(none)(none)(none)
SelectEndOfBlock(none)Alt+Shift+Down, Meta+Shift+E(none)(none)(none)
SelectStartOfDocumentCtrl+Shift+HomeCtrl+Shift+Up, Shift+HomeCtrl+Shift+HomeCtrl+Shift+HomeCtrl+Shift+Home
SelectEndOfDocumentCtrl+Shift+EndCtrl+Shift+Down, Shift+EndCtrl+Shift+EndCtrl+Shift+EndCtrl+Shift+End

Note that, since the key sequences used for the standard shortcuts differ between platforms, you still need to test your shortcuts on each platform to ensure that you do not unintentionally assign the same key sequence to many actions.

Keyboard Layout Issues

Many key sequence specifications are chosen by developers based on the layout of certain types of keyboard, rather than choosing keys that represent the first letter of an action's name, such as Ctrl S ("Ctrl+S") or Ctrl C ("Ctrl+C"). Additionally, because certain symbols can only be entered with the help of modifier keys on certain keyboard layouts, key sequences intended for use with one keyboard layout may map to a different key, map to no keys at all, or require an additional modifier key to be used on different keyboard layouts.

For example, the shortcuts, Ctrl plus and Ctrl minus, are often used as shortcuts for zoom operations in graphics applications, and these may be specified as "Ctrl++" and "Ctrl+-" respectively. However, the way these shortcuts are specified and interpreted depends on the keyboard layout. Users of Norwegian keyboards will note that the + and - keys are not adjacent on the keyboard, but will still be able to activate both shortcuts without needing to press the Shift key. However, users with British keyboards will need to hold down the Shift key to enter the + symbol, making the shortcut effectively the same as "Ctrl+Shift+=".

Although some developers might resort to fully specifying all the modifiers they use on their keyboards to activate a shortcut, this will also result in unexpected behavior for users of different keyboard layouts.

For example, a developer using a British keyboard may decide to specify "Ctrl+Shift+=" as the key sequence in order to create a shortcut that coincidentally behaves in the same way as Ctrl plus. However, the = key needs to be accessed using the Shift key on Norwegian keyboard, making the required shortcut effectively Ctrl Shift Shift = (an impossible key combination).

As a result, both human-readable strings and hard-coded key codes can both be problematic to use when specifying a key sequence that can be used on a variety of different keyboard layouts. Only the use of standard shortcuts guarantees that the user will be able to use the shortcuts that the developer intended.

Despite this, we can address this issue by ensuring that human-readable strings are used, making it possible for translations of key sequences to be made for users of different languages. This approach will be successful for users whose keyboards have the most typical layout for the language they are using.

GNU Emacs Style Key Sequences

Key sequences similar to those used in GNU Emacs, allowing up to four key codes, can be created by using the multiple argument constructor, or by passing a human-readable string of comma-separated key sequences.

For example, the key sequence, Ctrl X followed by Ctrl C, can be specified using either of the following ways:

 QKeySequence(tr("Ctrl+X, Ctrl+C"));
 QKeySequence(Qt::CTRL + Qt::Key_X, Qt::CTRL + Qt::Key_C);

Warning: A QApplication instance must have been constructed before a QKeySequence is created; otherwise, your application may crash.

See also QShortcut.

Member Type Documentation

enum QKeySequence::SequenceFormat

QKeySequence::NativeText0The key sequence as a platform specific string. This means that it will be shown translated and on the Mac it will resemble a key sequence from the menu bar. This enum is best used when you want to display the string to the user.
QKeySequence::PortableText1The key sequence is given in a "portable" format, suitable for reading and writing to a file. In many cases, it will look similar to the native text on Windows and X11.

enum QKeySequence::SequenceMatch

QKeySequence::NoMatch0The key sequences are different; not even partially matching.
QKeySequence::PartialMatch1The key sequences match partially, but are not the same.
QKeySequence::ExactMatch2The key sequences are the same.

enum QKeySequence::StandardKey

This enum represent standard key bindings. They can be used to assign platform dependent keyboard shortcuts to a QAction.

Note that the key bindings are platform dependent. The currently bound shortcuts can be queried using keyBindings().

QKeySequence::AddTab19Add new tab.
QKeySequence::Back13Navigate back.
QKeySequence::Bold27Bold text.
QKeySequence::Close4Close document/tab.
QKeySequence::DeleteEndOfLine60Delete end of line.
QKeySequence::DeleteEndOfWord59Delete word from the end of the cursor.
QKeySequence::DeleteStartOfWord58Delete the beginning of a word up to the cursor.
QKeySequence::Find22Find in document.
QKeySequence::FindNext23Find next result.
QKeySequence::FindPrevious24Find previous result.
QKeySequence::Forward14Navigate forward.
QKeySequence::HelpContents1Open help contents.
QKeySequence::InsertLineSeparator62Insert a new line.
QKeySequence::InsertParagraphSeparator61Insert a new paragraph.
QKeySequence::Italic28Italic text.
QKeySequence::MoveToEndOfBlock41Move cursor to end of block. This shortcut is only used on the OS X.
QKeySequence::MoveToEndOfDocument43Move cursor to end of document.
QKeySequence::MoveToEndOfLine39Move cursor to end of line.
QKeySequence::MoveToNextChar30Move cursor to next character.
QKeySequence::MoveToNextLine34Move cursor to next line.
QKeySequence::MoveToNextPage36Move cursor to next page.
QKeySequence::MoveToNextWord32Move cursor to next word.
QKeySequence::MoveToPreviousChar31Move cursor to previous character.
QKeySequence::MoveToPreviousLine35Move cursor to previous line.
QKeySequence::MoveToPreviousPage37Move cursor to previous page.
QKeySequence::MoveToPreviousWord33Move cursor to previous word.
QKeySequence::MoveToStartOfBlock40Move cursor to start of a block. This shortcut is only used on OS X.
QKeySequence::MoveToStartOfDocument42Move cursor to start of document.
QKeySequence::MoveToStartOfLine38Move cursor to start of line.
QKeySequence::New6Create new document.
QKeySequence::NextChild20Navigate to next tab or child window.
QKeySequence::Open3Open document.
QKeySequence::Preferences64Open the preferences dialog.
QKeySequence::PreviousChild21Navigate to previous tab or child window.
QKeySequence::Print18Print document.
QKeySequence::Quit65Quit the application.
QKeySequence::Refresh15Refresh or reload current document.
QKeySequence::Replace25Find and replace.
QKeySequence::SaveAs63Save document after prompting the user for a file name.
QKeySequence::Save5Save document.
QKeySequence::SelectAll26Select all text.
QKeySequence::SelectEndOfBlock55Extend selection to the end of a text block. This shortcut is only used on OS X.
QKeySequence::SelectEndOfDocument57Extend selection to end of document.
QKeySequence::SelectEndOfLine53Extend selection to end of line.
QKeySequence::SelectNextChar44Extend selection to next character.
QKeySequence::SelectNextLine48Extend selection to next line.
QKeySequence::SelectNextPage50Extend selection to next page.
QKeySequence::SelectNextWord46Extend selection to next word.
QKeySequence::SelectPreviousChar45Extend selection to previous character.
QKeySequence::SelectPreviousLine49Extend selection to previous line.
QKeySequence::SelectPreviousPage51Extend selection to previous page.
QKeySequence::SelectPreviousWord47Extend selection to previous word.
QKeySequence::SelectStartOfBlock54Extend selection to the start of a text block. This shortcut is only used on OS X.
QKeySequence::SelectStartOfDocument56Extend selection to start of document.
QKeySequence::SelectStartOfLine52Extend selection to start of line.
QKeySequence::Underline29Underline text.
QKeySequence::UnknownKey0Unbound key.
QKeySequence::WhatsThis2Activate whats this.
QKeySequence::ZoomIn16Zoom in.
QKeySequence::ZoomOut17Zoom out.

This enum was introduced in Qt 4.2.

Member Function Documentation

QKeySequence::QKeySequence ()

Constructs an empty key sequence.

QKeySequence::QKeySequence ( const QString & key )

Creates a key sequence from the key string. For example "Ctrl+O" gives CTRL+'O'. The strings "Ctrl", "Shift", "Alt" and "Meta" are recognized, as well as their translated equivalents in the "QShortcut" context (using QObject::tr()).

Up to four key codes may be entered by separating them with commas, e.g. "Alt+X,Ctrl+S,Q".

This constructor is typically used with tr(), so that shortcut keys can be replaced in translations:

 QMenu *file = new QMenu(this);
 file->addAction(tr("&Open..."), this, SLOT(open()),
                   QKeySequence(tr("Ctrl+O", "File|Open")));

Note the "File|Open" translator comment. It is by no means necessary, but it provides some context for the human translator.

QKeySequence::QKeySequence ( int k1, int k2 = 0, int k3 = 0, int k4 = 0 )

Constructs a key sequence with up to 4 keys k1, k2, k3 and k4.

The key codes are listed in Qt::Key and can be combined with modifiers (see Qt::Modifier) such as Qt::SHIFT, Qt::CTRL, Qt::ALT, or Qt::META.

QKeySequence::QKeySequence ( const QKeySequence & keysequence )

Copy constructor. Makes a copy of keysequence.

QKeySequence::QKeySequence ( StandardKey key )

Constructs a QKeySequence object for the given key. The result will depend on the currently running platform.

The resulting object will be based on the first element in the list of key bindings for the key.

This function was introduced in Qt 4.2.

QKeySequence::~QKeySequence ()

Destroys the key sequence.

uint QKeySequence::count () const

Returns the number of keys in the key sequence. The maximum is 4.

QKeySequence QKeySequence::fromString ( const QString & str, SequenceFormat format = PortableText )   [static]

Return a QKeySequence from the string str based on format.

This function was introduced in Qt 4.1.

See also toString().

bool QKeySequence::isEmpty () const

Returns true if the key sequence is empty; otherwise returns false.

QList<QKeySequence> QKeySequence::keyBindings ( StandardKey key )   [static]

Returns a list of key bindings for the given key. The result of calling this function will vary based on the target platform. The first element of the list indicates the primary shortcut for the given platform. If the result contains more than one result, these can be considered alternative shortcuts on the same platform for the given key.

This function was introduced in Qt 4.2.

SequenceMatch QKeySequence::matches ( const QKeySequence & seq ) const

Matches the sequence with seq. Returns ExactMatch if successful, PartialMatch if seq matches incompletely, and NoMatch if the sequences have nothing in common. Returns NoMatch if seq is shorter.

QKeySequence QKeySequence::mnemonic ( const QString & text )   [static]

Returns the shortcut key sequence for the mnemonic in text, or an empty key sequence if no mnemonics are found.

For example, mnemonic("E&xit") returns Qt::ALT+Qt::Key_X, mnemonic("&Quit") returns ALT+Key_Q, and mnemonic("Quit") returns an empty QKeySequence.

We provide a list of common mnemonics in English. At the time of writing, Microsoft and Open Group do not appear to have issued equivalent recommendations for other languages.

See also qt_set_sequence_auto_mnemonic().

QString QKeySequence::toString ( SequenceFormat format = PortableText ) const

Return a string representation of the key sequence, based on format.

For example, the value Qt::CTRL+Qt::Key_O results in "Ctrl+O". If the key sequence has multiple key codes, each is separated by commas in the string returned, such as "Alt+X, Ctrl+Y, Z". The strings, "Ctrl", "Shift", etc. are translated using QObject::tr() in the "QShortcut" context.

If the key sequence has no keys, an empty string is returned.

On Mac OS X, the string returned resembles the sequence that is shown in the menu bar.

This function was introduced in Qt 4.1.

See also fromString().

QKeySequence::operator QVariant () const

Returns the key sequence as a QVariant

bool QKeySequence::operator!= ( const QKeySequence & other ) const

Returns true if this key sequence is not equal to the other key sequence; otherwise returns false.

bool QKeySequence::operator< ( const QKeySequence & other ) const

Provides an arbitrary comparison of this key sequence and other key sequence. All that is guaranteed is that the operator returns false if both key sequences are equal and that (ks1 < ks2) == !( ks2 < ks1) if the key sequences are not equal.

This function is useful in some circumstances, for example if you want to use QKeySequence objects as keys in a QMap.

See also operator==(), operator!=(), operator>(), operator<=(), and operator>=().

bool QKeySequence::operator<= ( const QKeySequence & other ) const

Returns true if this key sequence is smaller or equal to the other key sequence; otherwise returns false.

See also operator==(), operator!=(), operator<(), operator>(), and operator>=().

QKeySequence & QKeySequence::operator= ( const QKeySequence & other )

Assignment operator. Assigns the other key sequence to this object.

bool QKeySequence::operator== ( const QKeySequence & other ) const

Returns true if this key sequence is equal to the other key sequence; otherwise returns false.

bool QKeySequence::operator> ( const QKeySequence & other ) const

Returns true if this key sequence is larger than the other key sequence; otherwise returns false.

See also operator==(), operator!=(), operator<(), operator<=(), and operator>=().

bool QKeySequence::operator>= ( const QKeySequence & other ) const

Returns true if this key sequence is larger or equal to the other key sequence; otherwise returns false.

See also operator==(), operator!=(), operator<(), operator>(), and operator<=().

int QKeySequence::operator[] ( uint index ) const

Returns a reference to the element at position index in the key sequence. This can only be used to read an element.

Related Non-Members

QDataStream & operator<< ( QDataStream & stream, const QKeySequence & sequence )

Writes the key sequence to the stream.

See also Format of the QDataStream operators.

QDataStream & operator>> ( QDataStream & stream, QKeySequence & sequence )

Reads a key sequence from the stream into the key sequence.

See also Format of the QDataStream operators.

Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt 4.6.3