.TH "KKeyServer" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyServer \- 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.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBSym\fP"
.br
.RI "\fIRepresents a key symbol. \fP"
.ti -1c
.RI "struct \fBKey\fP"
.br
.RI "\fIRepresents a key press. \fP"
.ti -1c
.RI "struct \fBVariations\fP"
.br
.RI "\fITODO: please document this class. \fP"
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBExtraModFlag\fP { \fBMODE_SWITCH\fP =  0x2000 }"
.br
.RI "\fISupplement enum KKey::ModFlag 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP
\fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "bool \fBinitializeMods\fP ()"
.br
.RI "\fITODO: please document. \fP"
.ti -1c
.RI "uint \fBmodX\fP (KKey::ModFlag modFlag)"
.br
.RI "\fIReturns the equivalent X modifier mask of the given modifier flag. \fP"
.ti -1c
.RI "bool \fBkeyboardHasWinKey\fP ()"
.br
.RI "\fIReturns true if the current keyboard layout supports the Win key. \fP"
.ti -1c
.RI "uint \fBmodXShift\fP ()"
.br
.RI "\fIReturns the X11 Shift modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBmodXLock\fP ()"
.br
.RI "\fIReturns the X11 Lock modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBmodXCtrl\fP ()"
.br
.RI "\fIReturns the X11 Ctrl modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBmodXAlt\fP ()"
.br
.RI "\fIReturns the X11 Alt (Mod1) modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBmodXNumLock\fP ()"
.br
.RI "\fIReturns the X11 NumLock modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBmodXWin\fP ()"
.br
.RI "\fIReturns the X11 Win (Mod3) modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBmodXScrollLock\fP ()"
.br
.RI "\fIReturns the X11 ScrollLock modifier mask/flag. \fP"
.ti -1c
.RI "uint \fBaccelModMaskX\fP ()"
.br
.RI "\fIReturns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available). \fP"
.ti -1c
.RI "bool \fBkeyQtToSym\fP (int keyQt, uint &sym)"
.br
.RI "\fIExtracts the symbol from the given \fBQt\fP key and converts it to a symbol. \fP"
.ti -1c
.RI "bool \fBkeyQtToMod\fP (int keyQt, uint &mod)"
.br
.RI "\fIExtracts the modifiers from the given \fBQt\fP key and converts them in a mask of ORed \fBKKey::ModFlag\fP modifiers. \fP"
.ti -1c
.RI "bool \fBsymToKeyQt\fP (uint sym, int &keyQt)"
.br
.RI "\fIConverts the given symbol to a \fBQt\fP key code. \fP"
.ti -1c
.RI "bool \fBmodToModQt\fP (uint mod, int &modQt)"
.br
.RI "\fIConverts the mask of ORed \fBKKey::ModFlag\fP modifiers to a mask of ORed \fBQt\fP key code modifiers. \fP"
.ti -1c
.RI "bool \fBmodToModX\fP (uint mod, uint &modX)"
.br
.RI "\fIConverts the mask of ORed \fBKKey::ModFlag\fP modifiers to a mask of ORed X11 modifiers. \fP"
.ti -1c
.RI "bool \fBmodXToModQt\fP (uint modX, int &modQt)"
.br
.RI "\fIConverts the mask of ORed X11 modifiers to a mask of ORed \fBQt\fP key code modifiers. \fP"
.ti -1c
.RI "bool \fBmodXToMod\fP (uint modX, uint &mod)"
.br
.RI "\fIConverts the mask of ORed X11 modifiers to a mask of ORed \fBKKey::ModFlag\fP modifiers. \fP"
.ti -1c
.RI "bool \fBcodeXToSym\fP (uchar codeX, uint modX, uint &symX)"
.br
.RI "\fIConverts a X11 key code and a mask of ORed X11 modifiers into a X11 symbol. \fP"
.ti -1c
.RI "\fBQString\fP \fBmodToStringInternal\fP (uint mod)"
.br
.ti -1c
.RI "\fBQString\fP \fBmodToStringUser\fP (uint mod)"
.br
.RI "\fIConverts the mask of ORed \fBKKey::ModFlag\fP modifiers to a user-readable string. \fP"
.ti -1c
.RI "bool \fBstringToSymMod\fP (const  \fBQString\fP &, uint &sym, uint &mod)"
.br
.ti -1c
.RI "void \fBkeyQtToKeyX\fP (uint keyCombQt, unsigned char *pKeyCodeX, uint *pKeySymX, uint *pKeyModX)"
.br
.in -1c
.SH "Detailed Description"
.PP 
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. 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBKKeyServer::ExtraModFlag\fP"
.PP
Supplement enum KKey::ModFlag 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP
Definition at line 18 of file kkeyserver_x11.h.
.SH "Function Documentation"
.PP 
.SS "bool initializeMods ()"
.PP
TODO: please document. 
.SS "uint modX (KKey::ModFlag modFlag)"
.PP
Returns the equivalent X modifier mask of the given modifier flag. \fBParameters:\fP
.RS 4
\fImodFlag\fP the generic flags to check 
.RE
.PP
\fBReturns:\fP
.RS 4
the window system specific flags
.RE
.PP

.SS "bool keyboardHasWinKey ()"
.PP
Returns true if the current keyboard layout supports the Win key. Specifically, whether the Super or Meta keys are assigned to an X modifier. 
.PP
\fBReturns:\fP
.RS 4
true if the keyboard has a Win key 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBmodXWin()\fP
.RE
.PP

.SS "uint modXShift ()"
.PP
Returns the X11 Shift modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 Shift modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint modXLock ()"
.PP
Returns the X11 Lock modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 Lock modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint modXCtrl ()"
.PP
Returns the X11 Ctrl modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 Ctrl modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint modXAlt ()"
.PP
Returns the X11 Alt (Mod1) modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 Alt (Mod1) modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint modXNumLock ()"
.PP
Returns the X11 NumLock modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 NumLock modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint modXWin ()"
.PP
Returns the X11 Win (Mod3) modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 Win (Mod3) modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkeyboardHasWinKey()\fP 
.PP
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint modXScrollLock ()"
.PP
Returns the X11 ScrollLock modifier mask/flag. \fBReturns:\fP
.RS 4
the X11 ScrollLock modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.SS "uint accelModMaskX ()"
.PP
Returns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available). \fBSee also:\fP
.RS 4
\fBmodXShift()\fP 
.PP
\fBmodXLock()\fP 
.PP
\fBmodXCtrl()\fP 
.PP
\fBmodXAlt()\fP 
.PP
\fBmodXNumLock()\fP 
.PP
\fBmodXWin()\fP 
.PP
\fBmodXScrollLock()\fP
.RE
.PP

.SS "bool keyQtToSym (int keyQt, uint & sym)"
.PP
Extracts the symbol from the given \fBQt\fP key and converts it to a symbol. \fBParameters:\fP
.RS 4
\fIkeyQt\fP the qt key code 
.br
\fIsym\fP if successful, the symbol will be written here 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key 
.PP
\fBSym\fP
.RE
.PP

.SS "bool keyQtToMod (int keyQt, uint & mod)"
.PP
Extracts the modifiers from the given \fBQt\fP key and converts them in a mask of ORed \fBKKey::ModFlag\fP modifiers. \fBParameters:\fP
.RS 4
\fIkeyQt\fP the qt key code 
.br
\fImod\fP if successful, the modifiers will be written here 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key
.RE
.PP

.SS "bool symToKeyQt (uint sym, int & keyQt)"
.PP
Converts the given symbol to a \fBQt\fP key code. \fBParameters:\fP
.RS 4
\fIsym\fP the symbol 
.br
\fIkeyQt\fP if successful, the qt key code will be written here 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key 
.PP
\fBSym\fP
.RE
.PP

.SS "bool modToModQt (uint mod, int & modQt)"
.PP
Converts the mask of ORed \fBKKey::ModFlag\fP modifiers to a mask of ORed \fBQt\fP key code modifiers. \fBParameters:\fP
.RS 4
\fIthe\fP mask of \fBKKey::ModFlag\fP modifiers 
.br
\fIthe\fP mask of \fBQt\fP key code modifiers will be written here, if successful 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key 
.PP
KKey
.RE
.PP

.SS "bool modToModX (uint mod, uint & modX)"
.PP
Converts the mask of ORed \fBKKey::ModFlag\fP modifiers to a mask of ORed X11 modifiers. \fBParameters:\fP
.RS 4
\fIthe\fP mask of \fBKKey::ModFlag\fP modifiers 
.br
\fIthe\fP mask of X11 modifiers will be written here, if successful 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
KKey
.RE
.PP

.SS "bool modXToModQt (uint modX, int & modQt)"
.PP
Converts the mask of ORed X11 modifiers to a mask of ORed \fBQt\fP key code modifiers. \fBParameters:\fP
.RS 4
\fIthe\fP mask of X11 modifiers 
.br
\fIthe\fP mask of \fBQt\fP key code modifiers will be written here if successful 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key
.RE
.PP

.SS "bool modXToMod (uint modX, uint & mod)"
.PP
Converts the mask of ORed X11 modifiers to a mask of ORed \fBKKey::ModFlag\fP modifiers. \fBParameters:\fP
.RS 4
\fIthe\fP mask of X11 modifiers 
.br
\fIthe\fP mask of \fBKKey::ModFlag\fP modifiers will be written here, if successful 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
KKey
.RE
.PP

.SS "bool codeXToSym (uchar codeX, uint modX, uint & symX)"
.PP
Converts a X11 key code and a mask of ORed X11 modifiers into a X11 symbol. converts it to a symbol. 
.PP
\fBParameters:\fP
.RS 4
\fIcodeX\fP the X11 key code 
.br
\fImodX\fP the mask of ORed X11 modifiers 
.br
\fIsym\fP if successful, the X11 symbol will be written here 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key 
.PP
\fBSym\fP
.RE
.PP

.SS "\fBQString\fP modToStringUser (uint mod)"
.PP
Converts the mask of ORed \fBKKey::ModFlag\fP modifiers to a user-readable string. \fBParameters:\fP
.RS 4
\fImod\fP the mask of ORed \fBKKey::ModFlag\fP modifiers 
.RE
.PP
\fBReturns:\fP
.RS 4
the user-readable string
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
