kdecore Library API Documentation

KKeyServer Namespace Reference

A collection of functions for the conversion of key presses and their modifiers from the window system specific format to the generic format and vice-versa. More...


Classes

struct  Sym
 Represents a key symbol. More...
struct  Key
 Represents a key press. More...
struct  Variations
 TODO: please document this class. More...

Enumerations

enum  ExtraModFlag { MODE_SWITCH = 0x2000 }

Functions

KDECORE_EXPORT bool initializeMods ()
KDECORE_EXPORT uint modX (KKey::ModFlag modFlag)
KDECORE_EXPORT bool keyboardHasWinKey ()
KDECORE_EXPORT uint modXShift ()
KDECORE_EXPORT uint modXLock ()
KDECORE_EXPORT uint modXCtrl ()
KDECORE_EXPORT uint modXAlt ()
KDECORE_EXPORT uint modXNumLock ()
KDECORE_EXPORT uint modXWin ()
KDECORE_EXPORT uint modXScrollLock ()
KDECORE_EXPORT uint modXModeSwitch ()
KDECORE_EXPORT uint accelModMaskX ()
KDECORE_EXPORT bool keyQtToSym (int keyQt, uint &sym)
KDECORE_EXPORT bool keyQtToMod (int keyQt, uint &mod)
KDECORE_EXPORT bool symToKeyQt (uint sym, int &keyQt)
KDECORE_EXPORT bool modToModQt (uint mod, int &modQt)
KDECORE_EXPORT bool modToModX (uint mod, uint &modX)
KDECORE_EXPORT bool modXToModQt (uint modX, int &modQt)
KDECORE_EXPORT int qtButtonStateToMod (Qt::ButtonState s)
KDECORE_EXPORT bool modXToMod (uint modX, uint &mod)
KDECORE_EXPORT bool codeXToSym (uchar codeX, uint modX, uint &symX)
KDECORE_EXPORT QString modToStringInternal (uint mod)
KDECORE_EXPORT QString modToStringUser (uint mod)
KDECORE_EXPORT bool stringToSymMod (const QString &, uint &sym, uint &mod)
KDECORE_EXPORT void keyQtToKeyX (uint keyCombQt, unsigned char *pKeyCodeX, uint *pKeySymX, uint *pKeyModX)


Detailed Description

A collection of functions for the conversion of key presses and their modifiers from the window system specific format to the generic format and vice-versa.

Enumeration Type Documentation

enum KKeyServer::ExtraModFlag
 

Supplement enum KKey::ModFlag.

Since:
3.1

Definition at line 40 of file kkeyserver_x11.h.


Function Documentation

KDECORE_EXPORT bool KKeyServer::initializeMods  ) 
 

TODO: please document.

Referenced by KGlobalAccelPrivate::x11MappingNotify().

KDECORE_EXPORT uint KKeyServer::modX KKey::ModFlag  modFlag  ) 
 

Returns the equivalent X modifier mask of the given modifier flag.

Parameters:
modFlag the generic flags to check
Returns:
the window system specific flags

Referenced by KKeyNative::modX().

KDECORE_EXPORT bool KKeyServer::keyboardHasWinKey  ) 
 

Returns true if the current keyboard layout supports the Win key.

Specifically, whether the Super or Meta keys are assigned to an X modifier.

Returns:
true if the keyboard has a Win key
See also:
modXWin()

Referenced by KKeyNative::keyboardHasWinKey().

KDECORE_EXPORT uint KKeyServer::modXShift  ) 
 

Returns the X11 Shift modifier mask/flag.

Returns:
the X11 Shift modifier mask/flag.
See also:
accelModMaskX()

Referenced by KGlobalAccelPrivate::x11KeyPress().

KDECORE_EXPORT uint KKeyServer::modXLock  ) 
 

Returns the X11 Lock modifier mask/flag.

Returns:
the X11 Lock modifier mask/flag.
See also:
accelModMaskX()

Referenced by KKeyNative::modXLock().

KDECORE_EXPORT uint KKeyServer::modXCtrl  ) 
 

Returns the X11 Ctrl modifier mask/flag.

Returns:
the X11 Ctrl modifier mask/flag.
See also:
accelModMaskX()

KDECORE_EXPORT uint KKeyServer::modXAlt  ) 
 

Returns the X11 Alt (Mod1) modifier mask/flag.

Returns:
the X11 Alt (Mod1) modifier mask/flag.
See also:
accelModMaskX()

Referenced by KGlobalAccelPrivate::grabKey().

KDECORE_EXPORT uint KKeyServer::modXNumLock  ) 
 

Returns the X11 NumLock modifier mask/flag.

Returns:
the X11 NumLock modifier mask/flag.
See also:
accelModMaskX()

Referenced by KKeyNative::modXNumLock(), and KGlobalAccelPrivate::x11KeyPress().

KDECORE_EXPORT uint KKeyServer::modXWin  ) 
 

Returns the X11 Win (Mod3) modifier mask/flag.

Returns:
the X11 Win (Mod3) modifier mask/flag.
See also:
keyboardHasWinKey()

accelModMaskX()

KDECORE_EXPORT uint KKeyServer::modXScrollLock  ) 
 

Returns the X11 ScrollLock modifier mask/flag.

Returns:
the X11 ScrollLock modifier mask/flag.
See also:
accelModMaskX()

Referenced by KKeyNative::modXScrollLock().

KDECORE_EXPORT uint KKeyServer::modXModeSwitch  ) 
 

Returns the X11 Mode_switch modifier mask/flag.

Returns:
the X11 Mode_switch modifier mask/flag.
See also:
accelModMaskX()
Since:
3.5

Referenced by KKeyNative::modXModeSwitch().

KDECORE_EXPORT uint KKeyServer::accelModMaskX  ) 
 

Returns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available).

See also:
modXShift()

modXLock()

modXCtrl()

modXAlt()

modXNumLock()

modXWin()

modXScrollLock()

Referenced by KKeyNative::accelModMaskX().

KDECORE_EXPORT bool KKeyServer::keyQtToSym int  keyQt,
uint &  sym
 

Extracts the symbol from the given Qt key and converts it to a symbol.

Parameters:
keyQt the qt key code
sym if successful, the symbol will be written here
Returns:
true if successful, false otherwise
See also:
Qt::Key

Sym

Referenced by KKey::init().

KDECORE_EXPORT bool KKeyServer::keyQtToMod int  keyQt,
uint &  mod
 

Extracts the modifiers from the given Qt key and converts them in a mask of ORed KKey::ModFlag modifiers.

Parameters:
keyQt the qt key code
mod if successful, the modifiers will be written here
Returns:
true if successful, false otherwise
See also:
Qt::Key

Referenced by KKey::init().

KDECORE_EXPORT bool KKeyServer::symToKeyQt uint  sym,
int &  keyQt
 

Converts the given symbol to a Qt key code.

Parameters:
sym the symbol
keyQt if successful, the qt key code will be written here
Returns:
true if successful, false otherwise
See also:
Qt::Key

Sym

KDECORE_EXPORT bool KKeyServer::modToModQt uint  mod,
int &  modQt
 

Converts the mask of ORed KKey::ModFlag modifiers to a mask of ORed Qt key code modifiers.

Parameters:
mod the mask of KKey::ModFlag modifiers
modQt the mask of Qt key code modifiers will be written here, if successful
Returns:
true if successful, false otherwise
See also:
Qt::Key

KKey

KDECORE_EXPORT bool KKeyServer::modToModX uint  mod,
uint &  modX
 

Converts the mask of ORed KKey::ModFlag modifiers to a mask of ORed X11 modifiers.

Parameters:
mod the mask of KKey::ModFlag modifiers
modX the mask of X11 modifiers will be written here, if successful
Returns:
true if successful, false otherwise
See also:
KKey

Referenced by KKeyNative::init().

KDECORE_EXPORT bool KKeyServer::modXToModQt uint  modX,
int &  modQt
 

Converts the mask of ORed X11 modifiers to a mask of ORed Qt key code modifiers.

Parameters:
modX the mask of X11 modifiers
modQt the mask of Qt key code modifiers will be written here if successful
Returns:
true if successful, false otherwise
See also:
Qt::Key

Referenced by KKeyNative::keyCodeQt().

KDECORE_EXPORT int KKeyServer::qtButtonStateToMod Qt::ButtonState  s  ) 
 

Converts the Qt-compatible button state to x11 modifier.

KDECORE_EXPORT bool KKeyServer::modXToMod uint  modX,
uint &  mod
 

Converts the mask of ORed X11 modifiers to a mask of ORed KKey::ModFlag modifiers.

Parameters:
modX the mask of X11 modifiers
mod the mask of KKey::ModFlag modifiers will be written here, if successful
Returns:
true if successful, false otherwise
See also:
KKey

Referenced by KKeyNative::key().

KDECORE_EXPORT bool KKeyServer::codeXToSym uchar  codeX,
uint  modX,
uint &  symX
 

Converts a X11 key code and a mask of ORed X11 modifiers into a X11 symbol.

converts it to a symbol.

Parameters:
codeX the X11 key code
modX the mask of ORed X11 modifiers
symX if successful, the X11 symbol will be written here
Returns:
true if successful, false otherwise
See also:
Qt::Key

Sym

Referenced by KKeyNative::init().

KDECORE_EXPORT QString KKeyServer::modToStringUser uint  mod  ) 
 

Converts the mask of ORed KKey::ModFlag modifiers to a user-readable string.

Parameters:
mod the mask of ORed KKey::ModFlag modifiers
Returns:
the user-readable string

Referenced by KKey::modFlagLabel(), and KKey::toString().

KDE Logo
This file is part of the documentation for kdecore Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Nov 1 10:32:00 2005 by doxygen 1.4.3 written by Dimitri van Heesch, © 1997-2003