SkkKeyEvent

SkkKeyEvent — Object representing a key event.

Synopsis

#define             SKK_TYPE_KEY_EVENT
SkkKeyEvent *       skk_key_event_copy                  (SkkKeyEvent *self);
gchar *             skk_key_event_to_string             (SkkKeyEvent *self);
gboolean            skk_key_event_base_equal            (SkkKeyEvent *self,
                                                         SkkKeyEvent *key);
SkkKeyEvent *       skk_key_event_new                   (const gchar *name,
                                                         gunichar code,
                                                         SkkModifierType modifiers);
SkkKeyEvent *       skk_key_event_new_from_string       (const gchar *key,
                                                         GError **error);
SkkKeyEvent *       skk_key_event_new_from_x_keysym     (guint keyval,
                                                         SkkModifierType modifiers,
                                                         GError **error);
const gchar *       skk_key_event_get_name              (SkkKeyEvent *self);
gunichar            skk_key_event_get_code              (SkkKeyEvent *self);
SkkModifierType     skk_key_event_get_modifiers         (SkkKeyEvent *self);
void                skk_key_event_set_modifiers         (SkkKeyEvent *self,
                                                         SkkModifierType value);
struct              SkkKeyEvent;
struct              SkkKeyEventClass;
enum                SkkModifierType;
enum                SkkKeyEventFormatError;

Object Hierarchy

  GObject
   +----SkkKeyEvent
  GEnum
   +----SkkModifierType

Properties

  "code"                     guint                 : Read
  "modifiers"                SkkModifierType       : Read / Write
  "name"                     gchar*                : Read

Description

Details

SKK_TYPE_KEY_EVENT

#define SKK_TYPE_KEY_EVENT (skk_key_event_get_type ())

The type for SkkKeyEvent.


skk_key_event_copy ()

SkkKeyEvent *       skk_key_event_copy                  (SkkKeyEvent *self);

Create a copy of the key event.

self :

the SkkKeyEvent instance

Returns :

a new KeyEvent

skk_key_event_to_string ()

gchar *             skk_key_event_to_string             (SkkKeyEvent *self);

Convert the KeyEvent to string.

self :

the SkkKeyEvent instance

Returns :

a string representing the KeyEvent

skk_key_event_base_equal ()

gboolean            skk_key_event_base_equal            (SkkKeyEvent *self,
                                                         SkkKeyEvent *key);

Compare two key events ignoring modifiers.

self :

the SkkKeyEvent instance

key :

a KeyEvent. [in]

Returns :

`true` if those base components are equal, `false` otherwise

skk_key_event_new ()

SkkKeyEvent *       skk_key_event_new                   (const gchar *name,
                                                         gunichar code,
                                                         SkkModifierType modifiers);

Create a key event.

name :

a key name. [in][allow-none]

code :

a character code. [in]

modifiers :

state of modifier keys. [in]

Returns :

a new KeyEvent

skk_key_event_new_from_string ()

SkkKeyEvent *       skk_key_event_new_from_string       (const gchar *key,
                                                         GError **error);

Create a key event from string.

key :

a string representation of a key event. [in]

error :

location to store the error occuring, or NULL to ignore. [error-domains SkkKeyEventFormatError]

Returns :

a new KeyEvent

skk_key_event_new_from_x_keysym ()

SkkKeyEvent *       skk_key_event_new_from_x_keysym     (guint keyval,
                                                         SkkModifierType modifiers,
                                                         GError **error);

Create a key event from an X keysym and modifiers.

keyval :

an X keysym. [in]

modifiers :

modifier mask. [in]

error :

location to store the error occuring, or NULL to ignore. [error-domains SkkKeyEventFormatError]

Returns :

a new KeyEvent

skk_key_event_get_name ()

const gchar *       skk_key_event_get_name              (SkkKeyEvent *self);

Get and return the current value of the "name" property.

self :

the SkkKeyEvent instance to query

Returns :

the value of the "name" property

skk_key_event_get_code ()

gunichar            skk_key_event_get_code              (SkkKeyEvent *self);

Get and return the current value of the "code" property.

self :

the SkkKeyEvent instance to query

Returns :

the value of the "code" property

skk_key_event_get_modifiers ()

SkkModifierType     skk_key_event_get_modifiers         (SkkKeyEvent *self);

Get and return the current value of the "modifiers" property.

self :

the SkkKeyEvent instance to query

Returns :

the value of the "modifiers" property

skk_key_event_set_modifiers ()

void                skk_key_event_set_modifiers         (SkkKeyEvent *self,
                                                         SkkModifierType value);

Set the value of the "modifiers" property to value.

self :

the SkkKeyEvent instance to modify

value :

the new value of the "modifiers" property

struct SkkKeyEvent

struct SkkKeyEvent;

Object representing a key event.


struct SkkKeyEventClass

struct SkkKeyEventClass {
	GObjectClass parent_class;
};

The class structure for SKK_TYPE_KEY_EVENT. All the fields in this structure are private and should never be accessed directly.

GObjectClass parent_class;

the parent class structure

enum SkkModifierType

typedef enum {
	SKK_MODIFIER_TYPE_NONE = 0,
	SKK_MODIFIER_TYPE_SHIFT_MASK = 1 << 0,
	SKK_MODIFIER_TYPE_LOCK_MASK = 1 << 1,
	SKK_MODIFIER_TYPE_CONTROL_MASK = 1 << 2,
	SKK_MODIFIER_TYPE_MOD1_MASK = 1 << 3,
	SKK_MODIFIER_TYPE_MOD2_MASK = 1 << 4,
	SKK_MODIFIER_TYPE_MOD3_MASK = 1 << 5,
	SKK_MODIFIER_TYPE_MOD4_MASK = 1 << 6,
	SKK_MODIFIER_TYPE_MOD5_MASK = 1 << 7,
	SKK_MODIFIER_TYPE_LSHIFT_MASK = 1 << 22,
	SKK_MODIFIER_TYPE_RSHIFT_MASK = 1 << 23,
	SKK_MODIFIER_TYPE_USLEEP_MASK = 1 << 24,
	SKK_MODIFIER_TYPE_SUPER_MASK = 1 << 26,
	SKK_MODIFIER_TYPE_HYPER_MASK = 1 << 27,
	SKK_MODIFIER_TYPE_META_MASK = 1 << 28,
	SKK_MODIFIER_TYPE_RELEASE_MASK = 1 << 30
} SkkModifierType;

A set of bit-flags to indicate the state of modifier keys.


enum SkkKeyEventFormatError

typedef enum {
	SKK_KEY_EVENT_FORMAT_ERROR_PARSE_FAILED,
	SKK_KEY_EVENT_FORMAT_ERROR_KEYSYM_NOT_FOUND
} SkkKeyEventFormatError;

Property Details

The "code" property

  "code"                     guint                 : Read

The base code of the KeyEvent.

This is exclusive to "name".

Default value: 0


The "modifiers" property

  "modifiers"                SkkModifierType       : Read / Write

Modifier mask.

Default value: SKK_MODIFIER_TYPE_NONE


The "name" property

  "name"                     gchar*                : Read

The base name of the KeyEvent.

This is exclusive to "code".

Default value: NULL