Member Function Documentation

[explicit] KModifierKeyInfo::KModifierKeyInfo(QObject *parent = nullptr)

Default constructor

[signal] void KModifierKeyInfo::buttonPressed(Qt::MouseButton button, bool pressed)

This signal is emitted whenever the pressed state of a mouse button changes (mouse button press or release).

button The mouse button that changed state

pressed true if the mouse button is now pressed, false if is released.

bool KModifierKeyInfo::isButtonPressed(Qt::MouseButton button) const

Synchronously check if a mouse button is pressed.

button The mouse button to check

Returns true if the mouse button is pressed, false if the mouse button is not pressed or its state is unknown.

bool KModifierKeyInfo::isKeyLatched(Qt::Key key) const

Synchronously check if a key is latched.

key The key to check

Returns true if the key is latched, false if the key is not latched or unknown.

See also isKeyPressed, isKeyLocked, and keyLatched.

bool KModifierKeyInfo::isKeyLocked(Qt::Key key) const

Synchronously check if a key is locked.

key The key to check

Returns true if the key is locked, false if the key is not locked or unknown.

See also isKeyPressed, isKeyLatched, and keyLocked.

bool KModifierKeyInfo::isKeyPressed(Qt::Key key) const

Synchronously check if a key is pressed.

key The key to check

Returns true if the key is pressed, false if the key is not pressed or unknown.

See also isKeyLatched, isKeyLocked, and keyPressed.

[signal] void KModifierKeyInfo::keyAdded(Qt::Key key)

This signal is emitted whenever a new modifier is found due to the keyboard mapping changing.

key The key that was discovered

[signal] void KModifierKeyInfo::keyLatched(Qt::Key key, bool latched)

This signal is emitted whenever the latched state of a key changes.

key The key that changed state

latched true if the key is now latched, false if it isn't

See also setKeyLatched().

[signal] void KModifierKeyInfo::keyLocked(Qt::Key key, bool locked)

This signal is emitted whenever the locked state of a key changes.

key The key that changed state

locked true if the key is now locked, false if it isn't

See also setKeyLocked().

[signal] void KModifierKeyInfo::keyPressed(Qt::Key key, bool pressed)

This signal is emitted whenever the pressed state of a key changes (key press or key release).

key The key that changed state

pressed true if the key is now pressed, false if is released.

[signal] void KModifierKeyInfo::keyRemoved(Qt::Key key)

This signal is emitted whenever a previously known modifier no longer exists due to the keyboard mapping changing.

key The key that vanished

const QList<Qt::Key> KModifierKeyInfo::knownKeys() const

Get a list of known keys.

Returns list of known keys of which states will be reported.

bool KModifierKeyInfo::knowsKey(Qt::Key key) const

Check if a key is known by the underlying window system and can be queried.

key The key to check

Returns true if the key is available, false if it is unknown

bool KModifierKeyInfo::setKeyLatched(Qt::Key key, bool latched)

Set the latched state of a key.

key The key to latch

latched true to latch the key, false to unlatch it.

Returns false if the key is unknown. true doesn't guarantee you the operation worked.

See also keyLatched().

bool KModifierKeyInfo::setKeyLocked(Qt::Key key, bool locked)

Set the locked state of a key.

key The key to lock

latched true to lock the key, false to unlock it.

Return false if the key is unknown. true doesn't guarantee you the operation worked.

See also keyLocked().