IBus.Config¶

Subclasses:: None

Methods¶

Inherited:: IBus.Proxy (1), Gio.DBusProxy (25), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusInterface (3), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (connection, cancellable)
class	`new_async` (connection, cancellable, callback, *user_data)
class	`new_async_finish` (res)
	`get_value` (section, name)
	`get_value_async` (section, name, timeout_ms, cancellable, callback, *user_data)
	`get_value_async_finish` (result)
	`get_values` (section)
	`get_values_async` (section, timeout_ms, cancellable, callback, *user_data)
	`get_values_async_finish` (result)
	`set_value` (section, name, value)
	`set_value_async` (section, name, value, timeout_ms, cancellable, callback, *user_data)
	`set_value_async_finish` (result)
	`unset` (section, name)
	`unwatch` (section, name)
	`watch` (section, name)

Virtual Methods¶

Inherited:: IBus.Proxy (1), Gio.DBusProxy (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusInterface (3), Gio.Initable (1)

Properties¶

Inherited:: Gio.DBusProxy (9)

Signals¶

Inherited:: IBus.Proxy (1), Gio.DBusProxy (2), GObject.Object (1)

Name	Short Description
`value-changed`	Emitted when configuration value is changed.

Fields¶

Inherited:: IBus.Proxy (1), Gio.DBusProxy (2), GObject.Object (1)

Name	Type	Access	Description
parent	`IBus.Proxy`	r

Class Details¶

class IBus.Config(**kwargs)¶

Bases:: IBus.Proxy
Abstract:: No
Structure:: IBus.ConfigClass

An IBus.Config provides engine configuration methods such as get and set the configure settings to configuration file.

Currently, IBus.Config supports gconf.

classmethod new(connection, cancellable)¶

Parameters:

connection (Gio.DBusConnection) – A Gio.DBusConnection.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

A newly allocated IBus.Config corresponding to connection.

Return type:

IBus.Config

Create a new IBus.Config from existing Gio.DBusConnection.

classmethod new_async(connection, cancellable, callback, *user_data)¶

Parameters:

connection (Gio.DBusConnection) – An Gio.DBusConnection.
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. The callback should not be None.
user_data (object or None) – The data to pass to callback.

New an IBus.Config asynchronously.

classmethod new_async_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback pass to IBus.Config.new_async().
Raises:: GLib.Error
Returns:: A newly allocated IBus.Config.
Return type:: IBus.Config

Finishes an operation started with IBus.Config.new_async().

get_value(section, name)¶

Parameters:

section (str) – Section name of the configuration option.
name (str) – Name of the configure option.

Returns:

A GLib.Variant or None. Free with GLib.Variant.unref().

Return type:

GLib.Variant

Get the value of a configuration option synchronously.

GConf stores configure options in a tree-like structure, and the IBus related setting is at /desktop/ibus, thus, section here is a path from there, while name is the key of that configuration option.

ibus-chewing, for example, stores its setting in /desktop/ibus/engine/Chewing, so the section name for it is “engine/Chewing”. See also: IBus.Config.set_value().

get_value_async(section, name, timeout_ms, cancellable, callback, *user_data)¶

Parameters:

section (str) – Section name of the configuration option.
name (str) – Name of the configure option.
timeout_ms (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) – Callback function to invoke when the return value is ready.
user_data (object or None) – The data to pass to callback.

Get the value of a configuration option asynchronously.

Signal Details¶

IBus.Config.signals.value_changed(config, section, name, value)¶

Signal Name:

value-changed

Flags:

RUN_LAST

Parameters:

config (IBus.Config) – The object which received the signal
section (str) – Section name.
name (str) – Name of the property.
value (GLib.Variant) – Value.

Emitted when configuration value is changed.

Argument user_data is ignored in this function.