Enums

Details

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.

HINT = 4

Use the preedit hint and each engine does not specify the RGBA values but IBus panel or the Wayland panel decides the actual values.

New in version 1.5.33.

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. Workaround of “transfer none” for IBus.AttrList.append().

Deprecated since version 1.5.33: Use IBus.attr_hint_new().

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.EngineMsgCode(value)

Bases: GObject.GEnum

Message codes in the IBusMessageDomain domain for Engine See also IBus.Message, IBus.Engine.send_message()

New in version 1.5.33.

GENERAL = 0

Generic message for Engine

INVALID_COMPOSE_SEQUENCE = 1

User’s typing failure against the definition of the compose files.

UPDATE_COMPOSE_TABLE = 2

Notification about new behaviors or attentions when the compose table version is changed.

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.MessageDomain(value)

Bases: GObject.GEnum

New in version 1.5.33.

NONE = 0
ENGINE = 1
PANEL = 2
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.PanelServiceMsgCode(value)

Bases: GObject.GEnum

Message codes in the IBusMessageDomain domain for Panel.

New in version 1.5.33.

GENERAL = 0

Generic message for Panel

LOADING_UNICODE = 1

Progress message when the Unicode data is loading.

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.PreeditFormat(value)

Bases: GObject.GEnum

You can set the “preedit-format” property of the constructor of IBus.InputContext or IBus.PanelService.

New in version 1.5.33.

RGBA = 0

Use IBus.Attribute with the RGBA. This has been a default usage and IBus.Attribute.get_attr_type() returns IBus.AttrType.UNDERLINE, IBus.AttrType.FOREGROUND, IBus.AttrType.BACKGROUND.

HINT = 1

Use IBus.Attribute with the hints. This let IBus.PanelService decides the actual RGBA values to follow the current desktop theme and IBus.Attribute.get_attr_type() returns IBus.AttrType.HINT.

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