ibus_engine_new ()

IBusEngine *
ibus_engine_new (const gchar *engine_name,
                 const gchar *object_path,
                 GDBusConnection *connection);

Create a new IBusEngine.

ibus_engine_new_with_type ()

IBusEngine *
ibus_engine_new_with_type (GType engine_type,
                           const gchar *engine_name,
                           const gchar *object_path,
                           GDBusConnection *connection);

Create a new IBusEngine.

ibus_engine_commit_text ()

void
ibus_engine_commit_text (IBusEngine *engine,
                         IBusText *text);

Commit output of input method to IBus client.

(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_update_preedit_text ()

void
ibus_engine_update_preedit_text (IBusEngine *engine,
                                 IBusText *text,
                                 guint cursor_pos,
                                 gboolean visible);

Update the pre-edit buffer.

(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_update_preedit_text_with_mode ()

void
ibus_engine_update_preedit_text_with_mode
                               (IBusEngine *engine,
                                IBusText *text,
                                guint cursor_pos,
                                gboolean visible,
                                IBusPreeditFocusMode mode);

Update the pre-edit buffer with commit mode. Similar to ibus_engine_update_preedit_text(), this function allows users to specify the behavior on focus out when the pre-edit buffer is visible.

If mode is IBUS_ENGINE_PREEDIT_COMMIT, contents of the pre-edit buffer will be committed and cleared. If mode is IBUS_ENGINE_PREEDIT_CLEAR, contents of the pre-edit buffer will be cleared only.

(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_show_preedit_text ()

void
ibus_engine_show_preedit_text (IBusEngine *engine);

Show the pre-edit buffer.

ibus_engine_hide_preedit_text ()

void
ibus_engine_hide_preedit_text (IBusEngine *engine);

Hide the pre-edit buffer.

ibus_engine_update_auxiliary_text ()

void
ibus_engine_update_auxiliary_text (IBusEngine *engine,
                                   IBusText *text,
                                   gboolean visible);

Update the auxiliary bar.

(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_show_auxiliary_text ()

void
ibus_engine_show_auxiliary_text (IBusEngine *engine);

Show the auxiliary bar.

ibus_engine_hide_auxiliary_text ()

void
ibus_engine_hide_auxiliary_text (IBusEngine *engine);

Hide the auxiliary bar.

ibus_engine_update_lookup_table ()

void
ibus_engine_update_lookup_table (IBusEngine *engine,
                                 IBusLookupTable *lookup_table,
                                 gboolean visible);

Update the lookup table.

(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_update_lookup_table_fast ()

void
ibus_engine_update_lookup_table_fast (IBusEngine *engine,
                                      IBusLookupTable *lookup_table,
                                      gboolean visible);

Fast update for big lookup table.

If size of lookup table is not over table page size *4, then it calls ibus_engine_update_lookup_table().

(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_show_lookup_table ()

void
ibus_engine_show_lookup_table (IBusEngine *engine);

Show the lookup table.

ibus_engine_hide_lookup_table ()

void
ibus_engine_hide_lookup_table (IBusEngine *engine);

Hide the lookup table.

ibus_engine_forward_key_event ()

void
ibus_engine_forward_key_event (IBusEngine *engine,
                               guint keyval,
                               guint keycode,
                               guint state);

Forward the key event.

ibus_engine_register_properties ()

void
ibus_engine_register_properties (IBusEngine *engine,
                                 IBusPropList *prop_list);

Register and show properties in language bar.

(Note: The prop_list object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_update_property ()

void
ibus_engine_update_property (IBusEngine *engine,
                             IBusProperty *prop);

Update the state displayed in language bar.

(Note: The prop object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)

ibus_engine_delete_surrounding_text ()

void
ibus_engine_delete_surrounding_text (IBusEngine *engine,
                                     gint offset,
                                     guint nchars);

Delete surrounding text.

ibus_engine_get_surrounding_text ()

void
ibus_engine_get_surrounding_text (IBusEngine *engine,
                                  IBusText **text,
                                  guint *cursor_pos,
                                  guint *anchor_pos);

Get surrounding text.

It is also used to tell the input-context that the engine will utilize surrounding-text. In that case, it must be called in “enable” handler, with both text and cursor set to NULL.

See also: “set-surrounding-text”

ibus_engine_get_content_type ()

void
ibus_engine_get_content_type (IBusEngine *engine,
                              guint *purpose,
                              guint *hints);

Get content-type (primary purpose and hints) of the current input context.

See also: “set-content-type”

ibus_engine_get_name ()

const gchar *
ibus_engine_get_name (IBusEngine *engine);

Return the name of IBusEngine.

struct IBusEngine

struct IBusEngine {
    gboolean enabled;
    gboolean has_focus;

    /* cursor location */
    IBusRectangle cursor_area;
    guint client_capabilities;
};

IBusEngine properties.

The “engine-name” property

  “engine-name”              char *

engine name.

Owner: IBusEngine

Flags: Read / Write / Construct Only

Default value: "noname"

The “has-focus-id” property

  “has-focus-id”             gboolean

Has focus ID.

Owner: IBusEngine

Flags: Read / Write / Construct Only

Default value: FALSE

The “cancel-hand-writing” signal

void
user_function (IBusEngine *engine,
               guint       n_strokes,
               gpointer    user_data)

Emitted when a hand writing operation is cancelled. Implement the member function IBusEngineClass::cancel_hand_writing in extended class to receive this signal.

Flags: Run Last

The “candidate-clicked” signal

void
user_function (IBusEngine *engine,
               guint       index,
               guint       button,
               guint       state,
               gpointer    user_data)

Emitted when candidate on lookup table is clicked. Implement the member function IBusEngineClass::candidate_clicked in extended class to receive this signal.

Flags: Run Last

The “cursor-down” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the down cursor button is pressed. Implement the member function IBusEngineClass::cursor_down in extended class to receive this signal.

Flags: Run Last

The “cursor-up” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the up cursor button is pressed. Implement the member function IBusEngineClass::cursor_up in extended class to receive this signal.

Flags: Run Last

The “disable” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the IME is disabled. Implement the member function IBusEngineClass::disable in extended class to receive this signal.

See also: ibus_bus_set_global_engine().

Flags: Run Last

The “enable” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the IME is enabled. Implement the member function IBusEngineClass::enable in extended class to receive this signal.

See also: ibus_bus_set_global_engine().

Flags: Run Last

The “focus-in” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the client application get the focus. Implement the member function IBusEngineClass::focus_in in extended class to receive this signal.

See also: ibus_input_context_focus_in()

Flags: Run Last

The “focus-in-id” signal

void
user_function (IBusEngine *engine,
               char       *object_path,
               char       *client,
               gpointer    user_data)

Emitted when the client application get the focus. Implement the member function IBusEngineClass::focus_in in extended class to receive this signal. object_path is a unique id by input context. client indicates a client type: 'fake': focus is on desktop background or other programs where no input is possible 'xim': old X11 programs like xterm, emacs, ... GTK3 programs in a Gnome Xorg session when GTK_IM_MODULE is unset also use xim 'gtk-im:<client-name>': Gtk2 input module is used 'gtk3-im:<client-name>': Gtk3 input module is used 'gtk4-im:<client-name>': Gtk4 input module is used In case of the Gtk input modules, the name of the client is also shown after the “:”, for example like 'gtk3-im:firefox', 'gtk4-im:gnome-text-editor', … 'gnome-shell': Entries handled by gnome-shell (like the command line dialog opened with Alt+F2 or the search field when pressing the Super key.) When GTK_IM_MODULE is unset in a Gnome Wayland session all programs which would show 'gtk3-im' or 'gtk4-im' with GTK_IM_MODULE=ibus then show 'gnome-shell' instead. 'Qt': Qt4 programs like keepassx-2.0.3 … 'QIBusInputContext': Qt5 programs like keepassxc-2.7.1, anki-2.1.15 telegram-desktop-3.7.3,

You need to set “has-focus-id” property to TRUE when you construct an IBusEngine to use this class method.

See also: ibus_input_context_focus_in()

Flags: Run Last

The “focus-out” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the client application lost the focus. Implement the member function IBusEngineClass::focus_out in extended class to receive this signal.

See also: ibus_input_context_focus_out()

Flags: Run Last

The “focus-out-id” signal

void
user_function (IBusEngine *engine,
               char       *object_path,
               gpointer    user_data)

Emitted when the client application lost the focus. Implement the member function IBusEngineClass::focus_out in extended class to receive this signal. object_path is a unique id by input context. You need to set “has-focus-id” property to TRUE when you construct an IBusEngine to use this class method.

See also: ibus_input_context_focus_out()

Flags: Run Last

The “page-down” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the page-down button is pressed. Implement the member function IBusEngineClass::page_down in extended class to receive this signal.

Flags: Run Last

The “page-up” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the page-up button is pressed. Implement the member function IBusEngineClass::page_up in extended class to receive this signal.

Flags: Run Last

The “process-hand-writing-event” signal

void
user_function (IBusEngine *engine,
               gpointer    coordinates,
               guint       coordinates_len,
               gpointer    user_data)

Emitted when a hand writing operation is cancelled. Implement the member function IBusEngineClass::cancel_hand_writing in extended class to receive this signal.

Flags: Run Last

The “process-key-event” signal

gboolean
user_function (IBusEngine *engine,
               guint       keyval,
               guint       keycode,
               guint       state,
               gpointer    user_data)

Emitted when a key event is received. Implement the member function IBusEngineClass::process_key_event in extended class to receive this signal. Both the key symbol and keycode are passed to the member function. See ibus_input_context_process_key_event() for further explanation of key symbol, keycode and which to use.

Flags: Run Last

The “property-activate” signal

void
user_function (IBusEngine *engine,
               char       *name,
               guint       state,
               gpointer    user_data)

Emitted when a property is activated or change changed. Implement the member function IBusEngineClass::property_activate in extended class to receive this signal.

Flags: Run Last

The “property-hide” signal

void
user_function (IBusEngine *engine,
               char       *name,
               gpointer    user_data)

Emitted when a property is hidden. Implement the member function IBusEngineClass::property_hide in extended class to receive this signal.

Flags: Run Last

The “property-show” signal

void
user_function (IBusEngine *engine,
               char       *name,
               gpointer    user_data)

Emitted when a property is shown. Implement the member function IBusEngineClass::property_side in extended class to receive this signal.

Flags: Run Last

The “reset” signal

void
user_function (IBusEngine *engine,
               gpointer    user_data)

Emitted when the IME is reset. Implement the member function IBusEngineClass::reset in extended class to receive this signal.

See also: ibus_input_context_reset().

Flags: Run Last

The “set-capabilities” signal

void
user_function (IBusEngine *engine,
               guint       caps,
               gpointer    user_data)

Emitted when the client application capabilities is set. Implement the member function IBusEngineClass::set_capabilities in extended class to receive this signal.

See also: ibus_input_context_set_capabilities().

Flags: Run Last

The “set-content-type” signal

void
user_function (IBusEngine *engine,
               guint       purpose,
               guint       hints,
               gpointer    user_data)

Emitted when the client application content-type (primary purpose and hints) is set. The engine could change the behavior according to the content-type. Implement the member function IBusEngineClass::set_content_type in extended class to receive this signal.

For example, if the client application wants to restrict input to numbers, this signal will be emitted with purpose set to IBUS_INPUT_PURPOSE_NUMBER, so the engine can switch the input mode to latin.

Flags: Run Last

The “set-cursor-location” signal

void
user_function (IBusEngine *engine,
               int         x,
               int         y,
               int         w,
               int         h,
               gpointer    user_data)

Emitted when the location of IME is set. Implement the member function IBusEngineClass::set_cursor_location in extended class to receive this signal.

See also: ibus_input_context_set_cursor_location().

Flags: Run Last

The “set-surrounding-text” signal

void
user_function (IBusEngine *engine,
               GObject    *text,
               guint       cursor_pos,
               guint       anchor_pos,
               gpointer    user_data)

Emitted when a surrounding text is set. Implement the member function IBusEngineClass::set_surrounding_text in extended class to receive this signal. If anchor_pos equals to cursor_pos, it means "there are no selection" or "does not support selection retrival".

Flags: Run Last