Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KKeyServer::Sym Struct Reference

#include <kkeyserver_x11.h>

List of all members.

Public Methods

 Sym ()
 Creates a null symbol.

 Sym (uint sym)
 Sym (const QString &s)
bool initQt (int keyQt)
bool init (const QString &s)
int qt () const
QString toString () const
uint getModsRequired () const
uint getSymVariation () const
 operator uint () const
Sym & operator= (uint sym)

Public Attributes

uint m_sym
 the actual value of the symbol


Detailed Description

Represents a key symbol.
See also:
KKey , KKeyServer

Definition at line 27 of file kkeyserver_x11.h.


Constructor & Destructor Documentation

KKeyServer::Sym::Sym uint    sym [inline]
 

Creates asymbol with the given value.

Parameters:
sym  the value

Definition at line 40 of file kkeyserver_x11.h.

References m_sym.

KKeyServer::Sym::Sym const QString &    s [inline]
 

Creates a symbol from the given string description.

Parameters:
s  the description of the symbol
See also:
toString()

Definition at line 47 of file kkeyserver_x11.h.

References init().


Member Function Documentation

uint KKeyServer::Sym::getModsRequired  
 

Returns the mods that are required for this symbol as ORed KKey::ModFlag's. For example, Break requires a Ctrl to be valid.

Returns:
the required KKey::ModFlag's
See also:
KKey::ModFlag

uint KKeyServer::Sym::getSymVariation  
 

TODO: please find out what this method does and document it

bool KKeyServer::Sym::init const QString &    s
 

Initializes the key with the given string description.

Parameters:
s  the string description
Returns:
true if succesful, false otherwise
See also:
toString()

Referenced by Sym().

bool KKeyServer::Sym::initQt int    keyQt
 

Initializes the symbol with the given Qt key code.

Parameters:
keyQt  the qt key code
Returns:
true if succesful, false otherwise
See also:
Qt::Key

KKeyServer::Sym::operator uint   const [inline]
 

Casts the symbol to its integer representation.

Definition at line 100 of file kkeyserver_x11.h.

References m_sym.

Sym& KKeyServer::Sym::operator= uint    sym [inline]
 

Overloaded operator to convert ints to Sym.

Definition at line 105 of file kkeyserver_x11.h.

References m_sym.

int KKeyServer::Sym::qt  
 

Returns the qt key code of the symbol.

Returns:
the qt key code

QString KKeyServer::Sym::toString  
 

Returns the string representation of the symbol.

Returns:
the string representation of the symbol


The documentation for this struct was generated from the following file:
Generated on Wed Aug 13 23:30:35 2003 for kdelibs by doxygen1.2.18