SkkKeyEventFilter: Reference Manual

SkkKeyEventFilter

SkkKeyEventFilter — Base class of a key event filter.

Functions

SkkKeyEvent *	skk_key_event_filter_filter_key_event ()
void	skk_key_event_filter_reset ()

Signals

void

forwarded

Run Last

Types and Values

#define	SKK_TYPE_KEY_EVENT_FILTER
struct	SkkKeyEventFilter
struct	SkkKeyEventFilterClass

Object Hierarchy

    GObject
    ╰── SkkKeyEventFilter
        ╰── SkkNicolaKeyEventFilter

Description

Functions

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.

Parameters

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.

Parameters

self

the SkkKeyEventFilter instance

Types and Values

SKK_TYPE_KEY_EVENT_FILTER

#define SKK_TYPE_KEY_EVENT_FILTER (skk_key_event_filter_get_type ())

The type for SkkKeyEventFilter.

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.

Members

`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)

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

Parameters

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.

Flags: Run Last