KkcKeyEventFilter: Reference Manual

KkcKeyEventFilter

KkcKeyEventFilter — Base class of a key event filter.

Functions

KkcKeyEvent *	kkc_key_event_filter_filter_key_event ()
void	kkc_key_event_filter_reset ()

Signals

void

forwarded

Run Last

Types and Values

#define	KKC_TYPE_KEY_EVENT_FILTER
struct	KkcKeyEventFilter
struct	KkcKeyEventFilterClass

Object Hierarchy

    GObject
    ╰── KkcKeyEventFilter
        ╰── KkcNicolaKeyEventFilter

Description

Functions

kkc_key_event_filter_filter_key_event ()

KkcKeyEvent *
kkc_key_event_filter_filter_key_event (KkcKeyEventFilter *self,
                                       KkcKeyEvent *key);

Convert a key event to another.

Parameters

self

the KkcKeyEventFilter instance

key

a key event

[in]

Returns

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

kkc_key_event_filter_reset ()

void
kkc_key_event_filter_reset (KkcKeyEventFilter *self);

Reset the filter.

Parameters

self

the KkcKeyEventFilter instance

Types and Values

KKC_TYPE_KEY_EVENT_FILTER

#define KKC_TYPE_KEY_EVENT_FILTER (kkc_key_event_filter_get_type ())

The type for KkcKeyEventFilter.

struct KkcKeyEventFilter

struct KkcKeyEventFilter;

Base class of a key event filter.

struct KkcKeyEventFilterClass

struct KkcKeyEventFilterClass {
	GObjectClass parent_class;
	KkcKeyEvent* (*filter_key_event) (KkcKeyEventFilter* self, KkcKeyEvent* key);
	void (*reset) (KkcKeyEventFilter* self);
};

The class structure for KKC_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 `kkc_key_event_filter_filter_key_event()`
`reset` ()	virtual method called by `kkc_key_event_filter_reset()`

Signal Details

The `“forwarded”` signal

void
user_function (KkcKeyEventFilter *key_event_filter,
               KkcKeyEvent       *key,
               gpointer           user_data)

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

Parameters

key_event_filter

the KkcKeyEventFilter instance that received the signal

key

a key event

user_data

user data set when the signal handler was connected.

Flags: Run Last