class KKeyNative

# class KKeyNative | Representation of a key in the format native of the windowing system (eg. More...
Definition | `#include <kkeynative.h>`
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KKeyNative ()
- KKeyNative ( const XEvent* xevent )
- KKeyNative ( const KKey& key )
- KKeyNative ( const KKeyNative& )
- KKeyNative ( uint code, uint mod, uint sym )
- ~KKeyNative ()
- void clear ()
- bool init ( const XEvent* xevent )
- bool init ( const KKey& key )
- bool init ( const KKeyNative& key )
- KKeyNative& operator = ( const KKeyNative& key )
- int keyCodeQt () const
- KKey key () const
- operator KKey () const
- uint code () const
- uint mod () const
- uint sym () const
- bool isNull () const
- int compare ( const KKeyNative& key ) const
- bool operator == ( const KKeyNative& key ) const
- bool operator != ( const KKeyNative& key ) const
- bool operator < ( const KKeyNative& key ) const

#### Public Static Methods

- static KKeyNative& null ()
- static bool keyboardHasWinKey ()
- static uint modX ( KKey::ModFlag modFlag )
- static uint accelModMaskX ()
- static uint modXNumLock ()
- static uint modXLock ()
- static uint modXScrollLock ()

## Detailed Description

Representation of a key in the format native of the windowing system (eg. X11).

See also: KKey

KKeyNative () | ### KKeyNative

Creates a new null KKey.

See also: clear(), isNull(), null()

KKeyNative ( const XEvent* xevent ) | ### KKeyNative

Extracts a new native key from the given xevent.

Parameters:

xevent | the XEvent that contains the key

KKeyNative ( const KKey& key ) | ### KKeyNative

Creates a new native key for the given KKey code.

Parameters:

key | the KKey that contains the generic key

KKeyNative ( const KKeyNative& ) | ### KKeyNative

Copy constructor.

KKeyNative ( uint code, uint mod, uint sym ) | ### KKeyNative

~KKeyNative () | ### ~KKeyNative

void clear () | ### clear

Clears the key. The key is null after calling this function.

See also: isNull()

bool init ( const XEvent* xevent ) | ### init

Initializes the native key by extracting the information from the given xevent.

Parameters:

xevent | the XEvent that contains the key

Returns: true if succesful, false otherwise

bool init ( const KKey& key ) | ### init

Creates a new native key for the given KKey code.

Parameters:

key | the KKey that contains the generic key

Returns: true if succesful, false otherwise

bool init ( const KKeyNative& key ) | ### init

Copies the given key into this key.

Parameters:

key | the key to copy

Returns: true if succesful, false otherwise

KKeyNative& operator = ( const KKeyNative& key ) | ### operator =

Copies the given key into this key.

Parameters:

key | the key to copy

Returns: this key

int keyCodeQt () | ### keyCodeQt

[const]

Returns the qt key code.

Returns: the qt key code or 0 if there is no key set.

See also: Qt::Key

KKey key () | ### key

[const]

Returns the KKey representation of this key.

Returns: the KKey representation

operator KKey () | ### KKey

[const]

Converts this key to its KKey representation.

Returns: the KKey representation

See also: key()

uint code () | ### code

[const]

The native keycode of the key.

Returns: the native keycode

uint mod () | ### mod

[const]

The native modifier flags of the key.

Returns: the native modifier flags

uint sym () | ### sym

[const]

The native symbol (KeySym) of the key.

Returns: the native symbol (KeySym)

bool isNull () | ### isNull

[const]

Returns true if the key is null (after clear() or empty constructor).

Returns: true if the key is null

See also: clear(), null()

int compare ( const KKeyNative& key ) | ### compare

[const]

Compares this key with the given KKeyNative object. Returns a negative number if the given KKeyNative is larger, 0 if they are equal and a positive number this KKeyNative is larger. The returned value is the difference between the symbol, modifier or code, whatever is non-zero first.

Parameters:

key | the key to compare with this key

Returns: a negative number if the given KKeyNative is larger, 0 if they are equal and a positive number this KKeyNative is larger

bool operator == ( const KKeyNative& key ) | ### operator ==

[const]

Compares the symbol, modifiers and code of both keys.

See also: compare()

bool operator != ( const KKeyNative& key ) | ### operator !=

[const]

Compares the symbol, modifiers and code of both keys.

See also: compare()

bool operator < ( const KKeyNative& key ) | ### operator <

[const]

Compares the symbol, modifiers and code of both keys.

See also: compare()

KKeyNative& null () | ### null

[static]

Returns a null key.

Returns: the null key

See also: isNull(), clear()

bool keyboardHasWinKey () | ### keyboardHasWinKey

[static]

Checks whether the keyboard has a Win key.

Returns: true if the keyboard has a Win key

uint modX ( KKey::ModFlag modFlag ) | ### modX

[static]

Returns the equivalent X modifier mask of the given modifier flag.

Parameters:

modFlag | the mod flags to test

Returns: the equivalent native flags of the window system

uint accelModMaskX () | ### accelModMaskX

[static]

Returns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available).

Returns: the mask of Shift, Ctrl, Alt and Win.

uint modXNumLock () | ### modXNumLock

[static]

Returns the X11 NumLock modifier mask/flag.

Returns: the X11 NumLock modifier mask/flag.

See also: accelModMaskX()

uint modXLock () | ### modXLock

[static]

Returns the X11 Lock modifier mask/flag.

Returns: the X11 Lock modifier mask/flag.

See also: accelModMaskX()

uint modXScrollLock () | ### modXScrollLock

[static]

Returns the X11 ScrollLock modifier mask/flag.

Returns: the X11 ScrollLock modifier mask/flag.

See also: accelModMaskX()

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:15 2003, using kdoc 2.0a54.