.TH "KKeyServer::Key" kde3 "11 Jun 2005" "Version Version 3.4.1" "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
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBinit\fP (const \fBKKey\fP &key, bool bQt)"
.br
.ti -1c
.RI "bool \fBisNative\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 "int \fBkeyCodeQt\fP () const "
.br
.ti -1c
.RI "void \fBsetKeycodeQt\fP (int keyQt)"
.br
.ti -1c
.RI "\fBKey\fP & \fBoperator=\fP (const \fBKKeyNative\fP &key)"
.br
.ti -1c
.RI "int \fBcompare\fP (const \fBKey\fP &key) const "
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBKey\fP &b) const "
.br
.ti -1c
.RI "bool \fBoperator<\fP (const \fBKey\fP &b) const "
.br
.ti -1c
.RI "\fBKKey\fP \fBkey\fP () const "
.br
.in -1c
.SS "Public Attributes"

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

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

.PP
Definition at line 137 of file kkeyserver_x11.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "anonymous enum"
.PP
Code for native Keys in \fBQt\fP. 
.PP
Definition at line 140 of file kkeyserver_x11.h.
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyServer::Key::init (const \fBKKey\fP & key, bool bQt)"
.PP
Initializes the key with a \fBKKey\fP. 
.PP
\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

.PP
Definition at line 912 of file kkeyserver_x11.cpp.
.PP
References key(), KKey::keyCodeQt(), m_code, and m_sym.
.SS "bool KKeyServer::Key::isNative () const\fC [inline]\fP"
.PP
Checks whether the key code is a native code. 
.PP
\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

.PP
Definition at line 168 of file kkeyserver_x11.h.
.SS "uint KKeyServer::Key::code () const\fC [inline]\fP"
.PP
Returns the code of the key. 
.PP
\fBReturns:\fP
.RS 4
the code of the key
.RE
.PP

.PP
Definition at line 174 of file kkeyserver_x11.h.
.SS "uint KKeyServer::Key::mod () const\fC [inline]\fP"
.PP
Returns the modifiers of the key. 
.PP
\fBReturns:\fP
.RS 4
the modifiers of the key
.RE
.PP

.PP
Definition at line 180 of file kkeyserver_x11.h.
.PP
Referenced by key().
.SS "uint KKeyServer::Key::sym () const\fC [inline]\fP"
.PP
Returns the symbol of the key. 
.PP
\fBReturns:\fP
.RS 4
the symbol of the key
.RE
.PP

.PP
Definition at line 186 of file kkeyserver_x11.h.
.SS "int KKeyServer::Key::keyCodeQt () const\fC [inline]\fP"
.PP
Returns the qt key code. 
.PP
\fBReturns:\fP
.RS 4
the qt key code
.RE
.PP

.PP
Definition at line 192 of file kkeyserver_x11.h.
.PP
Referenced by key().
.SS "void KKeyServer::Key::setKeycodeQt (int keyQt)\fC [inline]\fP"
.PP
Sets the qt key code. 
.PP
\fBParameters:\fP
.RS 4
\fIkeyQt\fP the qt key code
.RE
.PP

.PP
Definition at line 198 of file kkeyserver_x11.h.
.SS "\fBKey\fP & KKeyServer::Key::operator= (const \fBKKeyNative\fP & key)"
.PP
Initializes this key with a \fBKKeyNative\fP. 
.PP
\fBReturns:\fP
.RS 4
this key
.RE
.PP

.PP
Definition at line 939 of file kkeyserver_x11.cpp.
.PP
References key(), m_code, m_mod, m_sym, and KKey::sym().
.SS "int KKeyServer::Key::compare (const \fBKey\fP & key) const"
.PP
Compares this key with the given \fBKey\fP object. 
.PP
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

.PP
Definition at line 945 of file kkeyserver_x11.cpp.
.PP
References m_code, KKey::m_mod, m_mod, KKey::m_sym, and m_sym.
.SS "bool KKeyServer::Key::operator== (const \fBKey\fP & b) 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 224 of file kkeyserver_x11.h.
.SS "bool KKeyServer::Key::operator< (const \fBKey\fP & b) 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 231 of file kkeyserver_x11.h.
.SS "\fBKKey\fP KKeyServer::Key::key () const"
.PP
Converts this \fBKey\fP to a \fBKKey\fP. 
.PP
\fBReturns:\fP
.RS 4
the \fBKKey\fP
.RE
.PP

.PP
Definition at line 924 of file kkeyserver_x11.cpp.
.PP
References keyCodeQt(), m_code, m_mod, m_sym, mod(), and KKeyServer::modXToMod().
.PP
Referenced by init(), and operator=().
.SH "Member Data Documentation"
.PP 
.SS "uint \fBKKeyServer::Key::m_code\fP"
.PP
The code of the key. 
.PP
Definition at line 143 of file kkeyserver_x11.h.
.PP
Referenced by compare(), init(), key(), and operator=().
.SS "uint \fBKKeyServer::Key::m_mod\fP"
.PP
The modifiers of the key. 
.PP
Definition at line 146 of file kkeyserver_x11.h.
.PP
Referenced by compare(), key(), and operator=().
.SS "uint \fBKKeyServer::Key::m_sym\fP"
.PP
The symbol of the key. 
.PP
Definition at line 149 of file kkeyserver_x11.h.
.PP
Referenced by compare(), init(), key(), and operator=().

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