SkkKeyEventFilter

SkkKeyEventFilter — Base class of a key event filter.

Synopsis

#define             SKK_TYPE_KEY_EVENT_FILTER
SkkKeyEvent *       skk_key_event_filter_filter_key_event
                                                        (SkkKeyEventFilter *self,
                                                         SkkKeyEvent *key);
void                skk_key_event_filter_reset          (SkkKeyEventFilter *self);
struct              SkkKeyEventFilter;
struct              SkkKeyEventFilterClass;

Object Hierarchy

  GObject
   +----SkkKeyEventFilter
         +----SkkNicolaKeyEventFilter

Signals

  "forwarded"                                      : Run Last

Description

Details

SKK_TYPE_KEY_EVENT_FILTER

#define SKK_TYPE_KEY_EVENT_FILTER (skk_key_event_filter_get_type ())

The type for SkkKeyEventFilter.


skk_key_event_filter_filter_key_event ()

SkkKeyEvent *       skk_key_event_filter_filter_key_event
                                                        (SkkKeyEventFilter *self,
                                                         SkkKeyEvent *key);

Convert a key event to another.

self :

the SkkKeyEventFilter instance

key :

a key event. [in]

Returns :

a KeyEvent or `null` if the result cannot be fetched immediately

skk_key_event_filter_reset ()

void                skk_key_event_filter_reset          (SkkKeyEventFilter *self);

Reset the filter.

self :

the SkkKeyEventFilter instance

struct SkkKeyEventFilter

struct SkkKeyEventFilter;

Base class of a key event filter.


struct SkkKeyEventFilterClass

struct SkkKeyEventFilterClass {
	GObjectClass parent_class;
	SkkKeyEvent* (*filter_key_event) (SkkKeyEventFilter* self, SkkKeyEvent* key);
	void (*reset) (SkkKeyEventFilter* self);
};

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

GObjectClass parent_class;

the parent class structure

filter_key_event ()

virtual method called by skk_key_event_filter_filter_key_event()

reset ()

virtual method called by skk_key_event_filter_reset()

Signal Details

The "forwarded" signal

void                user_function                      (SkkKeyEventFilter *key_event_filter,
                                                        SkkKeyEvent       *key,
                                                        gpointer           user_data)             : Run Last

Signal emitted when a new key event is generated in the filter.

key_event_filter :

the SkkKeyEventFilter instance that received the signal

key :

a key event

user_data :

user data set when the signal handler was connected.