.TH "KKeyServer::Key" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyServer::Key \- Represents a key press.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kkeyserver_x11.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum { \fBCODE_FOR_QT\fP =  256 }"
.br
.RI "\fICode for native Keys in \fBQt\fP. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBinit\fP (const  KKey &key, bool bQt)"
.br
.RI "\fIInitializes the key with a \fBKKey\fP. \fP"
.ti -1c
.RI "bool \fBisNative\fP () const "
.br
.RI "\fIChecks whether the key code is a native code. \fP"
.ti -1c
.RI "uint \fBcode\fP () const "
.br
.RI "\fIReturns the code of the key. \fP"
.ti -1c
.RI "uint \fBmod\fP () const "
.br
.RI "\fIReturns the modifiers of the key. \fP"
.ti -1c
.RI "uint \fBsym\fP () const "
.br
.RI "\fIReturns the symbol of the key. \fP"
.ti -1c
.RI "int \fBkeyCodeQt\fP () const "
.br
.RI "\fIReturns the qt key code. \fP"
.ti -1c
.RI "void \fBsetKeycodeQt\fP (int keyQt)"
.br
.RI "\fISets the qt key code. \fP"
.ti -1c
.RI "\fBKey\fP & \fBoperator=\fP (const  \fBKKeyNative\fP &key)"
.br
.RI "\fIInitializes this key with a \fBKKeyNative\fP. \fP"
.ti -1c
.RI "int \fBcompare\fP (const  \fBKey\fP &key) const "
.br
.RI "\fICompares this key with the given \fBKey\fP object. \fP"
.ti -1c
.RI "bool \fBoperator==\fP (const  \fBKey\fP &b) const "
.br
.RI "\fICompares the symbol, modifiers and code of both keys. \fP"
.ti -1c
.RI "bool \fBoperator<\fP (const  \fBKey\fP &b) const "
.br
.RI "\fICompares the symbol, modifiers and code of both keys. \fP"
.ti -1c
.RI "KKey \fBkey\fP () const "
.br
.RI "\fIConverts this \fBKey\fP to a KKey. \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "uint \fBm_code\fP"
.br
.RI "\fIThe code of the key. \fP"
.ti -1c
.RI "uint \fBm_mod\fP"
.br
.RI "\fIThe modifiers of the key. \fP"
.ti -1c
.RI "uint \fBm_sym\fP"
.br
.RI "\fIThe symbol of the key. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Represents a key press. 

\fBSee also:\fP
.RS 4
KKey
.RE
.PP

.PP
Definition at line 117 of file kkeyserver_x11.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "anonymous enum"
.PP
Code for native Keys in \fBQt\fP. Definition at line 120 of file kkeyserver_x11.h.
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyServer::Key::init (const KKey & key, bool bQt)"
.PP
Initializes the key with a \fBKKey\fP. \fBParameters:\fP
.RS 4
\fIkey\fP the key to get the data from 
.br
\fIbQt\fP true to take the \fBQt\fP keycode, false for the native key code 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key 
.PP
\fBKKeyNative\fP
.RE
.PP

.SS "bool KKeyServer::Key::isNative () const\fC [inline]\fP"
.PP
Checks whether the key code is a native code. \fBReturns:\fP
.RS 4
true if native code of the window system, false if it is a \fBQt\fP keycode 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key 
.PP
\fBKKeyNative\fP
.RE
.PP
Definition at line 148 of file kkeyserver_x11.h.
.PP
References m_code.
.SS "uint KKeyServer::Key::code () const\fC [inline]\fP"
.PP
Returns the code of the key. \fBReturns:\fP
.RS 4
the code of the key
.RE
.PP
Definition at line 154 of file kkeyserver_x11.h.
.PP
References m_code.
.SS "uint KKeyServer::Key::mod () const\fC [inline]\fP"
.PP
Returns the modifiers of the key. \fBReturns:\fP
.RS 4
the modifiers of the key
.RE
.PP
Definition at line 160 of file kkeyserver_x11.h.
.PP
References m_mod.
.SS "uint KKeyServer::Key::sym () const\fC [inline]\fP"
.PP
Returns the symbol of the key. \fBReturns:\fP
.RS 4
the symbol of the key
.RE
.PP
Definition at line 166 of file kkeyserver_x11.h.
.PP
References m_sym.
.SS "int KKeyServer::Key::keyCodeQt () const\fC [inline]\fP"
.PP
Returns the qt key code. \fBReturns:\fP
.RS 4
the qt key code
.RE
.PP
Definition at line 172 of file kkeyserver_x11.h.
.PP
References m_sym.
.SS "void KKeyServer::Key::setKeycodeQt (int keyQt)\fC [inline]\fP"
.PP
Sets the qt key code. \fBParameters:\fP
.RS 4
\fIkeyQt\fP the qt key code
.RE
.PP
Definition at line 178 of file kkeyserver_x11.h.
.PP
References m_code, and m_sym.
.SS "\fBKey\fP& KKeyServer::Key::operator= (const \fBKKeyNative\fP & key)"
.PP
Initializes this key with a \fBKKeyNative\fP. \fBReturns:\fP
.RS 4
this key
.RE
.PP

.SS "int KKeyServer::Key::compare (const \fBKey\fP & key) const"
.PP
Compares this key with the given \fBKey\fP object. Returns a negative number if the given \fBKey\fP is larger, 0 if they are equal and a positive number this \fBKey\fP 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 \fBKey\fP is larger, 0 if they are equal and a positive number this \fBKey\fP is larger
.RE
.PP
Referenced by operator<(), and operator==().
.SS "bool KKeyServer::Key::operator== (const \fBKey\fP & b) const\fC [inline]\fP"
.PP
Compares the symbol, modifiers and code of both keys. \fBSee also:\fP
.RS 4
\fBcompare()\fP
.RE
.PP
Definition at line 204 of file kkeyserver_x11.h.
.PP
References compare().
.SS "bool KKeyServer::Key::operator< (const \fBKey\fP & b) const\fC [inline]\fP"
.PP
Compares the symbol, modifiers and code of both keys. \fBSee also:\fP
.RS 4
\fBcompare()\fP
.RE
.PP
Definition at line 211 of file kkeyserver_x11.h.
.PP
References compare().
.SS "KKey KKeyServer::Key::key () const"
.PP
Converts this \fBKey\fP to a KKey. \fBReturns:\fP
.RS 4
the KKey
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "uint \fBKKeyServer::Key::m_code\fP"
.PP
The code of the key. Definition at line 123 of file kkeyserver_x11.h.
.PP
Referenced by code(), isNative(), and setKeycodeQt().
.SS "uint \fBKKeyServer::Key::m_mod\fP"
.PP
The modifiers of the key. Definition at line 126 of file kkeyserver_x11.h.
.PP
Referenced by mod().
.SS "uint \fBKKeyServer::Key::m_sym\fP"
.PP
The symbol of the key. Definition at line 129 of file kkeyserver_x11.h.
.PP
Referenced by keyCodeQt(), setKeycodeQt(), and sym().

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