.TH "KKeyServer::Sym" 3 "28 Jan 2004" "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
.RI "\fICreates a null symbol. \fP"
.ti -1c
.RI "\fBSym\fP (uint sym)"
.br
.RI "\fICreates asymbol with the given value. \fP"
.ti -1c
.RI "\fBSym\fP (const  \fBQString\fP &s)"
.br
.RI "\fICreates a symbol from the given string description. \fP"
.ti -1c
.RI "bool \fBinitQt\fP (int keyQt)"
.br
.RI "\fIInitializes the symbol with the given \fBQt\fP key code. \fP"
.ti -1c
.RI "bool \fBinit\fP (const  \fBQString\fP &s)"
.br
.RI "\fIInitializes the key with the given string description. \fP"
.ti -1c
.RI "int \fBqt\fP () const "
.br
.RI "\fIReturns the qt key code of the symbol. \fP"
.ti -1c
.RI "\fBQString\fP \fBtoStringInternal\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBtoString\fP () const "
.br
.RI "\fIReturns the string representation of the symbol. \fP"
.ti -1c
.RI "uint \fBgetModsRequired\fP () const "
.br
.RI "\fIReturns the mods that are required for this symbol as ORed \fBKKey::ModFlag\fP's. \fP"
.ti -1c
.RI "uint \fBgetSymVariation\fP () const "
.br
.RI "\fITODO: please find out what this method does and document it. \fP"
.ti -1c
.RI "\fBoperator uint\fP () const "
.br
.RI "\fICasts the symbol to its integer representation. \fP"
.ti -1c
.RI "\fBSym\fP & \fBoperator=\fP (uint sym)"
.br
.RI "\fIOverloaded operator to convert ints to \fBSym\fP. \fP"
.in -1c
.SS "Public Attributes"

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

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

.PP
Definition at line 27 of file kkeyserver_x11.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KKeyServer::Sym::Sym ()\fC [inline]\fP"
.PP
Creates a null symbol. Definition at line 34 of file kkeyserver_x11.h.
.PP
References m_sym.
.SS "KKeyServer::Sym::Sym (uint sym)\fC [inline]\fP"
.PP
Creates asymbol with the given value. \fBParameters:\fP
.RS 4
\fIsym\fP the value
.RE
.PP
Definition at line 40 of file kkeyserver_x11.h.
.PP
References m_sym.
.SS "KKeyServer::Sym::Sym (const \fBQString\fP & s)\fC [inline]\fP"
.PP
Creates a symbol from the given string description. \fBParameters:\fP
.RS 4
\fIs\fP the description of the symbol 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBtoString()\fP
.RE
.PP
Definition at line 47 of file kkeyserver_x11.h.
.PP
References init().
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyServer::Sym::initQt (int keyQt)"
.PP
Initializes the symbol with the given \fBQt\fP key code. \fBParameters:\fP
.RS 4
\fIkeyQt\fP the qt key code 
.RE
.PP
\fBReturns:\fP
.RS 4
true if succesful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
Qt::Key
.RE
.PP

.SS "bool KKeyServer::Sym::init (const \fBQString\fP & s)"
.PP
Initializes the key with the given string description. \fBParameters:\fP
.RS 4
\fIs\fP the string description 
.RE
.PP
\fBReturns:\fP
.RS 4
true if succesful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBtoString()\fP
.RE
.PP
Referenced by Sym().
.SS "int KKeyServer::Sym::qt () const"
.PP
Returns the qt key code of the symbol. \fBReturns:\fP
.RS 4
the qt key code
.RE
.PP

.SS "\fBQString\fP KKeyServer::Sym::toString () const"
.PP
Returns the string representation of the symbol. \fBReturns:\fP
.RS 4
the string representation of the symbol
.RE
.PP

.SS "uint KKeyServer::Sym::getModsRequired () const"
.PP
Returns the mods that are required for this symbol as ORed \fBKKey::ModFlag\fP's. 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
KKey::ModFlag
.RE
.PP

.SS "uint KKeyServer::Sym::getSymVariation () const"
.PP
TODO: please find out what this method does and document it. 
.SS "KKeyServer::Sym::operator uint () const\fC [inline]\fP"
.PP
Casts the symbol to its integer representation. Definition at line 100 of file kkeyserver_x11.h.
.PP
References m_sym.
.SS "\fBSym\fP& KKeyServer::Sym::operator= (uint sym)\fC [inline]\fP"
.PP
Overloaded operator to convert ints to \fBSym\fP. Definition at line 105 of file kkeyserver_x11.h.
.PP
References m_sym.
.SH "Member Data Documentation"
.PP 
.SS "uint \fBKKeyServer::Sym::m_sym\fP"
.PP
the actual value of the symbol Definition at line 31 of file kkeyserver_x11.h.
.PP
Referenced by operator uint(), operator=(), and Sym().

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