QKeyEvent Class Reference

The QKeyEvent class describes a key event. More...

#include <qevent.h>

Inheritance diagram for QKeyEvent:

Public Functions
int	count () const
	Returns the number of keys involved in this event. More...
bool	hasExtendedInfo () const
bool	isAutoRepeat () const
	Returns true if this event comes from an auto-repeating key; returns false if it comes from an initial key press. More...
int	key () const
	Returns the code of the key that was pressed or released. More...
bool	matches (QKeySequence::StandardKey key) const
	Returns true if the key event matches the given standard key; otherwise returns false. More...
Qt::KeyboardModifiers	modifiers () const
	Returns the keyboard modifier flags that existed immediately after the event occurred. More...
quint32	nativeModifiers () const
	Returns the native modifiers of a key event. More...
quint32	nativeScanCode () const
	Returns the native scan code of the key event. More...
quint32	nativeVirtualKey () const
	Returns the native virtual key, or key sym of the key event. More...
	QKeyEvent (Type type, int key, Qt::KeyboardModifiers modifiers, const QString &text=QString(), bool autorep=false, ushort count=1)
	Constructs a key event object. More...
QString	text () const
	Returns the Unicode text that this key generated. More...
	~QKeyEvent ()
Public Functions inherited from QInputEvent
Qt::KeyboardModifiers	modifiers () const
	Returns the keyboard modifier flags that existed immediately before the event occurred. More...
	QInputEvent (Type type, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
void	setModifiers (Qt::KeyboardModifiers amodifiers)
	Sets the keyboard modifiers flags for this event. More...
	~QInputEvent ()
Public Functions inherited from QEvent
void	accept ()
	Sets the accept flag of the event object, the equivalent of calling setAccepted(true). More...
void	ignore ()
	Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). More...
bool	isAccepted () const
	QEvent (Type type)
	Contructs an event object of type type. More...
void	setAccepted (bool accepted)
bool	spontaneous () const
	Returns true if the event originated outside the application (a system event); otherwise returns false. More...
Type	type () const
	Returns the event type. More...
virtual	~QEvent ()
	Destroys the event. More...

Static Public Functions
static QKeyEvent *	createExtendedKeyEvent (Type type, int key, Qt::KeyboardModifiers modifiers, quint32 nativeScanCode, quint32 nativeVirtualKey, quint32 nativeModifiers, const QString &text=QString(), bool autorep=false, ushort count=1)
Static Public Functions inherited from QEvent
static int	registerEventType (int hint=-1)
	Registers and returns a custom event type. More...

Protected Variables
uint	autor:1
ushort	c
int	k
QString	txt
Protected Variables inherited from QInputEvent
Qt::KeyboardModifiers	modState
Protected Variables inherited from QEvent
QEventPrivate *	d
ushort	t

Additional Inherited Members
Public Types inherited from QEvent
enum	Type {   None = 0, Timer = 1, MouseButtonPress = 2, MouseButtonRelease = 3,   MouseButtonDblClick = 4, MouseMove = 5, KeyPress = 6, KeyRelease = 7,   FocusIn = 8, FocusOut = 9, Enter = 10, Leave = 11,   Paint = 12, Move = 13, Resize = 14, Create = 15,   Destroy = 16, Show = 17, Hide = 18, Close = 19,   Quit = 20, ParentChange = 21, ParentAboutToChange = 131, ThreadChange = 22,   WindowActivate = 24, WindowDeactivate = 25, ShowToParent = 26, HideToParent = 27,   Wheel = 31, WindowTitleChange = 33, WindowIconChange = 34, ApplicationWindowIconChange = 35,   ApplicationFontChange = 36, ApplicationLayoutDirectionChange = 37, ApplicationPaletteChange = 38, PaletteChange = 39,   Clipboard = 40, Speech = 42, MetaCall = 43, SockAct = 50,   WinEventAct = 132, DeferredDelete = 52, DragEnter = 60, DragMove = 61,   DragLeave = 62, Drop = 63, DragResponse = 64, ChildAdded = 68,   ChildPolished = 69, ChildRemoved = 71, ShowWindowRequest = 73, PolishRequest = 74,   Polish = 75, LayoutRequest = 76, UpdateRequest = 77, UpdateLater = 78,   EmbeddingControl = 79, ActivateControl = 80, DeactivateControl = 81, ContextMenu = 82,   InputMethod = 83, AccessibilityPrepare = 86, TabletMove = 87, LocaleChange = 88,   LanguageChange = 89, LayoutDirectionChange = 90, Style = 91, TabletPress = 92,   TabletRelease = 93, OkRequest = 94, HelpRequest = 95, IconDrag = 96,   FontChange = 97, EnabledChange = 98, ActivationChange = 99, StyleChange = 100,   IconTextChange = 101, ModifiedChange = 102, MouseTrackingChange = 109, WindowBlocked = 103,   WindowUnblocked = 104, WindowStateChange = 105, ToolTip = 110, WhatsThis = 111,   StatusTip = 112, ActionChanged = 113, ActionAdded = 114, ActionRemoved = 115,   FileOpen = 116, Shortcut = 117, ShortcutOverride = 51, WhatsThisClicked = 118,   ToolBarChange = 120, ApplicationActivate = 121, ApplicationActivated = ApplicationActivate, ApplicationDeactivate = 122,   ApplicationDeactivated = ApplicationDeactivate, QueryWhatsThis = 123, EnterWhatsThisMode = 124, LeaveWhatsThisMode = 125,   ZOrderChange = 126, HoverEnter = 127, HoverLeave = 128, HoverMove = 129,   AccessibilityHelp = 119, AccessibilityDescription = 130, AcceptDropsChange = 152, MenubarUpdated = 153,   ZeroTimerEvent = 154, GraphicsSceneMouseMove = 155, GraphicsSceneMousePress = 156, GraphicsSceneMouseRelease = 157,   GraphicsSceneMouseDoubleClick = 158, GraphicsSceneContextMenu = 159, GraphicsSceneHoverEnter = 160, GraphicsSceneHoverMove = 161,   GraphicsSceneHoverLeave = 162, GraphicsSceneHelp = 163, GraphicsSceneDragEnter = 164, GraphicsSceneDragMove = 165,   GraphicsSceneDragLeave = 166, GraphicsSceneDrop = 167, GraphicsSceneWheel = 168, KeyboardLayoutChange = 169,   DynamicPropertyChange = 170, TabletEnterProximity = 171, TabletLeaveProximity = 172, NonClientAreaMouseMove = 173,   NonClientAreaMouseButtonPress = 174, NonClientAreaMouseButtonRelease = 175, NonClientAreaMouseButtonDblClick = 176, MacSizeChange = 177,   ContentsRectChange = 178, MacGLWindowChange = 179, FutureCallOut = 180, GraphicsSceneResize = 181,   GraphicsSceneMove = 182, CursorChange = 183, ToolTipChange = 184, NetworkReplyUpdated = 185,   GrabMouse = 186, UngrabMouse = 187, GrabKeyboard = 188, UngrabKeyboard = 189,   MacGLClearDrawable = 191, StateMachineSignal = 192, StateMachineWrapped = 193, TouchBegin = 194,   TouchUpdate = 195, TouchEnd = 196, NativeGesture = 197, RequestSoftwareInputPanel = 199,   CloseSoftwareInputPanel = 200, UpdateSoftKeys = 201, WinIdChange = 203, Gesture = 198,   GestureOverride = 202, PlatformPanel = 212, User = 1000, MaxUser = 65535 }
	This enum type defines the valid event types in Qt. More...

Detailed Description

The QKeyEvent class describes a key event.

Key events are sent to the widget with keyboard input focus when keys are pressed or released.

A key event contains a special accept flag that indicates whether the receiver will handle the key event. You should call ignore() if the key press or release event is not handled by your widget. A key event is propagated up the parent widget chain until a widget accepts it with accept() or an event filter consumes it. Key events for multimedia keys are ignored by default. You should call accept() if your widget handles those events.

The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget.

The event handlers QWidget::keyPressEvent(), QWidget::keyReleaseEvent(), QGraphicsItem::keyPressEvent() and QGraphicsItem::keyReleaseEvent() receive key events.

See also

QFocusEvent, QWidget::grabKeyboard()

Definition at line 224 of file qevent.h.

Constructors and Destructors

QKeyEvent()

QKeyEvent::QKeyEvent	(	Type	type,
		int	key,
		Qt::KeyboardModifiers	modifiers,
		const QString &	text = QString(),
		bool	autorep = false,
		ushort	count = 1
	)

Constructs a key event object.

The type parameter must be QEvent::KeyPress, QEvent::KeyRelease, or QEvent::ShortcutOverride.

Int key is the code for the Qt::Key that the event loop should listen for. If key is 0, the event is not a result of a known key; for example, it may be the result of a compose sequence or keyboard macro. The modifiers holds the keyboard modifiers, and the given text is the Unicode text that the key generated. If autorep is true, isAutoRepeat() will be true. count is the number of keys involved in the event.

Definition at line 826 of file qevent.cpp.

    : QInputEvent(type, modifiers), txt(text), k(key), c(count), autor(autorep)
{
}

~QKeyEvent()

QKeyEvent::~QKeyEvent

(

)

Warning

This function is not part of the public interface.

Definition at line 835 of file qevent.cpp.

{
}

Functions

count()

int QKeyEvent::count ( ) const

inline

Returns the number of keys involved in this event.

If text() is not empty, this is simply the length of the string.

See also

Qt::WA_KeyCompression

Definition at line 238 of file qevent.h.

Referenced by operator<<().

{ return int(c); }

createExtendedKeyEvent()

QKeyEvent * QKeyEvent::createExtendedKeyEvent ( Type  type, int  key, Qt::KeyboardModifiers  modifiers, quint32  nativeScanCode, quint32  nativeVirtualKey, quint32  nativeModifiers, const QString &  text = QString(), bool  autorep = false, ushort  count = 1  )

static

Warning

This function is not part of the public interface.

Definition at line 842 of file qevent.cpp.

{
    return new QKeyEventEx(type, key, modifiers, text, autorep, count,
                           nativeScanCode, nativeVirtualKey, nativeModifiers);
}

hasExtendedInfo()

bool QKeyEvent::hasExtendedInfo ( ) const

inline

Warning

This function is not part of the public interface.

Definition at line 246 of file qevent.h.

{ return reinterpret_cast<const QKeyEvent*>(d) == this; }

isAutoRepeat()

bool QKeyEvent::isAutoRepeat ( ) const

inline

Returns true if this event comes from an auto-repeating key; returns false if it comes from an initial key press.

Note that if the event is a multiple-key compressed event that is partly due to auto-repeat, this function could return either true or false indeterminately.

Definition at line 237 of file qevent.h.

Referenced by QShortcutMap::dispatchEvent(), QGroupBox::event(), QAbstractButton::keyPressEvent(), QAbstractSpinBox::keyPressEvent(), QAbstractSlider::keyPressEvent(), QTabWidget::keyPressEvent(), QPlainTextEdit::keyPressEvent(), QTextEdit::keyPressEvent(), QAbstractButton::keyReleaseEvent(), QAbstractSpinBox::keyReleaseEvent(), QPlainTextEdit::keyReleaseEvent(), QTextEdit::keyReleaseEvent(), operator<<(), QLineControl::processEvent(), and QLineControl::processKeyEvent().

{ return autor; }

key()

int QKeyEvent::key ( ) const

inline

Returns the code of the key that was pressed or released.

See Qt::Key for the list of keyboard codes. These codes are independent of the underlying window system. Note that this function does not distinguish between capital and non-capital letters, use the text() function (returning the Unicode text the key generated) for this purpose.

A value of either 0 or Qt::Key_unknown means that the event is not the result of a known key; for example, it may be the result of a compose sequence, a keyboard macro, or due to key event compression.

See also

Qt::WA_KeyCompression

Definition at line 231 of file qevent.h.

Referenced by QTextControlPrivate::cursorMoveKeyEvent(), QGraphicsProxyWidget::event(), QGroupBox::event(), QSidebar::event(), QMenuBar::event(), QCalendarPopup::event(), QMenu::event(), QGraphicsView::event(), QGraphicsScene::event(), QWidget::event(), QAlphaWidget::eventFilter(), QCalendarTextNavigator::eventFilter(), QFontDialog::eventFilter(), QMenuBar::eventFilter(), QCompleter::eventFilter(), QMdiArea::eventFilter(), QScriptDebuggerLocalsItemDelegate::eventFilter(), QAxServerBase::eventFilter(), QWhatsThisPrivate::eventFilter(), QBasicKeyEventTransition::eventTest(), QShortcutMap::find(), QCalendarDateValidator::handleKeyEvent(), QFileDialogPrivate::itemViewKeyboardEvent(), QDeclarativeKeyNavigationAttached::keyPressed(), QDeclarativeKeysAttached::keyPressed(), QmlJSDebugger::LiveSelectionTool::keyPressEvent(), QScriptBreakpointsWidget::keyPressEvent(), QScriptDebuggerCodeFinderWidget::keyPressEvent(), QScriptDebuggerConsoleWidget::keyPressEvent(), QPushButton::keyPressEvent(), QWidgetResizeHandler::keyPressEvent(), QInputDialogSpinBox::keyPressEvent(), QScriptNewBreakpointWidget::keyPressEvent(), QTextBrowser::keyPressEvent(), QDialog::keyPressEvent(), QAbstractScrollArea::keyPressEvent(), QMdiSubWindow::keyPressEvent(), QTextControlPrivate::keyPressEvent(), QMenuBar::keyPressEvent(), QAbstractButton::keyPressEvent(), QAbstractSpinBox::keyPressEvent(), QInputDialogDoubleSpinBox::keyPressEvent(), QAbstractSlider::keyPressEvent(), QWellArray::keyPressEvent(), QTabWidget::keyPressEvent(), QMenu::keyPressEvent(), QDateTimeEdit::keyPressEvent(), QTabBar::keyPressEvent(), QTreeView::keyPressEvent(), QLineEdit::keyPressEvent(), QDeclarativeGridView::keyPressEvent(), QPlainTextEdit::keyPressEvent(), QComboBox::keyPressEvent(), QDeclarativeListView::keyPressEvent(), QDeclarativeTextInput::keyPressEvent(), QTextEdit::keyPressEvent(), QMessageBox::keyPressEvent(), QFileDialogLineEdit::keyPressEvent(), QAbstractItemView::keyPressEvent(), QWidget::keyPressEvent(), QCalendarView::keyPressEvent(), QDeclarativeKeyNavigationAttached::keyReleased(), QmlJSDebugger::ZoomTool::keyReleaseEvent(), QAbstractButton::keyReleaseEvent(), QmlJSDebugger::AbstractViewInspector::keyReleaseEvent(), QPlainTextEdit::keyReleaseEvent(), QTextEdit::keyReleaseEvent(), matches(), modifiers(), QShortcutMap::nextState(), QApplication::notify(), operator<<(), QKeyMapper::possibleKeys(), QTextControl::processEvent(), QLineControl::processEvent(), QLineControl::processKeyEvent(), QDeclarativeItem::sceneEvent(), QGraphicsItem::sceneEvent(), and QShortcutMap::tryShortcutEvent().

{ return k; }

matches()

bool QKeyEvent::matches

(

QKeySequence::StandardKey

key

)

const

Returns true if the key event matches the given standard key; otherwise returns false.

Since

4.2

Definition at line 1023 of file qevent.cpp.

Referenced by operator==().

{
    uint searchkey = (modifiers() | key()) & ~(Qt::KeypadModifier); //The keypad modifier should not make a difference
    uint platform = QApplicationPrivate::currentPlatform();

#ifdef Q_WS_MAC
    if (qApp->testAttribute(Qt::AA_MacDontSwapCtrlAndMeta)) {
        uint oldSearchKey = searchkey;
        searchkey &= ~(Qt::ControlModifier | Qt::MetaModifier);
        if (oldSearchKey & Qt::ControlModifier)
            searchkey |= Qt::MetaModifier;
        if (oldSearchKey & Qt::MetaModifier)
            searchkey |= Qt::ControlModifier;
    }
#endif

    uint N = QKeySequencePrivate::numberOfKeyBindings;
    int first = 0;
    int last = N - 1;

    while (first <= last) {
        int mid = (first + last) / 2;
        QKeyBinding midVal = QKeySequencePrivate::keyBindings[mid];

        if (searchkey > midVal.shortcut){
            first = mid + 1;  // Search in top half
        }
        else if (searchkey < midVal.shortcut){
            last = mid - 1; // Search in bottom half
        }
        else {
            //found correct shortcut value, now we must check for platform match
            if ((midVal.platform & platform) && (midVal.standardKey == matchKey)) {
                return true;
            } else { //We may have several equal values for different platforms, so we must search in both directions

                //search forward
                for ( unsigned int i = mid + 1 ; i < N - 1 ; ++i) {
                    QKeyBinding current = QKeySequencePrivate::keyBindings[i];
                    if (current.shortcut != searchkey)
                        break;
                    else if (current.platform & platform && current.standardKey == matchKey)
                        return true;
                }

                //search back
                for ( int i = mid - 1 ; i >= 0 ; --i) {
                    QKeyBinding current = QKeySequencePrivate::keyBindings[i];
                    if (current.shortcut != searchkey)
                        break;
                    else if (current.platform & platform && current.standardKey == matchKey)
                        return true;
                }
                return false; //we could not find it among the matching keySequences
            }
        }
    }
    return false; //we could not find matching keySequences at all
}

modifiers()

Qt::KeyboardModifiers QKeyEvent::modifiers

(

)

const

Returns the keyboard modifier flags that existed immediately after the event occurred.

Warning

This function cannot always be trusted. The user can confuse it by pressing both Shift keys simultaneously and releasing one of them, for example.

See also

QApplication::keyboardModifiers()

Definition at line 999 of file qevent.cpp.

Referenced by QGraphicsProxyWidget::event(), QGraphicsScene::event(), QWidget::event(), QMenuBar::eventFilter(), QCompleter::eventFilter(), QMdiArea::eventFilter(), QAxServerBase::eventFilter(), QWhatsThisPrivate::eventFilter(), QBasicKeyEventTransition::eventTest(), QKeyMapperPrivate::isADeadKey(), QWidgetResizeHandler::keyPressEvent(), QDialog::keyPressEvent(), QTextBrowser::keyPressEvent(), QMdiSubWindow::keyPressEvent(), QTextControlPrivate::keyPressEvent(), QMenuBar::keyPressEvent(), QAbstractSpinBox::keyPressEvent(), QMenu::keyPressEvent(), QTabWidget::keyPressEvent(), QLineEdit::keyPressEvent(), QPlainTextEdit::keyPressEvent(), QComboBox::keyPressEvent(), QDeclarativeTextInput::keyPressEvent(), QTextEdit::keyPressEvent(), QMessageBox::keyPressEvent(), QAbstractItemView::keyPressEvent(), matches(), QShortcutMap::nextState(), QApplication::notify(), operator<<(), QKeyMapper::possibleKeys(), QKeyMapperPrivate::possibleKeys(), QTextControl::processEvent(), QLineControl::processEvent(), QLineControl::processKeyEvent(), QDeclarativeItem::sceneEvent(), and QGraphicsItem::sceneEvent().

{
    if (key() == Qt::Key_Shift)
        return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::ShiftModifier);
    if (key() == Qt::Key_Control)
        return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::ControlModifier);
    if (key() == Qt::Key_Alt)
        return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::AltModifier);
    if (key() == Qt::Key_Meta)
        return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::MetaModifier);
    return QInputEvent::modifiers();
}

nativeModifiers()

quint32 QKeyEvent::nativeModifiers

(

)

const

Returns the native modifiers of a key event.

Since

4.2

If the key event does not contain this data 0 is returned.

Note: The native modifiers may be 0, even if the key event contains extended information.

Definition at line 906 of file qevent.cpp.

Referenced by QKeyMapperPrivate::isADeadKey().

{
    return (reinterpret_cast<const QKeyEvent*>(d) != this
            ? 0 : reinterpret_cast<const QKeyEventEx*>(this)->nModifiers);
}

nativeScanCode()

quint32 QKeyEvent::nativeScanCode

(

)

const

Returns the native scan code of the key event.

Since

4.2

If the key event does not contain this data 0 is returned.

Note: The native scan code may be 0, even if the key event contains extended information.

Note: On Mac OS/X, this function is not useful, because there is no way to get the scan code from Carbon or Cocoa. The function always returns 1 (or 0 in the case explained above).

Definition at line 872 of file qevent.cpp.

Referenced by QKeyMapper::possibleKeys().

{
    return (reinterpret_cast<const QKeyEvent*>(d) != this
            ? 0 : reinterpret_cast<const QKeyEventEx*>(this)->nScanCode);
}

nativeVirtualKey()

quint32 QKeyEvent::nativeVirtualKey

(

)

const

Returns the native virtual key, or key sym of the key event.

Since

4.2

If the key event does not contain this data 0 is returned.

Note: The native virtual key may be 0, even if the key event contains extended information.

Definition at line 889 of file qevent.cpp.

Referenced by QKeyMapperPrivate::isADeadKey(), and QKeyMapperPrivate::possibleKeys().

{
    return (reinterpret_cast<const QKeyEvent*>(d) != this
            ? 0 : reinterpret_cast<const QKeyEventEx*>(this)->nVirtualKey);
}

text()

QString QKeyEvent::text ( ) const

inline

Returns the Unicode text that this key generated.

The text returned can be an empty string in cases where modifier keys, such as Shift, Control, Alt, and Meta, are being pressed or released. In such cases key() will contain a valid value.

See also

Qt::WA_KeyCompression

Definition at line 236 of file qevent.h.

Referenced by QCalendarTextNavigator::eventFilter(), QAxServerBase::eventFilter(), QShortcutMap::find(), QDateTimeEditPrivate::isSeparatorKey(), QTextControlPrivate::keyPressEvent(), QMenuBar::keyPressEvent(), QAbstractSpinBox::keyPressEvent(), QMenu::keyPressEvent(), QDateTimeEdit::keyPressEvent(), QLineEdit::keyPressEvent(), QPlainTextEdit::keyPressEvent(), QComboBox::keyPressEvent(), QTextEdit::keyPressEvent(), QAbstractItemView::keyPressEvent(), QShortcutMap::nextState(), operator<<(), QKeyMapper::possibleKeys(), and QLineControl::processKeyEvent().

{ return txt; }

Properties

autor

uint QKeyEvent::autor

protected

Definition at line 271 of file qevent.h.

c

ushort QKeyEvent::c

protected

Definition at line 270 of file qevent.h.

k

int QKeyEvent::k

protected

Definition at line 269 of file qevent.h.

txt

QString QKeyEvent::txt

protected

Definition at line 268 of file qevent.h.

---

The documentation for this class was generated from the following files:

• /src/gui/kernel/qevent.h
• /src/gui/kernel/qevent.cpp