### ibus_bus_preload_engines Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Starts bus components by engine names synchronously. ```APIDOC ## ibus_bus_preload_engines ### Description Start bus components by engine names synchronously. ### Parameters #### Path Parameters - `bus` (_IBusBus) - An IBusBus. - `names` (_const gchar * const *) - A `NULL`-terminated array of engine names. [array zero-terminated=1] ### Returns `TRUE` if components start. `FALSE` otherwise. ``` -------------------------------- ### ibus_engine_desc_get_setup Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html Retrieves the setup associated with the IBusEngineDesc. The returned string should not be freed. ```APIDOC ## ibus_engine_desc_get_setup ### Description Returns the setup property in IBusEngineDesc. ### Signature ```c const gchar * ibus_engine_desc_get_setup (_IBusEngineDesc *info_); ``` ### Parameters * `info`: An IBusEngineDesc structure. ### Returns The setup property of the IBusEngineDesc. This pointer should not be freed. ``` -------------------------------- ### start_setup Signal Source: https://ibus.github.io/docs/ibus-1.5/IBusPanelService.html Emitted when the client application gets the start-setup. Implement the member function `start_setup()` in the extended class to receive this signal. ```APIDOC ## start_setup Signal ### Description Emitted when the client application gets the start-setup. Implement the member function `start_setup()` in extended class to receive this signal. ### Parameters - **user_data** (gpointer) - User data set when the signal handler was connected. ``` -------------------------------- ### ibus_input_context_get_input_context Source: https://ibus.github.io/docs/ibus-1.5/api-index-full.html Gets the global input context. ```APIDOC ## ibus_input_context_get_input_context ### Description Gets the global input context. ### Function Signature `ibus_input_context_get_input_context()` ### Returns (IBusInputContext): The global input context. ``` -------------------------------- ### ibus_bus_preload_engines_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an operation started with ibus_bus_preload_engines_async(). Checks if the component starts successfully. ```APIDOC ## ibus_bus_preload_engines_async_finish ### Description Finishes an operation started with `ibus_bus_preload_engines_async()`. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - An IBusBus. - **res** (_GAsyncResult_*) - A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_bus_preload_engines_async()`. - **error** (_GError_**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if component starts. FALSE otherwise. ``` -------------------------------- ### Finish Asynchronous Engine Preload Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an operation started with ibus_bus_preload_engines_async(). Call this in your GAsyncReadyCallback to get the result. Returns TRUE if components start successfully, FALSE otherwise. ```c gboolean ibus_bus_preload_engines_async_finish (_IBusBus *bus_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Get Global Engine Description (Synchronous) Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Get the description of the current global engine synchronously. Returns the description or NULL if no global engine is assigned. ```c IBusEngineDesc * ibus_bus_get_global_engine (_IBusBus *bus_); ``` -------------------------------- ### ibus_registry_new Source: https://ibus.github.io/docs/ibus-1.5/api-index-full.html Creates a new IBus registry instance. This is the starting point for interacting with the registry. ```APIDOC ## ibus_registry_new ### Description Creates a new IBus registry instance. ### Function Signature `ibus_registry_new()` ``` -------------------------------- ### ibus_bus_get_global_engine_async Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Gets the description of the current global engine asynchronously. ```APIDOC ## ibus_bus_get_global_engine_async ### Description Get the description of current global engine asynchronously. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method Asynchronous function call ### Endpoint N/A (SDK function) ### Parameters - **bus** (_IBusBus_*) - An IBusBus. - **timeout_msec** (_gint_) - The timeout in milliseconds or -1 to use the default timeout. - **cancellable** (_GCancellable_*) - A GCancellable or `NULL`. - **callback** (_GAsyncReadyCallback_*) - A GAsyncReadyCallback to call when the request is satisfied or `NULL` if you don't care about the result of the method invocation. - **user_data** (_gpointer_) - The data to pass to callback. ### Request Example ```c ibus_bus_get_global_engine_async(bus, -1, NULL, my_callback, NULL); ``` ### Response - None (asynchronous operation, result is returned via callback) ``` -------------------------------- ### ibus_input_context_get_engine_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Finishes an asynchronous request to get the input engine. ```APIDOC ## ibus_input_context_get_engine_async_finish ### Description Finishes an asynchronous request to get the input engine. ### Method IBusEngineDesc * ### Parameters - **context** (_IBusInputContext *) - The input context. - **res** (_GAsyncResult *) - The asynchronous result. - **error** (_GError **) - A pointer to a GError for error reporting. ``` -------------------------------- ### ibus_bus_preload_engines_async Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Starts bus components by engine names asynchronously. Allows for preloading multiple engines with a specified timeout and optional cancellation. ```APIDOC ## ibus_bus_preload_engines_async ### Description Starts bus components by engine names asynchronously. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - An IBusBus. - **names** (_const gchar * const []_) - A NULL-terminated array of engine names. [array zero-terminated=1] - **timeout_msec** (_gint_) - The timeout in milliseconds or -1 to use the default timeout. - **cancellable** (_GCancellable_*) - A GCancellable or NULL. - **callback** (_GAsyncReadyCallback_*) - A GAsyncReadyCallback to call when the request is satisfied or NULL if you don't care about the result of the method invocation. - **user_data** (_gpointer_) - The data to pass to callback. ### Returns void ``` -------------------------------- ### Get Use System Layout Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Synchronous and asynchronous methods to check if the system layout is used. ```APIDOC ## ibus_bus_get_use_sys_layout ### Description Checks synchronously if the system layout is being used. ### Method gboolean ### Parameters - **bus** (_IBusBus *) - The IBusBus instance. ## ibus_bus_get_use_sys_layout_async ### Description Initiates an asynchronous operation to check if the system layout is used. ### Method void ### Parameters - **bus** (_IBusBus *) - The IBusBus instance. - **timeout_msec** (_gint_) - Timeout in milliseconds. - **cancellable** (_GCancellable *) - A GCancellable object. - **callback** (_GAsyncReadyCallback_) - Callback function. - **user_data** (_gpointer_) - User data. ## ibus_bus_get_use_sys_layout_async_finish ### Description Finishes an asynchronous operation to check if the system layout is used. ### Method gboolean ### Parameters - **bus** (_IBusBus *) - The IBusBus instance. - **res** (_GAsyncResult *) - The GAsyncResult object. - **error** (_GError **) - Pointer to a GError for error reporting. ``` -------------------------------- ### Start Monitoring Registry Changes Source: https://ibus.github.io/docs/ibus-1.5/IBusRegistry.html Initiates monitoring for changes to the registry. This function should be called to enable change notifications. ```c void ibus_registry_start_monitor_changes (_IBusRegistry *registry_); ``` -------------------------------- ### IBUS_Hangul_Start KeySym Definition Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibuskeysyms-compat.html Defines the KeySym for the start of Hangul input. ```c #define IBUS_Hangul_Start 0xff32 ``` -------------------------------- ### Get Use System Layout Setting Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Retrieves a boolean value indicating whether the system layout is being used by IBus. ```c gboolean ibus_bus_get_use_sys_layout (_IBusBus *bus_); ``` -------------------------------- ### ibus_registry_start_monitor_changes Source: https://ibus.github.io/docs/ibus-1.5/IBusRegistry.html Starts monitoring the observed paths for any changes. This function is a prerequisite for receiving 'changed' signals. ```APIDOC ## ibus_registry_start_monitor_changes ### Description Start to monitor observed paths. ### Parameters #### Path Parameters - **registry** (_IBusRegistry_) - An IBusRegistry. ### Returns - **void** ``` -------------------------------- ### ibus_bus_get_global_engine Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Gets the description of the current global engine synchronously. ```APIDOC ## ibus_bus_get_global_engine ### Description Get the description of current global engine synchronously. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method Synchronous function call ### Endpoint N/A (SDK function) ### Parameters - **bus** (_IBusBus_*) - An IBusBus. ### Request Example ```c IBusEngineDesc* engine_desc = ibus_bus_get_global_engine(bus); ``` ### Response #### Success Response - **engine_desc** (IBusEngineDesc*) - The description of current global engine. #### Response Example ```json { "engine_description": { "name": "example_engine", "description": "An example engine" } } ``` ### Note [transfer none] ``` -------------------------------- ### Get IBusAttribute start index Source: https://ibus.github.io/docs/ibus-1.5/IBusAttribute.html Retrieves the starting index (inclusive) of the attribute's scope within the text. ```c guint ibus_attribute_get_start_index (_IBusAttribute *attr_); ``` -------------------------------- ### Create IBusEngineDesc with arguments Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html Use this function to create an IBusEngineDesc instance by providing all necessary description properties as arguments. Ensure all required fields are populated. ```c IBusEngineDesc * ibus_engine_desc_new (_const gchar *name_, _const gchar *longname_, _const gchar *description_, _const gchar *language_, _const gchar *license_, _const gchar *author_, _const gchar *icon_, _const gchar *layout_); ``` -------------------------------- ### Finish Getting Input Engine Asynchronously Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Completes the asynchronous operation started by `ibus_input_context_get_engine_async()`. This function should be called within the GAsyncReadyCallback. ```c IBusEngineDesc * ibus_input_context_get_engine_async_finish (_IBusInputContext *context_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Create IBusComponent with Full Arguments Source: https://ibus.github.io/docs/ibus-1.5/IBusComponent.html Initializes a new IBusComponent with all essential properties. Ensure all string arguments are valid and properly null-terminated. ```c IBusComponent * ibus_component_new (_const gchar *name_, _const gchar *description_, _const gchar *version_, _const gchar *license_, _const gchar *author_, _const gchar *homepage_, _const gchar *command_line_, _const gchar *textdomain_); ``` -------------------------------- ### Finish Asynchronous Bus Property Get Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an operation started with ibus_bus_get_ibus_property_async(). Call this in your GAsyncReadyCallback to retrieve the property value. The returned GVariant must be freed with g_variant_unref(). ```c GVariant * ibus_bus_get_ibus_property_async_finish (_IBusBus *bus_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### ibus_init Source: https://ibus.github.io/docs/ibus-1.5/api-index-full.html Initializes the IBUS system. ```APIDOC ## ibus_init ### Description Initializes the IBUS system. ### Function Signature `ibus_init()` ``` -------------------------------- ### Get Engines By Names Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Retrieves input method engine descriptions by their names. ```APIDOC ## ibus_bus_get_engines_by_names ### Description Retrieves descriptions for input method engines specified by an array of names. ### Method IBusEngineDesc ** ### Parameters - **bus** (_IBusBus *) - The IBusBus instance. - **names** (_const gchar * const *) - An array of engine names. ``` -------------------------------- ### Initialize IBusPanelService Source: https://ibus.github.io/docs/ibus-1.5/IBusPanelService.html Creates a new IBusPanelService instance. Requires an active GDBusConnection. ```c IBusPanelService * ibus_panel_service_new (_GDBusConnection *connection_); ``` -------------------------------- ### Finish Asynchronous Get Values Operation Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Completes an asynchronous operation to get all values for a section. Processes the result and handles errors. ```c GVariant * ibus_config_get_values_async_finish (_IBusConfig *config_, _GAsyncResult *result_, _GError **error_); ``` -------------------------------- ### Create New IBusEngineDesc with Full Parameters Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html Constructs a new IBusEngineDesc instance by providing all required properties. ```c IBusEngineDesc * ibus_engine_desc_new (_const gchar *name_, _const gchar *longname_, _const gchar *description_, _const gchar *language_, _const gchar *license_, _const gchar *author_, _const gchar *icon_, _const gchar *layout_); ``` -------------------------------- ### Finish Asynchronous Get Value Operation Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Completes an asynchronous operation to get a configuration value. Handles the result and any potential errors. ```c GVariant * ibus_config_get_value_async_finish (_IBusConfig *config_, _GAsyncResult *result_, _GError **error_); ``` -------------------------------- ### IBusEngine Initialization Source: https://ibus.github.io/docs/ibus-1.5/IBusEngine.html Functions to create and initialize an IBusEngine instance. ```APIDOC ## ibus_engine_new ### Description Creates a new IBusEngine instance. ### Method `ibus_engine_new` ### Parameters - **engine_name_** (_const gchar *) - The name of the engine. - **object_path_** (_const gchar *) - The object path for the engine. - **connection_** (_GDBusConnection *) - The GDBusConnection to use. ## ibus_engine_new_with_type ### Description Creates a new IBusEngine instance with a specified engine type. ### Method `ibus_engine_new_with_type` ### Parameters - **engine_type_** (_GType) - The type of the engine. - **engine_name_** (_const gchar *) - The name of the engine. - **object_path_** (_const gchar *) - The object path for the engine. - **connection_** (_GDBusConnection *) - The GDBusConnection to use. ``` -------------------------------- ### IBusConfig Get Values Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Functions for retrieving all configuration values from a section. ```APIDOC ## ibus_config_get_values ### Description Retrieves all configuration values from a specified section. ### Method `ibus_config_get_values` ### Parameters - `config_` (_IBusConfig *) - The IBusConfig object. - `section_` (_const gchar *) - The name of the configuration section. ### Returns - `GVariant *` - A GVariant containing all configuration values for the section, or NULL if the section is not found or an error occurs. ## ibus_config_get_values_async ### Description Asynchronously retrieves all configuration values from a specified section. ### Method `ibus_config_get_values_async` ### Parameters - `config_` (_IBusConfig *) - The IBusConfig object. - `section_` (_const gchar *) - The name of the configuration section. - `timeout_ms_` (_gint) - The timeout in milliseconds for the operation. - `cancellable_` (_GCancellable *) - The GCancellable object for the operation. - `callback_` (_GAsyncReadyCallback) - The callback function to be called when the operation completes. - `user_data_` (_gpointer) - User data to pass to the callback. ## ibus_config_get_values_async_finish ### Description Finishes an asynchronous operation to retrieve all configuration values from a section. ### Method `ibus_config_get_values_async_finish` ### Parameters - `config_` (_IBusConfig *) - The IBusConfig object. - `result_` (_GAsyncResult *) - The GAsyncResult from the asynchronous operation. - `error_` (_GError **) - A pointer to a GError to store error information. ### Returns - `GVariant *` - A GVariant containing all configuration values for the section, or NULL on failure. ``` -------------------------------- ### Get Global Engine Description (Asynchronous) Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Get the description of the current global engine asynchronously. This function initiates an asynchronous request to retrieve the global engine's description. ```c void ibus_bus_get_global_engine_async (_IBusBus *bus_, _gint timeout_msec_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### Create an IBusEngine instance Source: https://ibus.github.io/docs/ibus-1.5/IBusFactory.html Creates an IBusEngine instance based on the provided engine name. The created engine is returned with full transfer ownership. ```c IBusEngine * ibus_factory_create_engine (_IBusFactory *factory_, _const gchar *engine_name_); ``` -------------------------------- ### Get Engine License Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html Retrieves the license property from an IBusEngineDesc. The returned pointer should not be freed. ```c const gchar * ibus_engine_desc_get_license (_IBusEngineDesc *info_); ``` -------------------------------- ### Finish Asynchronous IBusConfig Creation Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Completes the asynchronous creation of an IBusConfig object started with `ibus_config_new_async()`. Handles potential errors during the operation. ```c IBusConfig * ibus_config_new_async_finish ( _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Get Language Name from Locale Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibusutil.html Use this function to get the language name corresponding to a given locale string. It takes a constant locale name as input and returns the language name. ```c const gchar * ibus_get_language_name (_const gchar *_locale_); ``` -------------------------------- ### Create a new IBusEngine instance Source: https://ibus.github.io/docs/ibus-1.5/IBusEngine.html Use this function to create a new IBusEngine with a specified name, object path, and GDBusConnection. Ensure the connection is opened before calling. ```c IBusEngine * ibus_engine_new (_const gchar *engine_name_, _const gchar *object_path_, _GDBusConnection *connection_); ``` -------------------------------- ### Finish Asynchronous IBusInputContext Creation Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Completes the asynchronous creation of an IBusInputContext started with ibus_input_context_new_async(). It takes a GAsyncResult and returns the created IBusInputContext or an error. ```c IBusInputContext * ibus_input_context_new_async_finish (_GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Create IBusComponent Instance Source: https://ibus.github.io/docs/ibus-1.5/IBusComponent.html Use these functions to create a new IBusComponent. `ibus_component_new` takes explicit arguments, `ibus_component_new_varargs` uses variable arguments, `ibus_component_new_from_xml_node` creates from an XML node, and `ibus_component_new_from_file` loads from a file. ```c IBusComponent * ibus_component_new (_const gchar *name_, _const gchar *description_, _const gchar *version_, _const gchar *license_, _const gchar *author_, _const gchar *homepage_, _const gchar *command_line_, _const gchar *textdomain_); IBusComponent * ibus_component_new_varargs (_const gchar *first_property_name_, _..._); IBusComponent * ibus_component_new_from_xml_node (_XMLNode *node_); IBusComponent * ibus_component_new_from_file (_const gchar *filename_); ``` -------------------------------- ### ibus_attribute_get_start_index Source: https://ibus.github.io/docs/ibus-1.5/IBusAttribute.html Retrieves the starting index of an IBusAttribute. ```APIDOC ## ibus_attribute_get_start_index () ### Description Retrieves the starting unsigned index of an IBusAttribute. ### Returns A start unsigned index. ``` -------------------------------- ### IBusPanelService Initialization Source: https://ibus.github.io/docs/ibus-1.5/IBusPanelService.html Creates a new instance of IBusPanelService connected to a GDBusConnection. ```APIDOC ## ibus_panel_service_new() ### Description Creates a new IBusPanelService from a GDBusConnection. ### Parameters - **connection**: An GDBusConnection. ### Returns A newly allocated IBusPanelService. ``` -------------------------------- ### IBusBusStartServiceByNameReply Enum Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibustypes.html Replies for starting an IBus service by name, indicating success or if it's already running. ```c typedef enum { IBUS_BUS_START_REPLY_SUCCESS = 1, IBUS_BUS_START_REPLY_ALREADY_RUNNING = 2, } IBusBusStartServiceByNameReply; ``` -------------------------------- ### ibus_bus_get_ibus_property_async Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Gets a property from org.freedesktop.DBus.Properties asynchronously. ```APIDOC ## ibus_bus_get_ibus_property_async ### Description Get org.freedesktop.DBus.Properties asynchronously. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - An IBusBus. - **property_name** (_const gchar *_) - property name in org.freedesktop.DBus.Properties.Get - **timeout_msec** (_gint_) - The timeout in milliseconds or -1 to use the default timeout. - **cancellable** (_GCancellable_*) - A GCancellable or NULL. - **callback** (_GAsyncReadyCallback_*) - A GAsyncReadyCallback to call when the request is satisfied or NULL if you don't care about the result of the method invocation. - **user_data** (_gpointer_) - The data to pass to callback. ### Returns void ``` -------------------------------- ### Load IBus Components from a Specific Directory Source: https://ibus.github.io/docs/ibus-1.5/IBusRegistry.html Reads all XML files from a specified directory, creates IBusComponent objects for each, and adds them to the registry. If the directory is '/usr/share/ibus/component', this function behaves identically to `ibus_registry_load()`. ```c void ibus_registry_load_in_dir (_IBusRegistry *registry_, _const gchar *dirname_); ``` -------------------------------- ### ibus_bus_get_ibus_property Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Gets a property from org.freedesktop.DBus.Properties synchronously. ```APIDOC ## ibus_bus_get_ibus_property ### Description Get org.freedesktop.DBus.Properties. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - An IBusBus. - **property_name** (_const gchar *_) - property name in org.freedesktop.DBus.Properties.Get ### Returns - **GVariant*** - The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with `g_variant_unref()`. [transfer full] ``` -------------------------------- ### ibus_get_timeout Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibusshare.html Get the GDBus timeout in milliseconds. ```APIDOC ## ibus_get_timeout () ### Description Get the GDBus timeout in milliseconds. The timeout is for clients (e.g. im-ibus.so), not for ibus-daemon. Note that the timeout for ibus-daemon could be set by --timeout command line option of the daemon. ### Returns - A GDBus timeout in milliseconds. -1 when default timeout for GDBus should be used. ``` -------------------------------- ### Create IBusComponent from XML File Source: https://ibus.github.io/docs/ibus-1.5/IBusComponent.html Loads and initializes an IBusComponent from an XML file. This function may also load engine descriptions if present in the file. ```c IBusComponent * ibus_component_new_from_file (_const gchar *filename_); ``` -------------------------------- ### Get Engine Description Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html Retrieves the description property from an IBusEngineDesc. The returned pointer should not be freed. ```c const gchar * ibus_engine_desc_get_description (_IBusEngineDesc *info_); ``` -------------------------------- ### Define IBUS_KEY_Begin Source: https://ibus.github.io/docs/ibus-1.5/ibus-IBusKeysyms.html Defines the Begin keysym. This is often equivalent to the Home key. ```c #define IBUS_KEY_Begin 0xff58 ``` -------------------------------- ### ibus_get_socket_path Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibusshare.html Get the path of socket file. ```APIDOC ## ibus_get_socket_path () ### Description Get the path of socket file. ### Returns - A newly allocated string that stores the path of socket file. ``` -------------------------------- ### ibus_get_daemon_uid Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibusshare.html Get UID of ibus-daemon. Deprecated. ```APIDOC ## ibus_get_daemon_uid () ### Description Get UID of ibus-daemon. ### Warning `ibus_get_daemon_uid` is deprecated and should not be used in newly-written code. This function has been deprecated and should not be used in newly written code. ### Returns - UID of ibus-daemon; or 0 if UID is not available. ``` -------------------------------- ### Create New IBusEngineDesc with Variable Arguments Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html Constructs a new IBusEngineDesc instance using a variable argument list. The 'name' property is mandatory. ```c IBusEngineDesc * ibus_engine_desc_new_varargs (_const gchar *first_property_name_, _..._); ``` -------------------------------- ### Create a new IBusConfigService Source: https://ibus.github.io/docs/ibus-1.5/IBusConfigService.html Instantiates a new IBusConfigService using a provided GDBusConnection. This is the entry point for interacting with the configuration service. ```c IBusConfigService * ibus_config_service_new (_GDBusConnection *connection_); ``` -------------------------------- ### ibus_get_user_name Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibusshare.html Get the current user name. ```APIDOC ## ibus_get_user_name () ### Description Get the current user name. It is determined by: 1. `getlogin()` 2. Environment variable SUDO_USER 3. Environment variable USERHELPER_UID 4. Environment variable USERNAME 5. Environment variable LOGNAME 6. Environment variable USER 7. Environment variable LNAME ### Returns - A newly allocated string that stores current user name. ``` -------------------------------- ### Get an IBusKeymap by name Source: https://ibus.github.io/docs/ibus-1.5/IBusKeymap.html Retrieves an IBusKeymap associated with the given name. Loads the keymap file from the IBUS_DATA_DIR/keymaps directory. ```c IBusKeymap * ibus_keymap_get (_const gchar *name_); ``` -------------------------------- ### Create a New IBusPropList Source: https://ibus.github.io/docs/ibus-1.5/IBusPropList.html Use this function to instantiate a new IBusPropList. It allocates memory for the new object. ```c IBusPropList * ibus_prop_list_new (); ``` -------------------------------- ### ibus_init Source: https://ibus.github.io/docs/ibus-1.5/ibus-ibusshare.html Initialize the ibus types. ```APIDOC ## ibus_init () ### Description Initialize the ibus types. ``` -------------------------------- ### ibus_bus_set_watch_ibus_signal Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Starts or stops watching the GlobalEngineChanged IBus signal. ```APIDOC ## ibus_bus_set_watch_ibus_signal ### Description Start or stop watching the GlobalEngineChanged IBus signal. ### Parameters #### Path Parameters - `bus` (_IBusBus) - An IBusBus. - `watch` (_gboolean) - `TRUE` if you want ibusbus to emit "global-engine-changed" signal when ibus-daemon emits the GlobalEngineChanged IBus signal. ``` -------------------------------- ### Create IBusConfig Instance Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Instantiates a new IBusConfig object. Requires a GDBusConnection, a GCancellable, and an optional GError pointer for error handling. ```c IBusConfig * ibus_config_new (_GDBusConnection *connection_, _GCancellable *cancellable_, _GError **error_); ``` -------------------------------- ### ibus_bus_set_watch_dbus_signal Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Starts or stops watching the NameOwnerChanged DBus signal. ```APIDOC ## ibus_bus_set_watch_dbus_signal ### Description Start or stop watching the NameOwnerChanged DBus signal. ### Parameters #### Path Parameters - `bus` (_IBusBus) - An IBusBus. - `watch` (_gboolean) - `TRUE` if you want ibusbus to emit "name-owner-changed" signal when ibus-daemon emits the NameOwnerChanged DBus signal. ``` -------------------------------- ### ibus_input_context_get_engine_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Finishes an asynchronous operation started with `ibus_input_context_get_engine_async()`. It retrieves the IBusEngineDesc upon successful completion or an error. ```APIDOC ## ibus_input_context_get_engine_async_finish ### Description Finishes an operation started with `ibus_input_context_get_engine_async()`. This function retrieves the result of the asynchronous operation. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method (Not applicable, this is an SDK method) ### Endpoint (Not applicable, this is an SDK method) ### Request Example (Not applicable, this is an SDK method) ### Response #### Success Response (IBusEngineDesc *) - Returns an IME engine description for the context, or `NULL` if an error occurred. [transfer none] #### Response Example (Not applicable, this is an SDK method) ### Arguments - `res` (_GAsyncResult_*): A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_input_context_get_engine_async()`. - `error` (_GError **_): Return location for error or `NULL`. ``` -------------------------------- ### ibus_bus_get_use_global_engine_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an operation started with `ibus_bus_get_use_global_engine_async()`. This function is deprecated. ```APIDOC ## ibus_bus_get_use_global_engine_async_finish ### Description Finishes an operation started with `ibus_bus_get_use_global_engine_async()`. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Request Example None ### Response #### Success Response (200) - **Returns** (boolean) - TRUE if "use_global_engine" option is enabled. #### Response Example None ### Warning `ibus_bus_get_use_global_engine_async_finish` has been deprecated since version 1.5.3 and should not be used in newly-written code. Currently global engine is always used. ### Parameters - **bus** (_IBusBus_) - An IBusBus. - **res** (_GAsyncResult_) - A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_bus_get_use_global_engine_async()`. - **error** (_GError **_) - Return location for error or `NULL`. ``` -------------------------------- ### ibus_config_new_async Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Asynchronously creates a new IBusConfig instance. ```APIDOC ## ibus_config_new_async ### Description Creates a new IBusConfig instance asynchronously. ### Method `ibus_config_new_async` ### Parameters #### Path Parameters - **connection_** (_GDBusConnection_) - An GDBusConnection. - **cancellable_** (_GCancellable_) - A GCancellable or NULL. - **callback_** (_GAsyncReadyCallback_) - A GAsyncReadyCallback to call when the request is satisfied. The callback should not be NULL. - **user_data_** (_gpointer_) - The data to pass to callback. ### Returns void ``` -------------------------------- ### Load IBus Components from Default Path Source: https://ibus.github.io/docs/ibus-1.5/IBusRegistry.html Reads all XML files from the default IBus component directory (typically /usr/share/ibus/component/*.xml) and updates the registry. The IBUS_COMPONENT_PATH environment variable can specify custom directories. ```c void ibus_registry_load (_IBusRegistry *registry_); ``` -------------------------------- ### ibus_bus_get_use_sys_layout_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an operation started with `ibus_bus_get_use_sys_layout_async()`. This function is deprecated. ```APIDOC ## ibus_bus_get_use_sys_layout_async_finish ### Description Finishes an operation started with `ibus_bus_get_use_sys_layout_async()`. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Request Example None ### Response #### Success Response (200) - **Returns** (boolean) - TRUE if "use_sys_layout" option is enabled. #### Response Example None ### Warning `ibus_bus_get_use_sys_layout_async_finish` has been deprecated since version 1.5.3 and should not be used in newly-written code. Read dconf value /desktop/ibus/general/use_system_keyboard_layout instead. ### Parameters - **bus** (_IBusBus_) - An IBusBus. - **res** (_GAsyncResult_) - A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_bus_get_use_sys_layout_async()`. - **error** (_GError **_) - Return location for error or `NULL`. ``` -------------------------------- ### ibus_bus_get_ibus_property_async_finish Source: https://ibus.github.io/docs/ibus-1.5/api-index-full.html Finishes an asynchronous operation to get an IBus property. ```APIDOC ## ibus_bus_get_ibus_property_async_finish ### Description Finishes an asynchronous operation to get an IBus property. ### Function ibus_bus_get_ibus_property_async_finish ``` -------------------------------- ### ibus_input_context_new Source: https://ibus.github.io/docs/ibus-1.5/api-index-full.html Creates a new input context. ```APIDOC ## ibus_input_context_new ### Description Creates a new input context. ### Function Signature `ibus_input_context_new()` ### Returns (IBusInputContext): A new input context. ``` -------------------------------- ### Create a New IBusRegistry Instance Source: https://ibus.github.io/docs/ibus-1.5/IBusRegistry.html Allocates and initializes a new IBusRegistry object. This is the constructor for the registry. ```c IBusRegistry * ibus_registry_new (_void_); ``` -------------------------------- ### ibus_component_new_from_file Source: https://ibus.github.io/docs/ibus-1.5/IBusComponent.html Creates a new IBusComponent from an XML file. If the file contains engine descriptions, they will be loaded. ```APIDOC ## ibus_component_new_from_file ### Description Creates a new IBusComponent from an XML file. Note that a component file usually contains engine descriptions, if it does, `ibus_engine_desc_new_from_xml_node()` will be called to load the engine descriptions. ### Parameters #### Path Parameters - **filename_** (_const gchar *) - An XML file that contains component information. ### Returns A newly allocated IBusComponent. ``` -------------------------------- ### IBusBus Get Config Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Retrieves the IBus configuration object. ```APIDOC ## ibus_bus_get_config ### Description Retrieves the IBus configuration object. ### Method `ibus_bus_get_config` ### Parameters - `bus` (_IBusBus *) - The IBusBus instance. ### Returns - `IBusConfig *` - A pointer to the IBusConfig object. ``` -------------------------------- ### Get All Configuration Values for a Section Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Retrieves all configuration values within a specified section. Returns a GVariant containing all values. ```c GVariant * ibus_config_get_values (_IBusConfig *config_, _const gchar *section_); ``` -------------------------------- ### IBusEngine Name Retrieval Source: https://ibus.github.io/docs/ibus-1.5/IBusEngine.html Function to get the name of the engine. ```APIDOC ## ibus_engine_get_name ### Description Retrieves the name of the IBusEngine. ### Method `ibus_engine_get_name` ### Parameters - **engine_** (_IBusEngine *) - The IBusEngine instance. ### Returns - **const gchar *** - The name of the engine. ``` -------------------------------- ### IBusConfigService Constructor and Utility Source: https://ibus.github.io/docs/ibus-1.5/IBusConfigService.html This section covers the constructor for IBusConfigService and a utility function for value changes. ```APIDOC ## ibus_config_service_new ### Description Creates a new IBusConfigService instance from a GDBusConnection. ### Method `IBusConfigService * ibus_config_service_new (_GDBusConnection *connection_)` ### Parameters #### Path Parameters - **connection** (_GDBusConnection *) - Required - An GDBusConnection. ### Returns - `IBusConfigService *` - A newly allocated IBusConfigServices. ``` ```APIDOC ## ibus_config_service_value_changed ### Description Changes a value of a configuration option by sending a "ValueChanged" message to the IBus service. ### Method `void ibus_config_service_value_changed (_IBusConfigService *config_, _const gchar *section_, _const gchar *name_, _GVariant *value_)` ### Parameters #### Path Parameters - **config** (_IBusConfigService *) - Required - An IBusConfigService. - **section** (_const gchar *) - Required - Section name of the configuration option. - **name** (_const gchar *) - Required - Name of the configure option. - **value** (_GVariant *) - Required - GVariant that holds the value. ``` -------------------------------- ### ibus_input_context_new_async Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Asynchronously creates a new IBusInputContext object. ```APIDOC ## ibus_input_context_new_async ### Description Asynchronously creates a new IBusInputContext object. This is useful for non-blocking operations. ### Method `ibus_input_context_new_async` ### Parameters #### Path Parameters - **path_** (_const gchar_*) - The path to the object that emitting the signal. - **connection_** (_GDBusConnection_*) - An GDBusConnection. - **cancellable_** (_GCancellable_*) - A GCancellable or `NULL`. - **callback_** (_GAsyncReadyCallback_*) - A GAsyncReadyCallback to call when the request is satisfied. The callback should not be `NULL`. - **user_data_** (_gpointer_*) - The data to pass to callback. ### Returns - `void` ``` -------------------------------- ### ibus_bus_get_ibus_property_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an operation started with ibus_bus_get_ibus_property_async(). Retrieves the property value. ```APIDOC ## ibus_bus_get_ibus_property_async_finish ### Description Finishes an operation started with `ibus_bus_get_ibus_property_async()`. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - An IBusBus. - **res** (_GAsyncResult_*) - A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_bus_get_property_async()`. - **error** (_GError_**) - Return location for error or NULL. ### Returns - **GVariant*** - The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with `g_variant_unref()`. [transfer full] ``` -------------------------------- ### IBusInputContext Creation Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Functions for creating new IBusInputContext instances, both synchronously and asynchronously. ```APIDOC ## ibus_input_context_new ### Description Creates a new IBusInputContext synchronously. ### Method `ibus_input_context_new` ### Parameters - **path_** (_const gchar_): The path of the input context. - **connection_** (_GDBusConnection*): The GDBusConnection to use. - **cancellable_** (_GCancellable*): A GCancellable object for cancellation. - **error_** (_GError**): A pointer to a GError for error reporting. ### Returns An IBusInputContext pointer or NULL on failure. ## ibus_input_context_new_async ### Description Initiates the asynchronous creation of an IBusInputContext. ### Method `ibus_input_context_new_async` ### Parameters - **path_** (_const gchar_): The path of the input context. - **connection_** (_GDBusConnection*): The GDBusConnection to use. - **cancellable_** (_GCancellable*): A GCancellable object for cancellation. - **callback_** (_GAsyncReadyCallback_): The callback function to be called when the operation is complete. - **user_data_** (_gpointer_): User data to pass to the callback. ## ibus_input_context_new_async_finish ### Description Finishes the asynchronous creation of an IBusInputContext. ### Method `ibus_input_context_new_async_finish` ### Parameters - **res_** (_GAsyncResult*): The GAsyncResult from the asynchronous operation. - **error_** (_GError**): A pointer to a GError for error reporting. ### Returns An IBusInputContext pointer or NULL on failure. ``` -------------------------------- ### ibus_bus_release_name_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an asynchronous operation to release a name started with ibus_bus_release_name_async(). ```APIDOC ## ibus_bus_release_name_async_finish ### Description Finishes an operation started with `ibus_bus_release_name_async()`. ### Parameters #### Path Parameters - **bus** (_IBusBus) - An IBusBus. - **res** (_GAsyncResult) - A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_bus_release_name_async()`. - **error** (_GError) - Return location for error or `NULL`. ### Returns - **guint** - 0 if failed; positive number otherwise. ``` -------------------------------- ### ibus_bus_request_name_async_finish Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Finishes an asynchronous name request operation started with ibus_bus_request_name_async(). ```APIDOC ## ibus_bus_request_name_async_finish ### Description Finishes an operation started with `ibus_bus_request_name_async()`. ### Parameters * **bus** (_IBusBus) - An IBusBus instance. * **res** (_GAsyncResult *) - A GAsyncResult obtained from the GAsyncReadyCallback passed to `ibus_bus_request_name_async()`. * **error** (_GError **) - Return location for error or NULL. ### Returns 0 if failed; positive number otherwise. ``` -------------------------------- ### ibus_factory_create_engine Source: https://ibus.github.io/docs/ibus-1.5/IBusFactory.html Creates an IBusEngine instance by its name. ```APIDOC ## ibus_factory_create_engine ### Description Creates an IBusEngine with the specified engine name. ### Method `ibus_factory_create_engine` ### Parameters #### Path Parameters - **factory** (_IBusFactory *) - An IBusFactory. - **engine_name** (_const gchar *) - Name of the engine. ### Returns - IBusEngine * - An IBusEngine with the specified name. [transfer full] ``` -------------------------------- ### Create IBusConfig Instance Asynchronously Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Initiates the creation of an IBusConfig object asynchronously. A callback function is invoked upon completion, and user data can be passed along. ```c void ibus_config_new_async (_GDBusConnection *connection_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### ibus_input_context_get_engine Source: https://ibus.github.io/docs/ibus-1.5/api-index-full.html Gets the current input engine for the given input context. ```APIDOC ## ibus_input_context_get_engine ### Description Gets the current input engine for the given input context. ### Function Signature `ibus_input_context_get_engine(context)` ### Parameters - `context` (IBusInputContext): The input context. ### Returns (IBusEngine): The current input engine. ``` -------------------------------- ### IBusBus Get IBus Property Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Retrieves a property of the IBus system. ```APIDOC ## ibus_bus_get_ibus_property ### Description Retrieves a property of the IBus system. ### Method `ibus_bus_get_ibus_property` ### Parameters - `bus` (_IBusBus *) - The IBusBus instance. - `property_name` (_const gchar *) - The name of the property to retrieve. ### Returns - `GVariant *` - A GVariant representing the property value. ``` -------------------------------- ### ibus_input_context_get_engine_async Source: https://ibus.github.io/docs/ibus-1.5/IBusInputContext.html Asynchronously retrieves information about the current input engine. ```APIDOC ## ibus_input_context_get_engine_async ### Description Asynchronously retrieves information about the current input engine. ### Method void ### Parameters - **context** (_IBusInputContext *) - The input context. - **timeout_msec** (_gint) - The timeout in milliseconds. - **cancellable** (_GCancellable *) - A GCancellable object. - **callback** (_GAsyncReadyCallback) - The callback function. - **user_data** (_gpointer) - User data for the callback. ``` -------------------------------- ### Get Configuration Value Synchronously Source: https://ibus.github.io/docs/ibus-1.5/IBusConfig.html Retrieves the value of a configuration option from the IBusConfig. The section and name parameters specify the configuration path. ```c GVariant * ibus_config_get_value ( _IBusConfig *config_, _const gchar *section_, _const gchar *name_); ``` -------------------------------- ### Get IBusComponent Properties Source: https://ibus.github.io/docs/ibus-1.5/IBusComponent.html Retrieve various properties of an IBusComponent, such as its name, description, version, license, author, homepage, executable path, and text domain. ```c const gchar * ibus_component_get_name (_IBusComponent *component_); const gchar * ibus_component_get_description (_IBusComponent *component_); const gchar * ibus_component_get_version (_IBusComponent *component_); const gchar * ibus_component_get_license (_IBusComponent *component_); const gchar * ibus_component_get_author (_IBusComponent *component_); const gchar * ibus_component_get_homepage (_IBusComponent *component_); const gchar * ibus_component_get_exec (_IBusComponent *component_); const gchar * ibus_component_get_textdomain (_IBusComponent *component_); ``` -------------------------------- ### Finish Asynchronous Active Engine Listing (Deprecated) Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Completes an asynchronous operation started with `ibus_bus_list_active_engines_async()`. This function is deprecated; consider reading the dconf value /desktop/ibus/general/preload-engines instead. ```c GList * ibus_bus_list_active_engines_async_finish (_IBusBus *bus_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Create New IBusObject Source: https://ibus.github.io/docs/ibus-1.5/IBusObject.html Allocates and initializes a new IBusObject. Use this function to create instances of IBusObject. ```c IBusObject * ibus_object_new (_void_); ``` -------------------------------- ### ibus_bus_current_input_context Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Gets the name of the current input context. This is a synchronous operation. ```APIDOC ## ibus_bus_current_input_context ### Description Gets the name of the current input context. This is a synchronous operation. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - The IBusBus object. ### Return Value - **gchar*** - The name of the current input context, or NULL if none is set or an error occurred. ``` -------------------------------- ### ibus_bus_get_name_owner Source: https://ibus.github.io/docs/ibus-1.5/IBusBus.html Gets the owner of a given bus name. This is a synchronous operation. ```APIDOC ## ibus_bus_get_name_owner ### Description Gets the owner of a given bus name. This is a synchronous operation. ### Parameters #### Path Parameters - **bus** (_IBusBus_) - The IBusBus object. - **name** (_const gchar_) - The bus name to query. ### Return Value - **gchar*** - The name of the owner, or NULL if the name is not owned. ``` -------------------------------- ### IBusEngine Content Type Source: https://ibus.github.io/docs/ibus-1.5/IBusEngine.html Function to get the content type information. ```APIDOC ## ibus_engine_get_content_type ### Description Retrieves the content purpose and hints for the current input context. ### Method `ibus_engine_get_content_type` ### Parameters - **engine_** (_IBusEngine *) - The IBusEngine instance. - **purpose_** (_guint *) - Pointer to store the content purpose. - **hints_** (_guint *) - Pointer to store the content hints. ``` -------------------------------- ### Create IBusEngineDesc with variable arguments Source: https://ibus.github.io/docs/ibus-1.5/IBusEngineDesc.html This function allows for creating an IBusEngineDesc instance using a variable number of arguments, starting with the first property name. Use this when not all properties are known at compile time or for flexibility. ```c IBusEngineDesc * ibus_engine_desc_new_varargs (_const gchar *first_property_name_, _..._); ```