PySide6.Qt3DInput.Qt3DInput.QKeyboardHandler

class QKeyboardHandler

Provides keyboard event notification. More…

Synopsis

Properties

• focusᅟ

• sourceDeviceᅟ

Methods

• def __init__()

• def focus()

• def sourceDevice()

Slots

• def setFocus()

• def setSourceDevice()

Signals

• def asteriskPressed()

• def backPressed()

• def backtabPressed()

• def callPressed()

• def cancelPressed()

• def context1Pressed()

• def context2Pressed()

• def context3Pressed()

• def context4Pressed()

• def deletePressed()

• def digit0Pressed()

• def digit1Pressed()

• def digit2Pressed()

• def digit3Pressed()

• def digit4Pressed()

• def digit5Pressed()

• def digit6Pressed()

• def digit7Pressed()

• def digit8Pressed()

• def digit9Pressed()

• def downPressed()

• def enterPressed()

• def escapePressed()

• def flipPressed()

• def focusChanged()

• def hangupPressed()

• def leftPressed()

• def menuPressed()

• def noPressed()

• def numberSignPressed()

• def pressed()

• def released()

• def returnPressed()

• def rightPressed()

• def selectPressed()

• def sourceDeviceChanged()

• def spacePressed()

• def tabPressed()

• def upPressed()

• def volumeDownPressed()

• def volumeUpPressed()

• def yesPressed()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property focusᅟ: bool

Holds true if the QKeyboardHandlers has focus.

Access functions:

• focus()

• setFocus()

• Signal focusChanged()

property sourceDeviceᅟ: QKeyboardDevice

Holds the keyboard device of the QKeyboardHandler . Without a valid device, the QKeyboardHandler won’t receive any event.

Access functions:

• sourceDevice()

• setSourceDevice()

• Signal sourceDeviceChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new QKeyboardHandler instance with parent parent.

asteriskPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the * key is pressed with the event details being contained within event.

backPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the back key is pressed with the event details being contained within event.

backtabPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the backtab key is pressed with the event details being contained within event.

callPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the call key is pressed with the event details being contained within event.

cancelPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the cancel key is pressed with the event details being contained within event.

context1Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the context 1 key is pressed with the event details being contained within event.

context2Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the context 2 key is pressed with the event details being contained within event.

context3Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the context 2 key is pressed with the event details being contained within event.

context4Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the context 4 key is pressed with the event details being contained within event.

deletePressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the delete key is pressed with the event details being contained within event.

digit0Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 0 key is pressed with the event details being contained within event.

digit1Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 1 key is pressed with the event details being contained within event.

digit2Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 2 key is pressed with the event details being contained within event.

digit3Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 3 key is pressed with the event details being contained within event.

digit4Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 4 key is pressed with the event details being contained within event.

digit5Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 5 key is pressed with the event details being contained within event.

digit6Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 6 key is pressed with the event details being contained within event.

digit7Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 7 key is pressed with the event details being contained within event.

digit8Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 8 key is pressed with the event details being contained within event.

digit9Pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the 9 key is pressed with the event details being contained within event

downPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the down key is pressed with the event details being contained within event.

enterPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the enter key is pressed with the event details being contained within event.

escapePressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the escape key is pressed with the event details being contained within event.

flipPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the flip key is pressed with the event details being contained within event.

focus()

Return type:

bool

See also

setFocus()

Getter of property focusᅟ .

focusChanged(focus)

Parameters:

focus – bool

Notification signal of property focusᅟ .

hangupPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the hangup key is pressed with the event details being contained within event.

leftPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the left key is pressed with the event details being contained within event.

menuPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the menu key is pressed with the event details being contained within event.

noPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the yes key is pressed with the event details being contained within event.

numberSignPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the number sign key is pressed with the event details being contained within event.

pressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when a key is pressed with the event details being contained within event.

released(event)

Parameters:

event – QKeyEvent

This signal is emitted when a key is released with the event details being contained within event.

returnPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the return key is pressed with the event details being contained within event.

rightPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the right key is pressed with the event details being contained within event.

selectPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the select key is pressed with the event details being contained within event.

setFocus(focus)

Parameters:

focus – bool

Sets the focus to focus. If focus is not currently set to true, this component will receive keyboard focus.

See also

focus()

Setter of property focusᅟ .

setSourceDevice(keyboardDevice)

Parameters:

keyboardDevice – QKeyboardDevice

See also

sourceDevice()

Setter of property sourceDeviceᅟ .

sourceDevice()

Return type:

QKeyboardDevice

Returns the current keyboard device.

See also

setSourceDevice()

Getter of property sourceDeviceᅟ .

sourceDeviceChanged(keyboardDevice)

Parameters:

keyboardDevice – QKeyboardDevice

Notification signal of property sourceDeviceᅟ .

spacePressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the space key is pressed with the event details being contained within event.

tabPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the tab key is pressed with the event details being contained within event.

upPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the up key is pressed with the event details being contained within event.

volumeDownPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the volume down key is pressed with the event details being contained within event.

volumeUpPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the volume up key is pressed with the event details being contained within event.

yesPressed(event)

Parameters:

event – QKeyEvent

This signal is emitted when the yes key is pressed with the event details being contained within event.