QKeyEvent

Synopsis

Functions

• def __eq__ (, key)
• def __eq__ (key)
• def __ne__ (arg__1)
• def count ()
• def hasExtendedInfo ()
• def isAutoRepeat ()
• def key ()
• def matches (key)
• def nativeModifiers ()
• def nativeScanCode ()
• def nativeVirtualKey ()
• def text ()

Static functions

• def createExtendedKeyEvent (type, key, modifiers, nativeScanCode, nativeVirtualKey, nativeModifiers[, text=”“[, autorep=false[, count=1]]])

Detailed Description

The PySide.QtGui.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 PySide.QtCore.QEvent.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 PySide.QtCore.QEvent.accept() or an event filter consumes it. Key events for multimedia keys are ignored by default. You should call PySide.QtCore.QEvent.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

PySide.QtGui.QFocusEvent QWidget.grabKeyboard()

class PySide.QtGui.QKeyEvent(type, key, modifiers[, text=""[, autorep=false[, count=1]]])

Parameters:

• key – PySide.QtCore.int
• autorep – PySide.QtCore.bool
• count – PySide.QtCore.ushort
• modifiers – PySide.QtCore.Qt.KeyboardModifiers
• type – PySide.QtCore.QEvent.Type
• text – unicode

PySide.QtGui.QKeyEvent.autor

PySide.QtGui.QKeyEvent.count()

Return type:PySide.QtCore.int

Returns the number of keys involved in this event. If PySide.QtGui.QKeyEvent.text() is not empty, this is simply the length of the string.

See also

Qt.WA_KeyCompression

static PySide.QtGui.QKeyEvent.createExtendedKeyEvent(type, key, modifiers, nativeScanCode, nativeVirtualKey, nativeModifiers[, text=""[, autorep=false[, count=1]]])

Parameters:

• type – PySide.QtCore.QEvent.Type
• key – PySide.QtCore.int
• modifiers – PySide.QtCore.Qt.KeyboardModifiers
• nativeScanCode – PySide.QtCore.quint32
• nativeVirtualKey – PySide.QtCore.quint32
• nativeModifiers – PySide.QtCore.quint32
• text – unicode
• autorep – PySide.QtCore.bool
• count – PySide.QtCore.ushort

Return type:

PySide.QtGui.QKeyEvent

PySide.QtGui.QKeyEvent.hasExtendedInfo()

Return type:PySide.QtCore.bool

PySide.QtGui.QKeyEvent.isAutoRepeat()

Return type:PySide.QtCore.bool

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.

PySide.QtGui.QKeyEvent.key()

Return type:PySide.QtCore.int

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 PySide.QtGui.QKeyEvent.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

PySide.QtGui.QKeyEvent.matches(key)

Parameters:key – PySide.QtGui.QKeySequence.StandardKey Return type:PySide.QtCore.bool

PySide.QtGui.QKeyEvent.nativeModifiers()

Return type:PySide.QtCore.quint32

Returns the native modifiers of a key event. 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.

PySide.QtGui.QKeyEvent.nativeScanCode()

Return type:PySide.QtCore.quint32

Returns the native scan code of the key event. 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).

PySide.QtGui.QKeyEvent.nativeVirtualKey()

Return type:PySide.QtCore.quint32

Returns the native virtual key, or key sym of the key event. 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.

PySide.QtGui.QKeyEvent.__ne__(arg__1)

Parameters:arg__1 – PySide.QtGui.QKeySequence.StandardKey

PySide.QtGui.QKeyEvent.__eq__(key)

Parameters:key – PySide.QtGui.QKeySequence.StandardKey Return type:PySide.QtCore.bool

PySide.QtGui.QKeyEvent.__eq__(key)

Parameters:key – PySide.QtGui.QKeySequence.StandardKey Return type:PySide.QtCore.bool

PySide.QtGui.QKeyEvent.text()

Return type:unicode

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 PySide.QtGui.QKeyEvent.key() will contain a valid value.

See also

Qt.WA_KeyCompression