ibustypes

Stability Level

Stable, unless otherwise indicated

Functions

void	(*IBusFreeFunc) ()

Types and Values

enum	IBusModifierType
enum	IBusCapabilite
enum	IBusPreeditFocusMode
enum	IBusOrientation
enum	IBusBusNameFlag
enum	IBusBusRequestNameReply
enum	IBusBusStartServiceByNameReply
enum	IBusError
struct	IBusRectangle

Object Hierarchy

    GEnum
    ╰── IBusOrientation
    GFlags
    ├── IBusCapabilite
    ╰── IBusModifierType

Description

This section consists generic types for IBus, including shift/control key modifiers, and a rectangle structure.

Functions

IBusFreeFunc ()

void
(*IBusFreeFunc) (gpointer object);

Free function prototype.

Parameters

object

object to be freed.

Types and Values

enum IBusModifierType

Handles key modifier such as control, shift and alt and release event. Note that nits 15 - 25 are currently unused, while bit 29 is used internally.

Members

IBUS_SHIFT_MASK	Shift is activated.
IBUS_LOCK_MASK	Cap Lock is locked.
IBUS_CONTROL_MASK	Control key is activated.
IBUS_MOD1_MASK	Modifier 1 (Usually Alt_L (0x40), Alt_R (0x6c), Meta_L (0xcd)) activated.
IBUS_MOD2_MASK	Modifier 2 (Usually Num_Lock (0x4d)) activated.
IBUS_MOD3_MASK	Modifier 3 activated.
IBUS_MOD4_MASK	Modifier 4 (Usually Super_L (0xce), Hyper_L (0xcf)) activated.
IBUS_MOD5_MASK	Modifier 5 (ISO_Level3_Shift (0x5c), Mode_switch (0xcb)) activated.
IBUS_BUTTON1_MASK	Mouse button 1 (left) is activated.
IBUS_BUTTON2_MASK	Mouse button 2 (middle) is activated.
IBUS_BUTTON3_MASK	Mouse button 3 (right) is activated.
IBUS_BUTTON4_MASK	Mouse button 4 (scroll up) is activated.
IBUS_BUTTON5_MASK	Mouse button 5 (scroll down) is activated.
IBUS_HANDLED_MASK	Handled mask indicates the event has been handled by ibus.
IBUS_FORWARD_MASK	Forward mask indicates the event has been forward from ibus.
IBUS_IGNORED_MASK	It is an alias of IBUS_FORWARD_MASK.
IBUS_SUPER_MASK	Super (Usually Win) key is activated.
IBUS_HYPER_MASK	Hyper key is activated.
IBUS_META_MASK	Meta key is activated.
IBUS_RELEASE_MASK	Key is released.
IBUS_MODIFIER_MASK	Modifier mask for the all the masks above.

enum IBusCapabilite

Capability flags of UI.

Members

IBUS_CAP_PREEDIT_TEXT	UI is capable to show pre-edit text.
IBUS_CAP_AUXILIARY_TEXT	UI is capable to show auxiliary text.
IBUS_CAP_LOOKUP_TABLE	UI is capable to show the lookup table.
IBUS_CAP_FOCUS	UI is capable to get focus.
IBUS_CAP_PROPERTY	UI is capable to have property.
IBUS_CAP_SURROUNDING_TEXT	Client can provide surround text, or IME can handle surround text.

enum IBusPreeditFocusMode

Pre-edit commit mode when the focus is lost.

Members

IBUS_ENGINE_PREEDIT_CLEAR	pre-edit text is cleared.
IBUS_ENGINE_PREEDIT_COMMIT	pre-edit text is committed.

enum IBusOrientation

Orientation of UI.

Members

IBUS_ORIENTATION_HORIZONTAL	Horizontal orientation.
IBUS_ORIENTATION_VERTICAL	Vertival orientation.
IBUS_ORIENTATION_SYSTEM	Use ibus global orientation setup.

enum IBusBusNameFlag

Members

IBUS_BUS_NAME_FLAG_ALLOW_REPLACEMENT	same as DBUS_NAME_FLAG_ALLOW_REPLACEMENT
IBUS_BUS_NAME_FLAG_REPLACE_EXISTING	same as DBUS_NAME_FLAG_REPLACE_EXISTING
IBUS_BUS_NAME_FLAG_DO_NOT_QUEUE	same as DBUS_NAME_FLAG_DO_NOT_QUEUE

enum IBusBusRequestNameReply

Members

IBUS_BUS_REQUEST_NAME_REPLY_PRIMARY_OWNER	same as DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
IBUS_BUS_REQUEST_NAME_REPLY_IN_QUEUE	same as DBUS_REQUEST_NAME_REPLY_IN_QUEUE
IBUS_BUS_REQUEST_NAME_REPLY_EXISTS	same as DBUS_REQUEST_NAME_REPLY_EXISTS
IBUS_BUS_REQUEST_NAME_REPLY_ALREADY_OWNER	same as DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER

enum IBusBusStartServiceByNameReply

Members

IBUS_BUS_START_REPLY_SUCCESS	same as DBUS_START_REPLY_SUCCESS
IBUS_BUS_START_REPLY_ALREADY_RUNNING	same as DBUS_START_REPLY_ALREADY_RUNNING

enum IBusError

Members

IBUS_ERROR_NO_ENGINE

There is no engine associated with input context.

struct IBusRectangle

struct IBusRectangle {
    gint x;
    gint y;
    gint width;
    gint height;
};

Rectangle definition.

Members

gint `x`;	x coordinate.
gint `y`;	y coordinate.
gint `width`;	width of the rectangle.
gint `height`;	height of the renctangl.