Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

scim::KeyEvent Struct Reference
[Accessories]

The class to store a keyboard event. More...

#include <scim_event.h>

List of all members.

Public Member Functions

 KeyEvent (uint32 c=0, uint16 m=0, uint16 l=0)
 Default constructor.
 KeyEvent (const String &str)
 Constructor, construct a key event from a string.
bool empty () const
 Check if this KeyEvent is empty.
char get_ascii_code () const
 Get the ascii code of this key event.
ucs4_t get_unicode_code () const
 Get the Unicode code of this key event.
String get_key_string () const
 Get the string of this key event.
bool is_shift_down () const
 Check if the shift key is pressed down.
bool is_lock_down () const
 Check if the lock key is pressed down.
bool is_control_down () const
 Check if the ctrl key is pressed down.
bool is_alt_down () const
 Check if the alt key is pressed down.
bool is_mod1_down () const
 Check if the mod1 key is pressed down.
bool is_mod2_down () const
 Check if the mod2 key is pressed down.
bool is_mod3_down () const
 Check if the mod3 key is pressed down.
bool is_mod4_down () const
 Check if the mod4 key is pressed down.
bool is_mod5_down () const
 Check if the mod5 key is pressed down.
bool is_num_lock_down () const
 Check if the num lock key is pressed down.
bool is_caps_lock_down () const
 Check if the caps lock key is pressed down.
bool is_scroll_lock_down () const
 Check if the scroll lock key is pressed down.
bool is_key_press () const
 Check if it's a key press event.
bool is_key_release () const
 Check if it's a key release event.
bool operator== (const KeyEvent &key) const
 Compare two key events.
bool operator< (const KeyEvent &key) const
 Compare two key events.

Public Attributes

uint32 code
uint16 mask
uint16 layout


Detailed Description

The class to store a keyboard event.

A keyboard event contains a key code and a set of key masks. The key masks indicate which modifier keys are pressed down and if it's a key release event.


Constructor & Destructor Documentation

scim::KeyEvent::KeyEvent uint32  c = 0,
uint16  m = 0,
uint16  l = 0
[inline]
 

Default constructor.

Parameters:
c - the key code.
m - the key masks.

scim::KeyEvent::KeyEvent const String str  )  [inline]
 

Constructor, construct a key event from a string.

Parameters:
str the key string, eg. "Control+space"


Member Function Documentation

bool scim::KeyEvent::empty  )  const [inline]
 

Check if this KeyEvent is empty.

Returns:
true if this is a empty event.

char scim::KeyEvent::get_ascii_code  )  const
 

Get the ascii code of this key event.

Not all key events have ascii codes.

Returns:
the ascii code of this key event. Zero means no ascii code.

ucs4_t scim::KeyEvent::get_unicode_code  )  const
 

Get the Unicode code of this key event.

Not all key events have unicode codes.

Returns:
The Unicode code of this key event. Zero means no unicode code.

String scim::KeyEvent::get_key_string  )  const
 

Get the string of this key event.

Not all key events can be converted to string.

Returns:
The string of this key event.

bool scim::KeyEvent::is_shift_down  )  const [inline]
 

Check if the shift key is pressed down.

bool scim::KeyEvent::is_lock_down  )  const [inline]
 

Check if the lock key is pressed down.

bool scim::KeyEvent::is_control_down  )  const [inline]
 

Check if the ctrl key is pressed down.

bool scim::KeyEvent::is_alt_down  )  const [inline]
 

Check if the alt key is pressed down.

bool scim::KeyEvent::is_mod1_down  )  const [inline]
 

Check if the mod1 key is pressed down.

bool scim::KeyEvent::is_mod2_down  )  const [inline]
 

Check if the mod2 key is pressed down.

bool scim::KeyEvent::is_mod3_down  )  const [inline]
 

Check if the mod3 key is pressed down.

bool scim::KeyEvent::is_mod4_down  )  const [inline]
 

Check if the mod4 key is pressed down.

bool scim::KeyEvent::is_mod5_down  )  const [inline]
 

Check if the mod5 key is pressed down.

bool scim::KeyEvent::is_num_lock_down  )  const [inline]
 

Check if the num lock key is pressed down.

bool scim::KeyEvent::is_caps_lock_down  )  const [inline]
 

Check if the caps lock key is pressed down.

bool scim::KeyEvent::is_scroll_lock_down  )  const [inline]
 

Check if the scroll lock key is pressed down.

bool scim::KeyEvent::is_key_press  )  const [inline]
 

Check if it's a key press event.

bool scim::KeyEvent::is_key_release  )  const [inline]
 

Check if it's a key release event.

bool scim::KeyEvent::operator== const KeyEvent key  )  const [inline]
 

Compare two key events.

Returns:
true if they are equal.

bool scim::KeyEvent::operator< const KeyEvent key  )  const [inline]
 

Compare two key events.

This operator is mainly for sorting.

Returns:
true if the first is smaller.


Member Data Documentation

uint32 scim::KeyEvent::code
 

key code

uint16 scim::KeyEvent::mask
 

modifier keys' mask

uint16 scim::KeyEvent::layout
 

keyboard layout identifier


The documentation for this struct was generated from the following file:
Generated on Tue Apr 26 02:11:19 2005 for scim by  doxygen 1.4.1