IBus.Bus¶

Subclasses:: None

Methods¶

Inherited:: IBus.Object (2), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_async` ()
class	`new_async_client` ()
	`add_match` (rule)
	`add_match_async` (rule, timeout_msec, cancellable, callback, *user_data)
	`add_match_async_finish` (res)
	`create_input_context` (client_name)
	`create_input_context_async` (client_name, timeout_msec, cancellable, callback, *user_data)
	`create_input_context_async_finish` (res)
	`current_input_context` ()
	`current_input_context_async` (timeout_msec, cancellable, callback, *user_data)
	`current_input_context_async_finish` (res)
	`exit` (restart)
	`exit_async` (restart, timeout_msec, cancellable, callback, *user_data)
	`exit_async_finish` (res)
	`get_config` ()
	`get_connection` ()
	`get_engines_by_names` (names)
	`get_global_engine` ()
	`get_global_engine_async` (timeout_msec, cancellable, callback, *user_data)
	`get_global_engine_async_finish` (res)
	`get_ibus_property` (property_name)
	`get_ibus_property_async` (property_name, timeout_msec, cancellable, callback, *user_data)
	`get_ibus_property_async_finish` (res)
	`get_name_owner` (name)
	`get_name_owner_async` (name, timeout_msec, cancellable, callback, *user_data)
	`get_name_owner_async_finish` (res)
	`get_service_name` ()
	`get_use_global_engine` ()
	`get_use_global_engine_async` (timeout_msec, cancellable, callback, *user_data)
	`get_use_global_engine_async_finish` (res)
	`get_use_sys_layout` ()
	`get_use_sys_layout_async` (timeout_msec, cancellable, callback, *user_data)
	`get_use_sys_layout_async_finish` (res)
	`hello` ()
	`is_connected` ()
	`is_global_engine_enabled` ()
	`is_global_engine_enabled_async` (timeout_msec, cancellable, callback, *user_data)
	`is_global_engine_enabled_async_finish` (res)
	`list_active_engines` ()
	`list_active_engines_async` (timeout_msec, cancellable, callback, *user_data)
	`list_active_engines_async_finish` (res)
	`list_engines` ()
	`list_engines_async` (timeout_msec, cancellable, callback, *user_data)
	`list_engines_async_finish` (res)
	`list_names` ()
	`list_queued_owners` (name)
	`name_has_owner` (name)
	`name_has_owner_async` (name, timeout_msec, cancellable, callback, *user_data)
	`name_has_owner_async_finish` (res)
	`preload_engines` (names)
	`preload_engines_async` (names, timeout_msec, cancellable, callback, *user_data)
	`preload_engines_async_finish` (res)
	`register_component` (component)
	`register_component_async` (component, timeout_msec, cancellable, callback, *user_data)
	`register_component_async_finish` (res)
	`release_name` (name)
	`release_name_async` (name, timeout_msec, cancellable, callback, *user_data)
	`release_name_async_finish` (res)
	`remove_match` (rule)
	`remove_match_async` (rule, timeout_msec, cancellable, callback, *user_data)
	`remove_match_async_finish` (res)
	`request_name` (name, flags)
	`request_name_async` (name, flags, timeout_msec, cancellable, callback, *user_data)
	`request_name_async_finish` (res)
	`set_global_engine` (global_engine)
	`set_global_engine_async` (global_engine, timeout_msec, cancellable, callback, *user_data)
	`set_global_engine_async_finish` (res)
	`set_global_shortcut_keys` (gtype, keys)
	`set_global_shortcut_keys_async` (gtype, keys, timeout_msec, cancellable, callback, *user_data)
	`set_global_shortcut_keys_async_finish` (res)
	`set_ibus_property` (property_name, value)
	`set_ibus_property_async` (property_name, value, timeout_msec, cancellable, callback, *user_data)
	`set_ibus_property_async_finish` (res)
	`set_watch_dbus_signal` (watch)
	`set_watch_ibus_signal` (watch)

Virtual Methods¶

Inherited:: IBus.Object (1), GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`client-only`	`bool`	r/w/co	Client use only
`connect-async`	`bool`	r/w/co	Connect asynchronously to the bus

Signals¶

Inherited:: IBus.Object (1), GObject.Object (1)

Name	Short Description
`connected`	Emitted when `IBus.Bus` is connected to ibus-daemon.
`disconnected`	Emitted when `IBus.Bus` is disconnected from ibus-daemon.
`global-engine-changed`	Emitted when global engine is changed.
`global-shortcut-key-responded`	Emitted when global shortcut key is responded.
`name-owner-changed`	Emitted when D-Bus name owner is changed.

Fields¶

Inherited:: IBus.Object (1), GObject.Object (1)

Name	Type	Access	Description
parent	`IBus.Object`	r

Class Details¶

class IBus.Bus(**kwargs)¶

Bases:: IBus.Object
Abstract:: No
Structure:: IBus.BusClass

An IBus.Bus connects with IBus daemon.

classmethod new()¶

Returns:: A newly allocated IBus.Bus instance, and the instance is not floating.
Return type:: IBus.Bus

Creates a new IBus.Bus instance.

classmethod new_async()¶

Returns:: A newly allocated IBus.Bus instance, and the instance is not floating.
Return type:: IBus.Bus

Creates a new IBus.Bus instance. The instance will asynchronously connect to the IBus daemon.

classmethod new_async_client()¶

Returns:: A newly allocated IBus.Bus instance, and the instance is not floating.
Return type:: IBus.Bus

Creates a new IBus.Bus instance for client use only. It will possibly be limited in what it can do.

The instance will asynchronously connect to the IBus daemon.

add_match(rule)¶

Parameters:: rule (str) – Match rule.
Returns:: True if the rule is added. False otherwise.
Return type:: bool

Add a match rule to an IBus.Bus synchronously.

add_match_async(rule, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

rule (str) – Match rule.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Add a match rule to an IBus.Bus asynchronously.

add_match_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.add_match_async().
Raises:: GLib.Error
Returns:: True if the rule is added. False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.add_match_async().

create_input_context(client_name)¶

Parameters:: client_name (str) – Name of client.
Returns:: A newly allocated IBus.InputContext if the “CreateInputContext” call is succeeded, None otherwise.
Return type:: IBus.InputContext

Create an input context for client synchronously.

create_input_context_async(client_name, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

client_name (str) – Name of client.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied. It should not be None.
user_data (object or None) – The data to pass to callback.

Create an input context for client asynchronously.

create_input_context_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.create_input_context_async().
Raises:: GLib.Error
Returns:: A newly allocated IBus.InputContext if the “CreateInputContext” call is succeeded, None otherwise.
Return type:: IBus.InputContext

Finishes an operation started with IBus.Bus.create_input_context_async().

current_input_context()¶

Returns:: Name of the currently focused IBus.InputContext if the “CurrentInputContext” call succeeded, None otherwise. The return value must be freed with GLib.free().
Return type:: str

Get the current focused input context synchronously.

current_input_context_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Get the current focused input context asynchronously.

current_input_context_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.current_input_context_async().
Raises:: GLib.Error
Returns:: Name of the currently focused IBus.InputContext if the “CurrentInputContext” call succeeded, None otherwise. The return value must be freed with GLib.free().
Return type:: str

Finishes an operation started with IBus.Bus.current_input_context_async().

exit(restart)¶

Parameters:: restart (bool) – Whether restarting the ibus.
Returns:: True if the “Exit” call is successful, False otherwise.
Return type:: bool

Exit or restart ibus-daemon synchronously.

exit_async(restart, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

restart (bool) – Whether restarting the ibus.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Exit or restart ibus-daemon asynchronously.

exit_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.exit_async().
Raises:: GLib.Error
Returns:: True if the “Exit” call is successful, False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.exit_async().

get_config()¶

Returns:: An IBus.Config object which is configurable with self.
Return type:: IBus.Config

Get the config instance from IBus.Bus.

get_connection()¶

Returns:: A Gio.DBusConnection of an IBus.Bus instance.
Return type:: Gio.DBusConnection

Gets a Gio.DBusConnection of an IBus.Bus instance.

get_engines_by_names(names)¶

Parameters:: names ([str]) – A None-terminated array of names.
Returns:: A None-terminated array of engines.
Return type:: [IBus.EngineDesc]

Get engines by given names synchronously. If some engine names do not exist, this function will simply ignore them, and return rest of engines. TODO(penghuang): add asynchronous version

get_global_engine()¶

Returns:: The description of current global engine, or None if there is no global engine.
Return type:: IBus.EngineDesc

Get the description of current global engine synchronously.

get_global_engine_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Get the description of current global engine asynchronously.

get_global_engine_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.get_global_engine_async_finish().
Raises:: GLib.Error
Returns:: The description of current global engine, or None if there is no global engine.
Return type:: IBus.EngineDesc

Finishes an operation started with IBus.Bus.get_global_engine_async_finish().

get_ibus_property(property_name)¶

Parameters:: property_name (str) – property name in org.freedesktop.DBus.Properties.Get
Returns:: The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with GLib.Variant.unref().
Return type:: GLib.Variant

Get org.freedesktop.DBus.Properties.

get_ibus_property_async(property_name, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

property_name (str) – property name in org.freedesktop.DBus.Properties.Get
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Get org.freedesktop.DBus.Properties asynchronously.

get_ibus_property_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.get_ibus_property_async().
Raises:: GLib.Error
Returns:: The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with GLib.Variant.unref().
Return type:: GLib.Variant

Finishes an operation started with IBus.Bus.get_ibus_property_async().

get_name_owner(name)¶

Parameters:: name (str) – Name.
Returns:: Owner of the name. The returned value must be freed with GLib.free().
Return type:: str

Return the name owner synchronously.

get_name_owner_async(name, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

name (str) – Name.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Return the name owner asynchronously.

get_name_owner_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.get_name_owner_async().
Raises:: GLib.Error
Returns:: Owner of the name. The returned value must be freed with GLib.free().
Return type:: str

Finishes an operation started with IBus.Bus.get_name_owner_async().

get_service_name()¶

Returns:: at dbus name.
Return type:: str

Return the main service name to use for calls on the ibus connection.

get_use_global_engine()¶

Returns:: True if “use_global_engine” option is enabled.
Return type:: bool

Check if the bus’s “use_global_engine” option is enabled or not synchronously.

Deprecated since version 1.5.3: Currently global engine is always used.

get_use_global_engine_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Check if the bus’s “use_global_engine” option is enabled or not asynchronously.

Deprecated since version 1.5.3: Currently global engine is always used.

get_use_global_engine_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.get_use_global_engine_async().
Raises:: GLib.Error
Returns:: True if “use_global_engine” option is enabled.
Return type:: bool

Finishes an operation started with IBus.Bus.get_use_global_engine_async().

Deprecated since version 1.5.3: Currently global engine is always used.

get_use_sys_layout()¶

Returns:: True if “use_sys_layout” option is enabled.
Return type:: bool

Check if the bus’s “use_sys_layout” option is enabled or not synchronously.

Deprecated since version 1.5.3: Read dconf value /desktop/ibus/general/use_system_keyboard_layout instead.

get_use_sys_layout_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Check if the bus’s “use_sys_layout” option is enabled or not asynchronously.

Deprecated since version 1.5.3: Read dconf value /desktop/ibus/general/use_system_keyboard_layout instead.

get_use_sys_layout_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.get_use_sys_layout_async().
Raises:: GLib.Error
Returns:: True if “use_sys_layout” option is enabled.
Return type:: bool

Finishes an operation started with IBus.Bus.get_use_sys_layout_async().

Deprecated since version 1.5.3: Read dconf value /desktop/ibus/general/use_system_keyboard_layout instead.

hello()¶

Returns:: The unique name of IBus process in DBus.
Return type:: str

This function sends a “HELLO” message to DBus daemon, which replies the unique name of current IBus process.

is_connected()¶

Returns:: True if self is connected, False otherwise.
Return type:: bool

Return True if self is connected to IBus daemon.

is_global_engine_enabled()¶

Returns:: True if the current global engine is enabled.
Return type:: bool

Check if the current global engine is enabled or not synchronously.

Deprecated since version 1.5.3: Probably this would be used for Chrome OS only. Currently global engine is always used and IBus.Bus.get_global_engine() returns None until the first global engine is assigned. You can use IBus.set_log_handler() to disable a warning when IBus.Bus.get_global_engine() returns None.

is_global_engine_enabled_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Check if the current global engine is enabled or not asynchronously.

Deprecated since version 1.5.3: Probably this would be used for Chrome OS only. Currently global engine is always used and IBus.Bus.get_global_engine() returns None until the first global engine is assigned. You can use IBus.set_log_handler() to disable a warning when IBus.Bus.get_global_engine() returns None.

is_global_engine_enabled_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.is_global_engine_enabled_async().
Raises:: GLib.Error
Returns:: True if the current global engine is enabled.
Return type:: bool

Finishes an operation started with IBus.Bus.is_global_engine_enabled_async().

Deprecated since version 1.5.3: Probably this would be used for Chrome OS only. Currently global engine is always used and IBus.Bus.get_global_engine() returns None until the first global engine is assigned. You can use IBus.set_log_handler() to disable a warning when IBus.Bus.get_global_engine() returns None.

list_active_engines()¶

Returns:: A List of active engines.
Return type:: [IBus.EngineDesc]

List active engines synchronously.

Deprecated since version 1.5.3: Read dconf value /desktop/ibus/general/preload-engines instead.

list_active_engines_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

List active engines asynchronously.

Deprecated since version 1.5.3: Read dconf value /desktop/ibus/general/preload-engines instead.

list_active_engines_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.list_active_engines_async().
Raises:: GLib.Error
Returns:: A List of active engines.
Return type:: [IBus.EngineDesc]

Finishes an operation started with IBus.Bus.list_active_engines_async().

Deprecated since version 1.5.3: Read dconf value /desktop/ibus/general/preload-engines instead.

list_engines()¶

Returns:: A List of engines.
Return type:: [IBus.EngineDesc]

List engines synchronously.

list_engines_async(timeout_msec, cancellable, callback, *user_data)¶

Parameters:

timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

List engines asynchronously.

list_engines_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.list_engines_async().
Raises:: GLib.Error
Returns:: A List of engines.
Return type:: [IBus.EngineDesc]

Finishes an operation started with IBus.Bus.list_engines_async().

list_names()¶

Returns:: Lists that attached to self.
Return type:: [str]

Return lists that attached to self.

[FixMe] Not implemented yet, only return None.

[FixMe] Add async version.

list_queued_owners(name)¶

Parameters:: name (str) – Name to be queried.
Returns:: The unique bus names of connections currently queued for name.
Return type:: [str]

Lists the unique bus names of connections currently queued for a bus name. FIXME add an asynchronous version.

name_has_owner(name)¶

Parameters:: name (str) – Name to be checked.
Returns:: True if the name has owner, False otherwise.
Return type:: bool

Checks whether the name has owner synchronously.

name_has_owner_async(name, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

name (str) – Name to be checked.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Checks whether the name has owner asynchronously.

name_has_owner_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.name_has_owner_async().
Raises:: GLib.Error
Returns:: True if the name has owner, False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.name_has_owner_async().

preload_engines(names)¶

Parameters:: names ([str]) – A None-terminated array of engine names.
Returns:: True if components start. False otherwise.
Return type:: bool

Start bus components by engine names synchronously.

preload_engines_async(names, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

names ([str]) – A None-terminated array of engine names.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Start bus components by engine names asynchronously.

preload_engines_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.preload_engines_async().
Raises:: GLib.Error
Returns:: True if component starts. False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.preload_engines_async().

register_component(component)¶

Parameters:: component (IBus.Component) – A input engine component.
Returns:: True if the “RegisterComponent” call is successful, False otherwise.
Return type:: bool

Register a component to an IBus.Bus synchronously.

register_component_async(component, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

component (IBus.Component) – A input engine component.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Register a component to an IBus.Bus asynchronously.

register_component_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.register_component_async().
Raises:: GLib.Error
Returns:: True if the “RegisterComponent” call is successful, False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.register_component_async().

release_name(name)¶

Parameters:: name (str) – Name to be released.
Returns:: 0 if failed; positive number otherwise.
Return type:: int

Release a name to IBus daemon synchronously.

release_name_async(name, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

name (str) – Name to be released.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Release a name to IBus daemon asynchronously.

release_name_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.release_name_async().
Raises:: GLib.Error
Returns:: 0 if failed; positive number otherwise.
Return type:: int

Finishes an operation started with IBus.Bus.release_name_async().

remove_match(rule)¶

Parameters:: rule (str) – Match rule.
Returns:: True if the rule is removed. False otherwise.
Return type:: bool

Remove a match rule to an IBus.Bus synchronously.

remove_match_async(rule, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

rule (str) – Match rule.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Remove a match rule to an IBus.Bus asynchronously.

remove_match_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.remove_match_async().
Raises:: GLib.Error
Returns:: True if the rule is removed. False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.remove_match_async().

request_name(name, flags)¶

Parameters:

name (str) – Name to be requested.
flags (int) – IBus.BusNameFlag.

Returns:

0 if failed; IBus.BusRequestNameReply otherwise.

Return type:

int

Request a name from IBus daemon synchronously.

request_name_async(name, flags, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

name (str) – Name to be requested.
flags (int) – Flags (FixMe).
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Request a name from IBus daemon asynchronously.

request_name_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.request_name_async().
Raises:: GLib.Error
Returns:: 0 if failed; positive number otherwise.
Return type:: int

Finishes an operation started with IBus.Bus.request_name_async().

set_global_engine(global_engine)¶

Parameters:: global_engine (str) – A new engine name.
Returns:: True if the global engine was set successfully.
Return type:: bool

Set current global engine synchronously.

set_global_engine_async(global_engine, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

global_engine (str) – A new engine name.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Set current global engine asynchronously.

set_global_engine_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.set_global_engine_async().
Raises:: GLib.Error
Returns:: True if no IPC errros. False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.set_global_engine_async().

set_global_shortcut_keys(gtype, keys)¶

Parameters:

gtype (IBus.BusGlobalBindingType) – A IBus.BusGlobalBindingType.
keys ([IBus.ProcessKeyEventData]) – A None-terminated array of IBus.ProcessKeyEventData. keycode is used for the selecting direction and the forward direction in case of 0, otherwise the backward direction.

Returns:

True if the global shortcut keys are set. False otherwise.

Return type:

bool

Set global shorcut keys for the Wayland session.

New in version 1.5.29.

set_global_shortcut_keys_async(gtype, keys, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

gtype (IBus.BusGlobalBindingType) – A IBus.BusGlobalBindingType.
keys ([IBus.ProcessKeyEventData]) – A None-terminated array of IBus.ProcessKeyEventData.
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Sete global shorcut keys for the Wayland session asynchronously.

New in version 1.5.29.

set_global_shortcut_keys_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.set_global_shortcut_keys_async().
Raises:: GLib.Error
Returns:: True if the global shortcut keys are set. False otherwise.
Return type:: bool

Finishes an operation started with IBus.Bus.set_global_shortcut_keys_async().

New in version 1.5.29.

set_ibus_property(property_name, value)¶

Parameters:

property_name (str) – property name in org.freedesktop.DBus.Properties.Set
value (GLib.Variant) – value in org.freedesktop.DBus.Properties.Set

Set org.freedesktop.DBus.Properties.

set_ibus_property_async(property_name, value, timeout_msec, cancellable, callback, *user_data)¶

Parameters:

property_name (str) – property name in org.freedesktop.DBus.Properties.Set
value (GLib.Variant) – value in org.freedesktop.DBus.Properties.Set
timeout_msec (int) – The timeout in milliseconds or -1 to use the default timeout.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result of the method invocation.
user_data (object or None) – The data to pass to callback.

Set org.freedesktop.DBus.Properties asynchronously.

set_ibus_property_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to IBus.Bus.set_ibus_property_async().
Raises:: GLib.Error
Returns:: True if property is set with async. False failed.
Return type:: bool

Finishes an operation started with IBus.Bus.set_ibus_property_async().

set_watch_dbus_signal(watch)¶

Parameters:: watch (bool) – True if you want ibusbus to emit “name-owner-changed” signal when ibus-daemon emits the NameOwnerChanged DBus signal.

Start or stop watching the NameOwnerChanged DBus signal.

set_watch_ibus_signal(watch)¶

Parameters:: watch (bool) – True if you want ibusbus to emit “global-engine-changed” signal when ibus-daemon emits the GlobalEngineChanged IBus signal.

Start or stop watching the GlobalEngineChanged IBus signal.

Signal Details¶

IBus.Bus.signals.connected(bus)¶

Signal Name:: connected
Flags:: RUN_LAST
Parameters:: bus (IBus.Bus) – The object which received the signal

Emitted when IBus.Bus is connected to ibus-daemon.

IBus.Bus.signals.disconnected(bus)¶

Signal Name:: disconnected
Flags:: RUN_LAST
Parameters:: bus (IBus.Bus) – The object which received the signal

Emitted when IBus.Bus is disconnected from ibus-daemon.

IBus.Bus.signals.global_engine_changed(bus, name)¶

Signal Name:

global-engine-changed

Flags:

RUN_LAST

Parameters:

bus (IBus.Bus) – The object which received the signal
name (str) – The name of the new global engine.

Emitted when global engine is changed.

IBus.Bus.signals.global_shortcut_key_responded(bus, type, keyval, keycode, state, is_backward)¶

Signal Name:

global-shortcut-key-responded

Flags:

RUN_LAST

Parameters:

bus (IBus.Bus) – The object which received the signal
type (int) – The type of the global shortcut key.
keyval (int) – Key symbol of the key press.
keycode (int) – KeyCode of the key press.
state (int) – Key modifier flags.
is_backward (bool) – True if the backward key is pressed.

Emitted when global shortcut key is responded.

New in version 1.5.32.

IBus.Bus.signals.name_owner_changed(bus, name, old_owner, new_owner)¶

Signal Name:

name-owner-changed

Flags:

RUN_LAST

Parameters:

bus (IBus.Bus) – The object which received the signal
name (str) – The name which ower is changed.
old_owner (str) – The unique bus name of the old owner.
new_owner (str) – The unique bus name of the new owner.

Emitted when D-Bus name owner is changed.

Property Details¶

IBus.Bus.props.client_only¶

Name:: client-only
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Whether the IBus.Bus object is for client use only.

IBus.Bus.props.connect_async¶

Name:: connect-async
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Whether the IBus.Bus object should connect asynchronously to the bus.