QKeySequence Class Reference

Detailed Description

A key sequence consists of up to four keyboard codes, each optionally combined with modifiers, e.g. SHIFT, CTRL, ALT, META, or UNICODE_ACCEL. For example, CTRL + Key_P might be a sequence used as a shortcut for printing a document. The key codes are listed in qnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, UNICODE_ACCEL + 'A' gives the same key sequence as Key_A.

Key sequences can be constructed either from an integer key code, or from a human readable translatable string such as "Ctrl+X,Alt+Space". A key sequence can be cast to a QString to obtain a human readable translated version of the sequence. Translations are done in the "QAccel" context.

See also QAccel and Miscellaneous Classes.

Member Function Documentation

QKeySequence::QKeySequence ()

QKeySequence::QKeySequence ( const QString & key )

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

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

        QPopupMenu *file = new QPopupMenu( this );
        file->insertItem( 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 key )

The key codes are listed in qnamespace.h and can be combined with modifiers, e.g. with SHIFT, CTRL, ALT, META or UNICODE_ACCEL.

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

The key codes are listed in qnamespace.h and can be combined with modifiers, e.g. with SHIFT, CTRL, ALT, META or UNICODE_ACCEL.

QKeySequence::QKeySequence ( const QKeySequence & keysequence )

QKeySequence::~QKeySequence ()

uint QKeySequence::count () const

bool QKeySequence::isEmpty () const

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

QKeySequence::operator QString () const

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

QKeySequence::operator int () const

For backward compatibility: returns the first keycode as integer. If the key sequence is empty, 0 is returned.

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

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

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

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

Related Functions

QDataStream & operator<< ( QDataStream & s, const QKeySequence & keysequence )

Writes the key sequence keysequence to the stream s.

See also Format of the QDataStream operators.

QDataStream & operator>> ( QDataStream & s, QKeySequence & keysequence )

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

See also Format of the QDataStream operators.

This file is part of the Qt toolkit. Copyright © 1995-2005 Trolltech. All Rights Reserved.