Flags

Details

class IBus.AttrPreedit(value)

Bases: GObject.GFlags

Type of Pre-edit style as the semantic name. The Wayland specs prefers to express the semantic values rather than RGB values and text-input protocol version 1 defines some values: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/unstable/text-input/text-input-unstable-v1.xml?ref_type=heads#L251

IBus compiled the values for major input method engines: https://github.com/ibus/ibus/wiki/Wayland-Colors

New in version 1.5.29.

DEFAULT = 0

Default style for composing text and used in the internal logic only with the Wayland text-input protocol V1. Each IBus.Engine should not use it with IBus.attr_hint_new().

WHOLE = 1

Most language engines wish to draw underline in the typed whole preedit string except for the prediction string. (Chinese, Japanese, Typing-booster)

SELECTION = 2

Modifying an active segment is distinguished against whole the preedit text. (Hangul, Japanese)

NONE = 256

Designed for non-composing text with the Wayland text-input protocol V1 but this is deprecated.

PREDICTION = 3

A prediction string can be appended after the typed string. (Typing-booster)

PREFIX = 4

A prefix string can be an informative color. (Table)

SUFFIX = 5

A suffix string can be an informative color. (Table)

ERROR_SPELLING = 6

An detected typo could be an error color with a spelling check or the word could not be found in a dictionary. The underline color also might be more visible. (Typing-booster, Table)

ERROR_COMPOSE = 7

A wrong compose key could be an error color. (Typing-booster)

class IBus.BusNameFlag(value)

Bases: GObject.GFlags

ALLOW_REPLACEMENT = 1

same as DBUS_NAME_FLAG_ALLOW_REPLACEMENT

REPLACE_EXISTING = 2

same as DBUS_NAME_FLAG_REPLACE_EXISTING

DO_NOT_QUEUE = 4

same as DBUS_NAME_FLAG_DO_NOT_QUEUE

class IBus.Capabilite(value)

Bases: GObject.GFlags

Capability flags of UI.

PREEDIT_TEXT = 1

UI is capable to show pre-edit text.

SYNC_PROCESS_KEY = 128

Asynchronous process key events are not supported and the IBus.Engine.forward_key_event() should not be used for the return value of #IBusEngine::process_key_event().

SYNC_PROCESS_KEY_V2 = 128
PROPERTY = 16

UI is capable to have property.

AUXILIARY_TEXT = 2

UI is capable to show auxiliary text.

SURROUNDING_TEXT = 32

Client can provide surround text, or IME can handle surround text.

LOOKUP_TABLE = 4

UI is capable to show the lookup table.

OSK = 64

UI is owned by on-screen keyboard.

FOCUS = 8

UI is capable to get focus.

class IBus.InputHints(value)

Bases: GObject.GFlags

Describes hints that might be taken into account by engines. Note that engines may already tailor their behaviour according to the IBus.InputPurpose of the entry.

Some common sense is expected when using these flags - mixing IBus.InputHints.LOWERCASE with any of the uppercase hints makes no sense.

This enumeration may be extended in the future; engines should ignore unknown values.

New in version 1.5.4.

NONE = 0

No special behaviour suggested

SPELLCHECK = 1

Suggest checking for typos

NO_EMOJI = 1024

Suggest not offering Emoji support.

New in version 1.5.24.

INHIBIT_OSK = 128

Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).

UPPERCASE_CHARS = 16

Suggest to capitalize all text

NO_SPELLCHECK = 2

Suggest not checking for typos

PRIVATE = 2048

Request that the input method should not update personalized data (like typing history).

New in version 1.5.26.

VERTICAL_WRITING = 256

The text is vertical.

New in version 1.5.11.

UPPERCASE_WORDS = 32

Suggest to capitalize the first character of each word

WORD_COMPLETION = 4

Suggest word completion

EMOJI = 512

Suggest offering Emoji support.

New in version 1.5.24.

UPPERCASE_SENTENCES = 64

Suggest to capitalize the first word of each sentence

LOWERCASE = 8

Suggest to convert all text to lowercase

class IBus.ModifierType(value)

Bases: GObject.GFlags

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_MASK = 1

Shift is activated.

BUTTON3_MASK = 1024

Mouse button 3 (right) is activated.

RELEASE_MASK = 1073741824

Key is released.

MOD5_MASK = 128

Modifier 5 (ISO_Level3_Shift (0x5c), Mode_switch (0xcb)) activated.

HYPER_MASK = 134217728

Hyper key is activated.

MODIFIER_MASK = 1593843711

Modifier mask for the all the masks above.

MOD2_MASK = 16

Modifier 2 (Usually Num_Lock (0x4d)) activated.

HANDLED_MASK = 16777216

Handled mask indicates the event has been handled by ibus.

LOCK_MASK = 2

Cap Lock is locked.

BUTTON4_MASK = 2048

Mouse button 4 (scroll up) is activated.

BUTTON1_MASK = 256

Mouse button 1 (left) is activated.

META_MASK = 268435456

Meta key is activated.

MOD3_MASK = 32

Modifier 3 activated.

FORWARD_MASK = 33554432

Forward mask indicates the event has been forward from ibus.

IGNORED_MASK = 33554432

It is an alias of IBus.ModifierType.FORWARD_MASK.

CONTROL_MASK = 4

Control key is activated.

BUTTON5_MASK = 4096

Mouse button 5 (scroll down) is activated.

BUTTON2_MASK = 512

Mouse button 2 (middle) is activated.

MOD4_MASK = 64

Modifier 4 (Usually Super_L (0xce), Hyper_L (0xcf)) activated.

SUPER_MASK = 67108864

Super (Usually Win) key is activated.

MOD1_MASK = 8

Modifier 1 (Usually Alt_L (0x40), Alt_R (0x6c), Meta_L (0xcd)) activated.

class IBus.ObjectFlags(value)

Bases: GObject.GFlags

The flags are used internally.

IN_DESTRUCTION = 1

Used in GObjectClass::dispose

DESTROYED = 2

Used during emitting IBus.Object ::destroy signal.

RESERVED_1 = 4

Reserved.

RESERVED_2 = 8

Reserved.