| IBus Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
enum IBusModifierType;
enum IBusCapabilite;
enum IBusPreeditFocusMode;
enum IBusOrientation;
IBusRectangle;
void (*IBusFreeFunc) (gpointer object);
This section consists generic types for IBus, including shift/control key modifiers, and a rectangle structure.
typedef enum
{
IBUS_SHIFT_MASK = 1 << 0,
IBUS_LOCK_MASK = 1 << 1,
IBUS_CONTROL_MASK = 1 << 2,
IBUS_MOD1_MASK = 1 << 3,
IBUS_MOD2_MASK = 1 << 4,
IBUS_MOD3_MASK = 1 << 5,
IBUS_MOD4_MASK = 1 << 6,
IBUS_MOD5_MASK = 1 << 7,
IBUS_BUTTON1_MASK = 1 << 8,
IBUS_BUTTON2_MASK = 1 << 9,
IBUS_BUTTON3_MASK = 1 << 10,
IBUS_BUTTON4_MASK = 1 << 11,
IBUS_BUTTON5_MASK = 1 << 12,
/* The next few modifiers are used by XKB, so we skip to the end.
* Bits 15 - 23 are currently unused. Bit 29 is used internally.
*/
/* ibus mask */
IBUS_HANDLED_MASK = 1 << 24,
IBUS_FORWARD_MASK = 1 << 25,
IBUS_IGNORED_MASK = IBUS_FORWARD_MASK,
IBUS_SUPER_MASK = 1 << 26,
IBUS_HYPER_MASK = 1 << 27,
IBUS_META_MASK = 1 << 28,
IBUS_RELEASE_MASK = 1 << 30,
IBUS_MODIFIER_MASK = 0x5f001fff
} 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.
| Shift is activated. | |
| Cap Lock is locked. | |
| Control key is activated. | |
| Modifier 1 (Usually Alt_L (0x40), Alt_R (0x6c), Meta_L (0xcd)) activated. | |
| Modifier 2 (Usually Num_Lock (0x4d)) activated. | |
| Modifier 3 activated. | |
| Modifier 4 (Usually Super_L (0xce), Hyper_L (0xcf)) activated. | |
| Modifier 5 (ISO_Level3_Shift (0x5c), Mode_switch (0xcb)) activated. | |
| Mouse button 1 (left) is activated. | |
| Mouse button 2 (middle) is activated. | |
| Mouse button 3 (right) is activated. | |
| Mouse button 4 (scroll up) is activated. | |
| Mouse button 5 (scroll down) is activated. | |
| Handled mask indicates the event has been handled by ibus. | |
| Forward mask indicates the event has been forward from ibus. | |
| It is an alias of IBUS_FORWARD_MASK. | |
| Super (Usually Win) key is activated. | |
| Hyper key is activated. | |
| Meta key is activated. | |
| Key is released. | |
| Modifier mask for the all the masks above. |
typedef enum {
IBUS_CAP_PREEDIT_TEXT = 1 << 0,
IBUS_CAP_AUXILIARY_TEXT = 1 << 1,
IBUS_CAP_LOOKUP_TABLE = 1 << 2,
IBUS_CAP_FOCUS = 1 << 3,
IBUS_CAP_PROPERTY = 1 << 4,
IBUS_CAP_SURROUNDING_TEXT = 1 << 5,
} IBusCapabilite;
Capability flags of UI.
| UI is capable to show pre-edit text. | |
| UI is capable to show auxiliary text. | |
| UI is capable to show the lookup table. | |
| UI is capable to get focus. | |
| UI is capable to have property. | |
| Client can provide surround text, or IME can handle surround text. |
typedef enum {
IBUS_ENGINE_PREEDIT_CLEAR = 0,
IBUS_ENGINE_PREEDIT_COMMIT = 1,
} IBusPreeditFocusMode;
Pre-edit commit mode when the focus is lost.
typedef enum {
IBUS_ORIENTATION_HORIZONTAL = 0,
IBUS_ORIENTATION_VERTICAL = 1,
IBUS_ORIENTATION_SYSTEM = 2,
} IBusOrientation;
Orientation of UI.
typedef struct {
gint x;
gint y;
gint width;
gint height;
} IBusRectangle;
Rectangle definition.
void (*IBusFreeFunc) (gpointer object);
Free function prototype.
|
object to be freed. |