.TH "KKeyNative" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyNative \- Representation of a key in the format native of the windowing system (eg.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kkeynative.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKKeyNative\fP ()"
.br
.ti -1c
.RI "\fBKKeyNative\fP (const XEvent *xevent)"
.br
.ti -1c
.RI "\fBKKeyNative\fP (const \fBKKey\fP &key)"
.br
.ti -1c
.RI "\fBKKeyNative\fP (const \fBKKeyNative\fP &)"
.br
.ti -1c
.RI "\fBKKeyNative\fP (uint code, uint mod, uint sym)"
.br
.ti -1c
.RI "void \fBclear\fP ()"
.br
.ti -1c
.RI "bool \fBinit\fP (const XEvent *xevent)"
.br
.ti -1c
.RI "bool \fBinit\fP (const \fBKKey\fP &key)"
.br
.ti -1c
.RI "bool \fBinit\fP (const \fBKKeyNative\fP &key)"
.br
.ti -1c
.RI "\fBKKeyNative\fP & \fBoperator=\fP (const \fBKKeyNative\fP &key)"
.br
.ti -1c
.RI "int \fBkeyCodeQt\fP () const "
.br
.ti -1c
.RI "\fBKKey\fP \fBkey\fP () const "
.br
.ti -1c
.RI "\fBoperator KKey\fP () const "
.br
.ti -1c
.RI "uint \fBcode\fP () const "
.br
.ti -1c
.RI "uint \fBmod\fP () const "
.br
.ti -1c
.RI "uint \fBsym\fP () const "
.br
.ti -1c
.RI "bool \fBisNull\fP () const "
.br
.ti -1c
.RI "int \fBcompare\fP (const \fBKKeyNative\fP &key) const "
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBKKeyNative\fP &key) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBKKeyNative\fP &key) const "
.br
.ti -1c
.RI "bool \fBoperator<\fP (const \fBKKeyNative\fP &key) const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBKKeyNative\fP & \fBnull\fP ()"
.br
.ti -1c
.RI "static bool \fBkeyboardHasWinKey\fP ()"
.br
.ti -1c
.RI "static uint \fBmodX\fP (\fBKKey::ModFlag\fP modFlag)"
.br
.ti -1c
.RI "static uint \fBaccelModMaskX\fP ()"
.br
.ti -1c
.RI "static uint \fBmodXNumLock\fP ()"
.br
.ti -1c
.RI "static uint \fBmodXLock\fP ()"
.br
.ti -1c
.RI "static uint \fBmodXScrollLock\fP ()"
.br
.ti -1c
.RI "static uint \fBmodXModeSwitch\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
Representation of a key in the format native of the windowing system (eg. 

X11). 
.PP
\fBSee also:\fP
.RS 4
\fBKKey\fP 
.RE
.PP

.PP
Definition at line 37 of file kkeynative.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KKeyNative::KKeyNative ()"
.PP
Creates a new null \fBKKey\fP. 
.PP
\fBSee also:\fP
.RS 4
\fBclear()\fP 
.PP
\fBisNull()\fP 
.PP
\fBnull()\fP
.RE
.PP

.PP
Definition at line 55 of file kkeynative_x11.cpp.
.PP
References clear().
.SS "KKeyNative::KKeyNative (const XEvent * xevent)"
.PP
Extracts a new native key from the given xevent. 
.PP
\fBParameters:\fP
.RS 4
\fIxevent\fP the XEvent that contains the key
.RE
.PP

.PP
Definition at line 59 of file kkeynative_x11.cpp.
.PP
References init().
.SS "KKeyNative::KKeyNative (const \fBKKey\fP & key)"
.PP
Creates a new native key for the given \fBKKey\fP code. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the \fBKKey\fP that contains the generic key
.RE
.PP

.PP
Definition at line 56 of file kkeynative_x11.cpp.
.PP
References init(), and key().
.SS "KKeyNative::KKeyNative (const \fBKKeyNative\fP &)"
.PP
Copy constructor. 
.PP

.PP
Definition at line 57 of file kkeynative_x11.cpp.
.PP
References init(), and key().
.SH "Member Function Documentation"
.PP 
.SS "void KKeyNative::clear ()"
.PP
Clears the key. 
.PP
The key is null after calling this function. 
.PP
\fBSee also:\fP
.RS 4
\fBisNull()\fP
.RE
.PP

.PP
Definition at line 72 of file kkeynative_x11.cpp.
.PP
Referenced by KKeyNative(), and null().
.SS "bool KKeyNative::init (const XEvent * xevent)"
.PP
Initializes the native key by extracting the information from the given xevent. 
.PP
\fBParameters:\fP
.RS 4
\fIxevent\fP the XEvent that contains the key 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise
.RE
.PP

.PP
Definition at line 80 of file kkeynative_x11.cpp.
.PP
Referenced by KKeyNative().
.SS "bool KKeyNative::init (const \fBKKey\fP & key)"
.PP
Creates a new native key for the given \fBKKey\fP code. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the \fBKKey\fP that contains the generic key 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise
.RE
.PP

.PP
Definition at line 91 of file kkeynative_x11.cpp.
.PP
References KKeyServer::codeXToSym(), endl(), key(), KKey::m_mod, KKey::modFlags(), KKeyServer::modToModX(), and KKey::sym().
.SS "bool KKeyNative::init (const \fBKKeyNative\fP & key)"
.PP
Copies the given key into this key. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key to copy 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise
.RE
.PP

.PP
Definition at line 130 of file kkeynative_x11.cpp.
.PP
References key(), KKey::m_mod, and KKey::m_sym.
.SS "\fBKKeyNative\fP& KKeyNative::operator= (const \fBKKeyNative\fP & key)\fC [inline]\fP"
.PP
Copies the given key into this key. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key to copy 
.RE
.PP
\fBReturns:\fP
.RS 4
this key
.RE
.PP

.PP
Definition at line 108 of file kkeynative.h.
.SS "int KKeyNative::keyCodeQt () const"
.PP
Returns the qt key code. 
.PP
\fBReturns:\fP
.RS 4
the qt key code or 0 if there is no key set. 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key
.RE
.PP

.PP
Definition at line 177 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modXToModQt().
.SS "\fBKKey\fP KKeyNative::key () const"
.PP
Returns the \fBKKey\fP representation of this key. 
.PP
\fBReturns:\fP
.RS 4
the \fBKKey\fP representation
.RE
.PP

.PP
Definition at line 164 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modXToMod().
.PP
Referenced by compare(), init(), and KKeyNative().
.SS "KKeyNative::operator \fBKKey\fP () const\fC [inline]\fP"
.PP
Converts this key to its \fBKKey\fP representation. 
.PP
\fBReturns:\fP
.RS 4
the \fBKKey\fP representation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkey()\fP
.RE
.PP

.PP
Definition at line 130 of file kkeynative.h.
.SS "uint KKeyNative::code () const"
.PP
The native keycode of the key. 
.PP
\fBReturns:\fP
.RS 4
the native keycode
.RE
.PP

.PP
Definition at line 138 of file kkeynative_x11.cpp.
.SS "uint KKeyNative::mod () const"
.PP
The native modifier flags of the key. 
.PP
\fBReturns:\fP
.RS 4
the native modifier flags
.RE
.PP

.PP
Definition at line 139 of file kkeynative_x11.cpp.
.SS "uint KKeyNative::sym () const"
.PP
The native symbol (KeySym) of the key. 
.PP
\fBReturns:\fP
.RS 4
the native symbol (KeySym)
.RE
.PP

.PP
Definition at line 140 of file kkeynative_x11.cpp.
.SS "bool KKeyNative::isNull () const"
.PP
Returns true if the key is null (after \fBclear()\fP or empty constructor). 
.PP
\fBReturns:\fP
.RS 4
true if the key is null 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclear()\fP 
.PP
\fBnull()\fP
.RE
.PP

.PP
Definition at line 142 of file kkeynative_x11.cpp.
.PP
Referenced by null().
.SS "int KKeyNative::compare (const \fBKKeyNative\fP & key) const"
.PP
Compares this key with the given KKeyNative object. 
.PP
Returns a negative number if the given KKeyNative is larger, 0 if they are equal and a positive number this KKeyNative is larger. The returned value is the difference between the symbol, modifier or code, whatever is non-zero first.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key to compare with this key 
.RE
.PP
\fBReturns:\fP
.RS 4
a negative number if the given KKeyNative is larger, 0 if they are equal and a positive number this KKeyNative is larger
.RE
.PP

.PP
Definition at line 147 of file kkeynative_x11.cpp.
.PP
References key(), KKey::m_mod, and KKey::m_sym.
.SS "bool KKeyNative::operator== (const \fBKKeyNative\fP & key) const\fC [inline]\fP"
.PP
Compares the symbol, modifiers and code of both keys. 
.PP
\fBSee also:\fP
.RS 4
\fBcompare()\fP
.RE
.PP

.PP
Definition at line 176 of file kkeynative.h.
.SS "bool KKeyNative::operator!= (const \fBKKeyNative\fP & key) const\fC [inline]\fP"
.PP
Compares the symbol, modifiers and code of both keys. 
.PP
\fBSee also:\fP
.RS 4
\fBcompare()\fP
.RE
.PP

.PP
Definition at line 183 of file kkeynative.h.
.SS "bool KKeyNative::operator< (const \fBKKeyNative\fP & key) const\fC [inline]\fP"
.PP
Compares the symbol, modifiers and code of both keys. 
.PP
\fBSee also:\fP
.RS 4
\fBcompare()\fP
.RE
.PP

.PP
Definition at line 190 of file kkeynative.h.
.SS "\fBKKeyNative\fP & KKeyNative::null ()\fC [static]\fP"
.PP
Returns a null key. 
.PP
\fBReturns:\fP
.RS 4
the null key 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBisNull()\fP 
.PP
\fBclear()\fP
.RE
.PP

.PP
Definition at line 155 of file kkeynative_x11.cpp.
.PP
References clear(), and isNull().
.SS "bool KKeyNative::keyboardHasWinKey ()\fC [static]\fP"
.PP
Checks whether the keyboard has a Win key. 
.PP
\fBReturns:\fP
.RS 4
true if the keyboard has a Win key
.RE
.PP

.PP
Definition at line 187 of file kkeynative_x11.cpp.
.PP
References KKeyServer::keyboardHasWinKey().
.SS "uint KKeyNative::modX (\fBKKey::ModFlag\fP modFlag)\fC [static]\fP"
.PP
Returns the equivalent X modifier mask of the given modifier flag. 
.PP
\fBParameters:\fP
.RS 4
\fImodFlag\fP the mod flags to test 
.RE
.PP
\fBReturns:\fP
.RS 4
the equivalent native flags of the window system
.RE
.PP

.PP
Definition at line 190 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modX().
.PP
Referenced by KApplication::keyboardMouseState().
.SS "uint KKeyNative::accelModMaskX ()\fC [static]\fP"
.PP
Returns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available). 
.PP
\fBReturns:\fP
.RS 4
the mask of Shift, Ctrl, Alt and Win.
.RE
.PP

.PP
Definition at line 191 of file kkeynative_x11.cpp.
.PP
References KKeyServer::accelModMaskX().
.SS "uint KKeyNative::modXNumLock ()\fC [static]\fP"
.PP
Returns the X11 NumLock modifier mask/flag. 
.PP
\fBReturns:\fP
.RS 4
the X11 NumLock modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.PP
Definition at line 192 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modXNumLock().
.SS "uint KKeyNative::modXLock ()\fC [static]\fP"
.PP
Returns the X11 Lock modifier mask/flag. 
.PP
\fBReturns:\fP
.RS 4
the X11 Lock modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.PP
Definition at line 193 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modXLock().
.SS "uint KKeyNative::modXScrollLock ()\fC [static]\fP"
.PP
Returns the X11 ScrollLock modifier mask/flag. 
.PP
\fBReturns:\fP
.RS 4
the X11 ScrollLock modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP
.RE
.PP

.PP
Definition at line 194 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modXScrollLock().
.SS "uint KKeyNative::modXModeSwitch ()\fC [static]\fP"
.PP
Returns the X11 Mode_switch modifier mask/flag. 
.PP
\fBReturns:\fP
.RS 4
the X11 Mode_switch modifier mask/flag. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaccelModMaskX()\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.5
.RE
.PP

.PP
Definition at line 195 of file kkeynative_x11.cpp.
.PP
References KKeyServer::modXModeSwitch().

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