KKeyServer::Sym Struct Reference

#include <kkeyserver_x11.h>

Public Member Functions
	Sym ()
	Sym (uint sym)
	Sym (const TQString &s)
bool	initQt (int keyQt)
bool	init (const TQString &s)
int	qt () const
TQString	toStringInternal () const
TQString	toString () const
uint	getModsRequired () const
uint	getSymVariation () const
	operator uint () const
Sym &	operator= (uint sym)

Public Attributes
uint	m_sym

Detailed Description

Represents a key symbol.

See also

KKey

KKeyServer

Definition at line 47 of file kkeyserver_x11.h.

Constructor & Destructor Documentation

Sym() [1/3]

KKeyServer::Sym::Sym ( )

inline

Creates a null symbol.

Definition at line 54 of file kkeyserver_x11.h.

Sym() [2/3]

KKeyServer::Sym::Sym ( uint  sym )

inline

Creates asymbol with the given value.

Parameters

sym

the value

Definition at line 60 of file kkeyserver_x11.h.

Sym() [3/3]

KKeyServer::Sym::Sym ( const TQString &  s )

inline

Creates a symbol from the given string description.

Parameters

s	the description of the symbol

See also

toString()

Definition at line 67 of file kkeyserver_x11.h.

Member Function Documentation

getModsRequired()

uint KKeyServer::Sym::getModsRequired

(

)

const

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

getSymVariation()

uint KKeyServer::Sym::getSymVariation

(

)

const

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

init()

bool KKeyServer::Sym::init

(

const TQString &

s

)

Initializes the key with the given string description.

Parameters

s	the string description

Returns

true if successful, false otherwise

See also

toString()

initQt()

bool KKeyServer::Sym::initQt

(

int

keyQt

)

Initializes the symbol with the given Qt key code.

Parameters

keyQt

the qt key code

Returns

true if successful, false otherwise

See also

TQt::Key

operator uint()

KKeyServer::Sym::operator uint ( ) const

inline

Casts the symbol to its integer representation.

Definition at line 120 of file kkeyserver_x11.h.

operator=()

Sym& KKeyServer::Sym::operator= ( uint  sym )

inline

Overloaded operator to convert ints to Sym.

Definition at line 125 of file kkeyserver_x11.h.

qt()

int KKeyServer::Sym::qt

(

)

const

Returns the qt key code of the symbol.

Returns

the qt key code

toString()

TQString KKeyServer::Sym::toString

(

)

const

Returns the string representation of the symbol.

Returns

the string representation of the symbol

Member Data Documentation

m_sym

uint KKeyServer::Sym::m_sym

the actual value of the symbol

Definition at line 51 of file kkeyserver_x11.h.

---

The documentation for this struct was generated from the following file:

• kkeyserver_x11.h