• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KModifierKeyInfo Class Reference

Get information about the state of the keyboard's modifier keys. More...

#include <kmodifierkeyinfo.h>

Inheritance diagram for KModifierKeyInfo:
QObject

List of all members.

Signals

void buttonPressed (Qt::MouseButton button, bool pressed)
void keyAdded (Qt::Key key)
void keyLatched (Qt::Key key, bool latched)
void keyLocked (Qt::Key key, bool locked)
void keyPressed (Qt::Key key, bool pressed)
void keyRemoved (Qt::Key key)

Public Member Functions

bool isButtonPressed (Qt::MouseButton button) const
bool isKeyLatched (Qt::Key key) const
bool isKeyLocked (Qt::Key key) const
bool isKeyPressed (Qt::Key key) const
 KModifierKeyInfo (QObject *parent=0)
const QList< Qt::Key > knownKeys () const
bool knowsKey (Qt::Key key) const
bool setKeyLatched (Qt::Key key, bool latched)
bool setKeyLocked (Qt::Key key, bool locked)
virtual ~KModifierKeyInfo ()

Detailed Description

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:

  • locked: eg. caps-locked (aka toggled)
  • latched: the key is temporarily locked but will be unlocked upon the next keypress.

An application can either query the states synchroneously (

See also:
isKeyLatched,
isKeyLocked) or connect to KModifierKeyInfo's signals to be notified about changes (
keyLatched,
keyLocked).

Definition at line 46 of file kmodifierkeyinfo.h.


Constructor & Destructor Documentation

KModifierKeyInfo::KModifierKeyInfo ( QObject *  parent = 0  ) 

Default constructor.

Definition at line 24 of file kmodifierkeyinfo.cpp.

KModifierKeyInfo::~KModifierKeyInfo (  )  [virtual]

Destructor.

Definition at line 36 of file kmodifierkeyinfo.cpp.


Member Function Documentation

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

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

Parameters:
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

Synchroneously check if a mouse button is pressed.

Parameters:
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.

Definition at line 76 of file kmodifierkeyinfo.cpp.

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

Synchroneously check if a key is latched.

Parameters:
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,
keyLatched

Definition at line 56 of file kmodifierkeyinfo.cpp.

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

Synchroneously check if a key is locked.

Parameters:
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,
keyLocked

Definition at line 66 of file kmodifierkeyinfo.cpp.

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

Synchroneously check if a key is pressed.

Parameters:
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,
keyPressed

Definition at line 51 of file kmodifierkeyinfo.cpp.

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

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

Parameters:
key The key that was discovered
void KModifierKeyInfo::keyLatched ( Qt::Key  key,
bool  latched 
) [signal]

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

Parameters:
key The key that changed state
latched true if the key is now latched, false if it isn't
void KModifierKeyInfo::keyLocked ( Qt::Key  key,
bool  locked 
) [signal]

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

Parameters:
key The key that changed state
locked true if the key is now locked, false if it isn't
void KModifierKeyInfo::keyPressed ( Qt::Key  key,
bool  pressed 
) [signal]

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

Parameters:
key The key that changed state
pressed true if the key is now pressed, false if is released.
void KModifierKeyInfo::keyRemoved ( Qt::Key  key  )  [signal]

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

Parameters:
key The key that vanished
const QList< Qt::Key > KModifierKeyInfo::knownKeys (  )  const

Get a list of known keys.

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

Definition at line 46 of file kmodifierkeyinfo.cpp.

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

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

Parameters:
key The key to check
Returns:
true if the key is available, false if it is unknown

Definition at line 41 of file kmodifierkeyinfo.cpp.

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

Set the latched state of a key.

Parameters:
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.

Definition at line 61 of file kmodifierkeyinfo.cpp.

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

Set the locked state of a key.

Parameters:
key The key to lock
latched true to lock the key, false to unlock it.
Returns:
false if the key is unknown. true doesn't guarantee you the operation worked.

Definition at line 71 of file kmodifierkeyinfo.cpp.


The documentation for this class was generated from the following files:
  • kmodifierkeyinfo.h
  • kmodifierkeyinfo.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal