---

KKeyServer Namespace Reference

Compounds
struct	CodeMod
struct	Key
struct	Sym
struct	Variations
Enumerations
enum	ExtraModFlag
Functions
bool	initializeMods ()
	TODO: please document.
uint	modX (KKey::ModFlag modFlag)
bool	keyboardHasWinKey ()
uint	modXShift ()
uint	modXLock ()
uint	modXCtrl ()
uint	modXAlt ()
uint	modXNumLock ()
uint	modXWin ()
uint	modXScrollLock ()
uint	accelModMaskX ()
bool	keyQtToSym (int keyQt, uint &sym)
bool	keyQtToMod (int keyQt, uint &mod)
bool	symToKeyQt (uint sym, int &keyQt)
bool	modToModQt (uint mod, int &modQt)
bool	modToModX (uint mod, uint &modX)
bool	modXToModQt (uint modX, int &modQt)
bool	modXToMod (uint modX, uint &mod)
bool	codeXToSym (uchar codeX, uint modX, uint &symX)
QString	modToStringUser (uint mod)

---

Detailed Description

A collection of functions for the conversion of key presses and their modifiers from the window system (X11) 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 18 of file kkeyserver_x11.h.

---

Function Documentation

uint accelModMaskX (    )

Returns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available). See also: modXShift() , modXLock() , modXCtrl() , modXAlt() , modXNumLock() , modXWin() , modXScrollLock()

bool 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 sym  if successful, the X11 symbol will be written here Returns: true if successful, false otherwise See also: Qt::Key , Sym

bool 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()

bool 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

bool 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

bool modToModQt (  uint    mod, int &    modQt )

Converts the mask of ORed KKey::ModFlag modifiers to a mask of ORed Qt key code modifiers. Parameters: the  mask of KKey::ModFlag modifiers the  mask of Qt key code modifiers will be written here, if successful Returns: true if successful, false otherwise See also: Qt::Key , KKey

bool modToModX (  uint    mod, uint &    modX )

Converts the mask of ORed KKey::ModFlag modifiers to a mask of ORed X11 modifiers. Parameters: the  mask of KKey::ModFlag modifiers the  mask of X11 modifiers will be written here, if successful Returns: true if successful, false otherwise See also: KKey

QString 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

uint 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

uint modXAlt (    )

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

uint modXCtrl (    )

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

uint modXLock (    )

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

uint modXNumLock (    )

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

uint modXScrollLock (    )

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

uint modXShift (    )

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

bool modXToMod (  uint    modX, uint &    mod )

Converts the mask of ORed X11 modifiers to a mask of ORed KKey::ModFlag modifiers. Parameters: the  mask of X11 modifiers the  mask of KKey::ModFlag modifiers will be written here, if successful Returns: true if successful, false otherwise See also: KKey

bool modXToModQt (  uint    modX, int &    modQt )

Converts the mask of ORed X11 modifiers to a mask of ORed Qt key code modifiers. Parameters: the  mask of X11 modifiers the  mask of Qt key code modifiers will be written here if successful Returns: true if successful, false otherwise See also: Qt::Key

uint modXWin (    )

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

bool 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

---