Events: Nimf Reference Manual

Functions

NimfEvent *	nimf_event_new ()
void	nimf_event_free ()
gboolean	nimf_event_matches ()
guint	nimf_event_keycode_to_qwerty_keyval ()

NimfEvent *
nimf_event_new (NimfEventType type);

Creates a new event of the given type. All fields are set to 0.

type

a new NimfEvent, which should be freed with nimf_event_free().

void
nimf_event_free (NimfEvent *event);

Frees event .

event

gboolean
nimf_event_matches (NimfEvent *event,
                    const NimfKey **keys);

Checks if event matches one of the keys .

event	a NimfEvent
keys	a `NULL`-terminated array of NimfKey

TRUE if a match was found.

guint
nimf_event_keycode_to_qwerty_keyval (const NimfEvent *event);

Converts event to qwerty keyval. Use only for PC keyboards.

event

the guint value

NIMF_EVENT_NOTHING	a special code to indicate a null event.
NIMF_EVENT_KEY_PRESS	a key has been pressed.
NIMF_EVENT_KEY_RELEASE	a key has been released.

struct NimfEventKey {
  NimfEventType type;
  guint32       state;
  guint32       keyval;
  guint32       hardware_keycode;
};

Describes a key press or key release event.

NimfEventType `type`;	the type of the event (`NIMF_EVENT_KEY_PRESS` or `NIMF_EVENT_KEY_RELEASE`).
guint32 `state`;	a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See NimfModifierType.	[type NimfModifierType]
guint32 `keyval`;	the key that was pressed or released. See the `nimf-key-syms.h` header file for a complete list of Nimf key codes.
guint32 `hardware_keycode`;	the raw code of the key that was pressed or released.

A NimfEvent contains a union.

NimfEventType `type`;	a NimfEventType
NimfEventKey `key`;	a NimfEventKey