Enums

Details

class IBus.AttrPreedit(value)

Bases: GObject.GEnum

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.

NONE = 1

Style should be the same as in non-composing text.

WHOLE = 2

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

SELECTION = 3

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

PREDICTION = 4

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

PREFIX = 5

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

SUFFIX = 6

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

ERROR_SPELLING = 7

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 = 8

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

class IBus.AttrType(value)

Bases: GObject.GEnum

Type enumeration of IBus.Text attribute.

UNDERLINE = 1

Decorate with underline.

FOREGROUND = 2

Foreground color.

BACKGROUND = 3

Background color.

class IBus.AttrUnderline(value)

Bases: GObject.GEnum

Type of IBus.Text attribute.

classmethod new(underline_type, start_index, end_index)
Parameters:

  • underline_type (int) – Type of underline.

  • start_index (int) – Where attribute starts.

  • end_index (int) – Where attribute ends.

Returns:

A newly allocated IBus.Attribute.

Return type:

IBus.Attribute

Creates a new underline IBus.Attribute.

NONE = 0

No underline.

SINGLE = 1

Single underline.

DOUBLE = 2

Double underline.

LOW = 3

Low underline ? FIXME

ERROR = 4

Error underline

class IBus.BusGlobalBindingType(value)

Bases: GObject.GEnum

Type enumeration of IBus.BusGlobalBindingType.

New in version 1.5.29.

ANY = 0

Any types

IME_SWITCHER = 1

IME switcher

EMOJI_TYPING = 2

Emoji typing

class IBus.BusRequestNameReply(value)

Bases: GObject.GEnum

PRIMARY_OWNER = 1

same as DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER

IN_QUEUE = 2

same as DBUS_REQUEST_NAME_REPLY_IN_QUEUE

EXISTS = 3

same as DBUS_REQUEST_NAME_REPLY_EXISTS

ALREADY_OWNER = 4

same as DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER

class IBus.BusStartServiceByNameReply(value)

Bases: GObject.GEnum

SUCCESS = 1

same as DBUS_START_REPLY_SUCCESS

ALREADY_RUNNING = 2

same as DBUS_START_REPLY_ALREADY_RUNNING

class IBus.Error(value)

Bases: GObject.GEnum

classmethod quark()
Return type:

int

NO_ENGINE = 0

There is no engine associated with input context.

NO_CONFIG = 1

There is no config module running.

FAILED = 2

General failure.

class IBus.InputPurpose(value)

Bases: GObject.GEnum

Describes primary purpose of the input context. This information is particularly useful to implement intelligent behavior in engines, such as automatic input-mode switch and text prediction.

Note that the purpose is not meant to impose a totally strict rule about allowed characters, and does not replace input validation. It is fine for an on-screen keyboard to let the user override the character set restriction that is expressed by the purpose. The application is expected to validate the entry contents, even if it specified a purpose.

The difference between IBus.InputPurpose.DIGITS and IBus.InputPurpose.NUMBER is that the former accepts only digits while the latter also some punctuation (like commas or points, plus, minus) and “e” or “E” as in 3.14E+000.

This enumeration may be extended in the future; engines should interpret unknown values as ‘free form’.

New in version 1.5.4.

FREE_FORM = 0

Allow any character

ALPHA = 1

Allow only alphabetic characters

TERMINAL = 10

Allow any character, in addition to control codes.

New in version 1.5.24.

DIGITS = 2

Allow only digits

NUMBER = 3

Edited field expects numbers

PHONE = 4

Edited field expects phone number

URL = 5

Edited field expects URL

EMAIL = 6

Edited field expects email address

NAME = 7

Edited field expects the name of a person

PASSWORD = 8

Like IBus.InputPurpose.FREE_FORM, but characters are hidden

PIN = 9

Like IBus.InputPurpose.DIGITS, but characters are hidden

class IBus.Orientation(value)

Bases: GObject.GEnum

Orientation of UI.

HORIZONTAL = 0

Horizontal orientation.

VERTICAL = 1

Vertival orientation.

SYSTEM = 2

Use ibus global orientation setup.

class IBus.PreeditFocusMode(value)

Bases: GObject.GEnum

Pre-edit commit mode when the focus is lost.

CLEAR = 0

pre-edit text is cleared.

COMMIT = 1

pre-edit text is committed.

class IBus.PropState(value)

Bases: GObject.GEnum

State of IBus.Property. The actual effect depends on IBus.PropType of the IBus.Property.

IBus.PropType.TOGGLE

Emphasized if IBus.PropState.CHECKED, normal otherwise.

IBus.PropType.RADIO

Option checked if IBus.PropState.CHECKED, unchecked otherwise.

No effect on other types.

UNCHECKED = 0

Property option is unchecked.

CHECKED = 1

Property option is checked.

INCONSISTENT = 2

The state is inconsistent with the associated IME property.

class IBus.PropType(value)

Bases: GObject.GEnum

Type enumeration of IBus.Property.

NORMAL = 0

Property is shown as normal text.

TOGGLE = 1

Property is shown as a toggle button.

RADIO = 2

Property is shown as a radio selection option.

MENU = 3

Property is shown as a menu, usually imply it has sub menu items.

SEPARATOR = 4

A separator for menu.

class IBus.XEventType(value)

Bases: GObject.GEnum

NOTHING = -1
KEY_PRESS = 0
KEY_RELEASE = 1
OTHER = 2
EVENT_LAST = 3