Bus

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool client_only { get; construct; }
  Whether the Bus object is for client use only.
• public bool connect_async { get; construct; }
  Whether the Bus object should connect asynchronously to the bus.

Creation methods:

• public Bus ()
  Creates a new Bus instance.
• public Bus.async ()
  Creates a new Bus instance.
• public Bus.async_client ()
  Creates a new Bus instance for client use only.

Methods:

• public bool add_match (string rule)
  Add a match rule to an Bus synchronously.
• public async void add_match_async (string rule, int timeout_msec, Cancellable? cancellable)
  Add a match rule to an Bus asynchronously.
• public bool add_match_async_finish (AsyncResult res) throws Error
  Finishes an operation started with add_match_async.
• public InputContext create_input_context (string client_name)
  Create an input context for client synchronously.
• public async void create_input_context_async (string client_name, int timeout_msec, Cancellable? cancellable)
  Create an input context for client asynchronously.
• public InputContext create_input_context_async_finish (AsyncResult res) throws Error
  Finishes an operation started with create_input_context_async.
• public string current_input_context ()
  Get the current focused input context synchronously.
• public async void current_input_context_async (int timeout_msec, Cancellable? cancellable)
  Get the current focused input context asynchronously.
• public string current_input_context_async_finish (AsyncResult res) throws Error
  Finishes an operation started with current_input_context_async.
• public bool exit (bool restart)
  Exit or restart ibus-daemon synchronously.
• public async void exit_async (bool restart, int timeout_msec, Cancellable? cancellable)
  Exit or restart ibus-daemon asynchronously.
• public bool exit_async_finish (AsyncResult res) throws Error
  Finishes an operation started with exit_async.
• public unowned Config get_config ()
  Get the config instance from Bus.
• public unowned DBusConnection get_connection ()
  Gets a DBusConnection of an Bus instance.
• public EngineDesc[] get_engines_by_names (string[] names)
  Get engines by given names synchronously.
• public EngineDesc get_global_engine ()
  Get the description of current global engine synchronously.
• public async void get_global_engine_async (int timeout_msec, Cancellable? cancellable)
  Get the description of current global engine asynchronously.
• public unowned EngineDesc get_global_engine_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_global_engine_async_finish.
• public Variant get_ibus_property (string property_name)
  Get org.
• public async void get_ibus_property_async (string property_name, int timeout_msec, Cancellable? cancellable)
  Get org.
• public Variant get_ibus_property_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_ibus_property_async.
• public string get_name_owner (string name)
  Return the name owner synchronously.
• public async void get_name_owner_async (string name, int timeout_msec, Cancellable? cancellable)
  Return the name owner asynchronously.
• public string get_name_owner_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_name_owner_async.
• public unowned string get_service_name ()
  Return the main service name to use for calls on the ibus connection.
• public bool get_use_global_engine ()
  Check if the bus's "use_global_engine" option is enabled or not synchronously.
• public async void get_use_global_engine_async (int timeout_msec, Cancellable? cancellable)
  Check if the bus's "use_global_engine" option is enabled or not asynchronously.
• public bool get_use_global_engine_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_use_global_engine_async.
• public bool get_use_sys_layout ()
  Check if the bus's "use_sys_layout" option is enabled or not synchronously.
• public async void get_use_sys_layout_async (int timeout_msec, Cancellable? cancellable)
  Check if the bus's "use_sys_layout" option is enabled or not asynchronously.
• public bool get_use_sys_layout_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_use_sys_layout_async.
• public unowned string hello ()
  This function sends a "HELLO" message to DBus daemon, which replies the unique name of current IBus process.
• public bool is_connected ()
  Return true if this is connected to IBus daemon.
• public bool is_global_engine_enabled ()
  Check if the current global engine is enabled or not synchronously.
• public async void is_global_engine_enabled_async (int timeout_msec, Cancellable? cancellable)
  Check if the current global engine is enabled or not asynchronously.
• public bool is_global_engine_enabled_async_finish (AsyncResult res) throws Error
  Finishes an operation started with is_global_engine_enabled_async.
• public List<EngineDesc> list_active_engines ()
  List active engines synchronously.
• public async void list_active_engines_async (int timeout_msec, Cancellable? cancellable)
  List active engines asynchronously.
• public List<EngineDesc> list_active_engines_async_finish (AsyncResult res) throws Error
  Finishes an operation started with list_active_engines_async.
• public List<EngineDesc> list_engines ()
  List engines synchronously.
• public async void list_engines_async (int timeout_msec, Cancellable? cancellable)
  List engines asynchronously.
• public List<EngineDesc> list_engines_async_finish (AsyncResult res) throws Error
  Finishes an operation started with list_engines_async.
• public List<string> list_names ()
  Return lists that attached to this.
• public List<string> list_queued_owners (string name)
  Lists the unique bus names of connections currently queued for a bus name.
• public bool name_has_owner (string name)
  Checks whether the name has owner synchronously.
• public async void name_has_owner_async (string name, int timeout_msec, Cancellable? cancellable)
  Checks whether the name has owner asynchronously.
• public bool name_has_owner_async_finish (AsyncResult res) throws Error
  Finishes an operation started with name_has_owner_async.
• public bool preload_engines (string[] names)
  Start bus components by engine names synchronously.
• public async void preload_engines_async (string[] names, int timeout_msec, Cancellable? cancellable)
  Start bus components by engine names asynchronously.
• public bool preload_engines_async_finish (AsyncResult res) throws Error
  Finishes an operation started with preload_engines_async.
• public bool register_component (Component component)
  Register a component to an Bus synchronously.
• public async void register_component_async (Component component, int timeout_msec, Cancellable? cancellable)
  Register a component to an Bus asynchronously.
• public bool register_component_async_finish (AsyncResult res) throws Error
  Finishes an operation started with register_component_async.
• public uint release_name (string name)
  Release a name to IBus daemon synchronously.
• public async void release_name_async (string name, int timeout_msec, Cancellable? cancellable)
  Release a name to IBus daemon asynchronously.
• public uint release_name_async_finish (AsyncResult res) throws Error
  Finishes an operation started with release_name_async.
• public bool remove_match (string rule)
  Remove a match rule to an Bus synchronously.
• public async void remove_match_async (string rule, int timeout_msec, Cancellable? cancellable)
  Remove a match rule to an IBusBus asynchronously.
• public bool remove_match_async_finish (AsyncResult res) throws Error
  Finishes an operation started with remove_match_async.
• public uint32 request_name (string name, uint32 flags)
  Request a name from IBus daemon synchronously.
• public async void request_name_async (string name, uint flags, int timeout_msec, Cancellable? cancellable)
  Request a name from IBus daemon asynchronously.
• public uint request_name_async_finish (AsyncResult res) throws Error
  Finishes an operation started with request_name_async.
• public bool set_global_engine (string global_engine)
  Set current global engine synchronously.
• public async void set_global_engine_async (string global_engine, int timeout_msec, Cancellable? cancellable)
  Set current global engine asynchronously.
• public bool set_global_engine_async_finish (AsyncResult res) throws Error
  Finishes an operation started with set_global_engine_async.
• public bool set_global_shortcut_keys (BusGlobalBindingType gtype, ProcessKeyEventData[] keys)
  Set global shorcut keys for the Wayland session.
• public async void set_global_shortcut_keys_async (BusGlobalBindingType gtype, ProcessKeyEventData[] keys, int timeout_msec, Cancellable? cancellable)
  Sete global shorcut keys for the Wayland session asynchronously.
• public bool set_global_shortcut_keys_async_finish (AsyncResult res) throws Error
  Finishes an operation started with set_global_shortcut_keys_async.
• public void set_ibus_property (string property_name, Variant value)
  Set org.
• public async void set_ibus_property_async (string property_name, Variant value, int timeout_msec, Cancellable? cancellable)
  Set org.
• public bool set_ibus_property_async_finish (AsyncResult res) throws Error
  Finishes an operation started with set_ibus_property_async.
• public void set_watch_dbus_signal (bool watch)
  Start or stop watching the NameOwnerChanged DBus signal.
• public void set_watch_ibus_signal (bool watch)
  Start or stop watching the GlobalEngineChanged IBus signal.

Signals:

• public signal void connected ()
  Emitted when Bus is connected to ibus-daemon.
• public signal void disconnected ()
  Emitted when Bus is disconnected from ibus-daemon.
• public signal void global_engine_changed (string name)
  Emitted when global engine is changed.
• public signal void global_shortcut_key_responded (uint8 type, uint keyval, uint keycode, uint state, bool is_backward)
  Emitted when global shortcut key is responded.
• public signal void name_owner_changed (string name, string old_owner, string new_owner)
  Emitted when D-Bus name owner is changed.

Inherited Members: