.TH "KKeyServer::Sym" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyServer::Sym \- Represents a key symbol.  

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

.in +1c
.ti -1c
.RI "\fBSym\fP ()"
.br
.ti -1c
.RI "\fBSym\fP (uint sym)"
.br
.ti -1c
.RI "\fBSym\fP (const \fBQString\fP &s)"
.br
.ti -1c
.RI "bool \fBinitQt\fP (int keyQt)"
.br
.ti -1c
.RI "bool \fBinit\fP (const \fBQString\fP &s)"
.br
.ti -1c
.RI "int \fBqt\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBtoStringInternal\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBtoString\fP () const "
.br
.ti -1c
.RI "uint \fBgetModsRequired\fP () const "
.br
.ti -1c
.RI "uint \fBgetSymVariation\fP () const "
.br
.ti -1c
.RI "\fBoperator uint\fP () const "
.br
.ti -1c
.RI "\fBSym\fP & \fBoperator=\fP (uint sym)"
.br
.in -1c
.SS "Public Attributes"

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

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

.PP
Definition at line 47 of file kkeyserver_x11.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KKeyServer::Sym::Sym ()\fC [inline]\fP"
.PP
Creates a null symbol. 
.PP
Definition at line 54 of file kkeyserver_x11.h.
.SS "KKeyServer::Sym::Sym (uint sym)\fC [inline]\fP"
.PP
Creates asymbol with the given value. 
.PP
\fBParameters:\fP
.RS 4
\fIsym\fP the value
.RE
.PP

.PP
Definition at line 60 of file kkeyserver_x11.h.
.SS "KKeyServer::Sym::Sym (const \fBQString\fP & s)\fC [inline]\fP"
.PP
Creates a symbol from the given string description. 
.PP
\fBParameters:\fP
.RS 4
\fIs\fP the description of the symbol 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBtoString()\fP
.RE
.PP

.PP
Definition at line 67 of file kkeyserver_x11.h.
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyServer::Sym::initQt (int keyQt)"
.PP
Initializes the symbol with the given \fBQt\fP key code. 
.PP
\fBParameters:\fP
.RS 4
\fIkeyQt\fP the qt key code 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key
.RE
.PP

.PP
Definition at line 404 of file kkeyserver_x11.cpp.
.PP
References endl(), QString::lower(), m_sym, QString::number(), and QString::unicode().
.PP
Referenced by KKeyServer::keyQtToSym().
.SS "bool KKeyServer::Sym::init (const \fBQString\fP & s)"
.PP
Initializes the key with the given string description. 
.PP
\fBParameters:\fP
.RS 4
\fIs\fP the string description 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBtoString()\fP
.RE
.PP

.PP
Definition at line 435 of file kkeyserver_x11.cpp.
.PP
References QString::latin1(), m_sym, and QString::upper().
.SS "int KKeyServer::Sym::qt () const"
.PP
Returns the qt key code of the symbol. 
.PP
\fBReturns:\fP
.RS 4
the qt key code
.RE
.PP

.PP
Definition at line 475 of file kkeyserver_x11.cpp.
.PP
References m_sym, and QString::upper().
.PP
Referenced by KKeyServer::symToKeyQt().
.SS "\fBQString\fP KKeyServer::Sym::toString () const"
.PP
Returns the string representation of the symbol. 
.PP
\fBReturns:\fP
.RS 4
the string representation of the symbol
.RE
.PP

.PP
Definition at line 533 of file kkeyserver_x11.cpp.
.SS "uint KKeyServer::Sym::getModsRequired () const"
.PP
Returns the mods that are required for this symbol as ORed \fBKKey::ModFlag\fP's. 
.PP
For example, Break requires a Ctrl to be valid. 
.PP
\fBReturns:\fP
.RS 4
the required \fBKKey::ModFlag\fP's 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKKey::ModFlag\fP
.RE
.PP

.PP
Definition at line 535 of file kkeyserver_x11.cpp.
.PP
References QChar::isLetter(), QChar::lower(), m_sym, QChar::unicode(), and QChar::upper().
.SS "uint KKeyServer::Sym::getSymVariation () const"
.PP
TODO: please find out what this method does and document it. 
.PP
Definition at line 567 of file kkeyserver_x11.cpp.
.PP
References m_sym.
.SS "KKeyServer::Sym::operator uint () const\fC [inline]\fP"
.PP
Casts the symbol to its integer representation. 
.PP

.PP
Definition at line 120 of file kkeyserver_x11.h.
.SS "\fBSym\fP& KKeyServer::Sym::operator= (uint sym)\fC [inline]\fP"
.PP
Overloaded operator to convert ints to \fBSym\fP. 
.PP

.PP
Definition at line 125 of file kkeyserver_x11.h.
.SH "Member Data Documentation"
.PP 
.SS "uint \fBKKeyServer::Sym::m_sym\fP"
.PP
the actual value of the symbol 
.PP
Definition at line 51 of file kkeyserver_x11.h.
.PP
Referenced by getModsRequired(), getSymVariation(), KKey::init(), init(), initQt(), KKeyServer::keyQtToSym(), and qt().

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