KGuiAddons 5.109.0
|
Get information about the state of the keyboard's modifier keys. More...
#include <KModifierKeyInfo>
Signals | |
void | buttonPressed (Qt::MouseButton button, bool pressed) |
This signal is emitted whenever the pressed state of a mouse button changes (mouse button press or release). | |
void | keyAdded (Qt::Key key) |
This signal is emitted whenever a new modifier is found due to the keyboard mapping changing. | |
void | keyLatched (Qt::Key key, bool latched) |
This signal is emitted whenever the latched state of a key changes. | |
void | keyLocked (Qt::Key key, bool locked) |
This signal is emitted whenever the locked state of a key changes. | |
void | keyPressed (Qt::Key key, bool pressed) |
This signal is emitted whenever the pressed state of a key changes (key press or key release). | |
void | keyRemoved (Qt::Key key) |
This signal is emitted whenever a previously known modifier no longer exists due to the keyboard mapping changing. | |
Public Member Functions | |
KModifierKeyInfo (QObject *parent=nullptr) | |
Default constructor. | |
~KModifierKeyInfo () override | |
Destructor. | |
bool | isButtonPressed (Qt::MouseButton button) const |
Synchronously check if a mouse button is pressed. | |
bool | isKeyLatched (Qt::Key key) const |
Synchronously check if a key is latched. | |
bool | isKeyLocked (Qt::Key key) const |
Synchronously check if a key is locked. | |
bool | isKeyPressed (Qt::Key key) const |
Synchronously check if a key is pressed. | |
const QList< Qt::Key > | knownKeys () const |
Get a list of known keys. | |
bool | knowsKey (Qt::Key key) const |
Check if a key is known by the underlying window system and can be queried. | |
bool | setKeyLatched (Qt::Key key, bool latched) |
Set the latched state of a key. | |
bool | setKeyLocked (Qt::Key key, bool locked) |
Set the locked state of a key. | |
Get information about the state of the keyboard's modifier keys.
This class provides cross-platform information about the state of the keyboard's modifier keys and the mouse buttons and allows to change the state as well.
It recognizes two states a key can be in:
An application can either query the states synchronously (isKeyLatched(), isKeyLocked()) or connect to KModifierKeyInfo's signals to be notified about changes (keyLatched(), keyLocked()).
|
explicit |
Default constructor.
|
override |
Destructor.
|
signal |
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 |
bool KModifierKeyInfo::isKeyLatched | ( | Qt::Key | key | ) | const |
Synchronously check if a key is latched.
key | The key to check |
bool KModifierKeyInfo::isKeyLocked | ( | Qt::Key | key | ) | const |
Synchronously check if a key is locked.
key | The key to check |
bool KModifierKeyInfo::isKeyPressed | ( | Qt::Key | key | ) | const |
Synchronously check if a key is pressed.
key | The key to check |
|
signal |
This signal is emitted whenever a new modifier is found due to the keyboard mapping changing.
key | The key that was discovered |
|
signal |
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 |
|
signal |
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 |
|
signal |
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 |
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.
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 |
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. |
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. |