ibusbus.h | ibusbus.h | |||
---|---|---|---|---|
skipping to change at line 128 | skipping to change at line 128 | |||
*/ | */ | |||
const gchar *ibus_bus_hello (IBusBus *bus); | const gchar *ibus_bus_hello (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_request_name: | * ibus_bus_request_name: | |||
* @bus: the IBusBus instance to be processed. | * @bus: the IBusBus instance to be processed. | |||
* @name: Name to be requested. | * @name: Name to be requested. | |||
* @flags: Flags (FixMe). | * @flags: Flags (FixMe). | |||
* @returns: 0 if failed; positive number otherwise. | * @returns: 0 if failed; positive number otherwise. | |||
* | * | |||
* Request a name from IBus daemon. | * Request a name from IBus daemon synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
guint ibus_bus_request_name (IBusBus *bus, | guint ibus_bus_request_name (IBusBus *bus, | |||
const gchar *name, | const gchar *name, | |||
guint flags); | guint flags); | |||
/** | /** | |||
* ibus_bus_release_name: | * ibus_bus_release_name: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @name: Name to be released. | * @name: Name to be released. | |||
* @returns: 0 if failed; positive number otherwise. | * @returns: 0 if failed; positive number otherwise. | |||
* | * | |||
* Release a name to IBus daemon. | * Release a name to IBus daemon synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
guint ibus_bus_release_name (IBusBus *bus, | guint ibus_bus_release_name (IBusBus *bus, | |||
const gchar *name); | const gchar *name); | |||
/** | /** | |||
* ibus_bus_name_has_owner: | * ibus_bus_name_has_owner: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @name: Name to be released. | * @name: Name to be released. | |||
* @returns: TRUE if the name has owner, FALSE otherwise. | * @returns: TRUE if the name has owner, FALSE otherwise. | |||
* | * | |||
* Whether the name has owner. | * Whether the name has owner synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gboolean ibus_bus_name_has_owner (IBusBus *bus, | gboolean ibus_bus_name_has_owner (IBusBus *bus, | |||
const gchar *name); | const gchar *name); | |||
/** | /** | |||
* ibus_bus_list_names: | * ibus_bus_list_names: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: (transfer full) (element-type utf8): Lists that attached to @b us. | * @returns: (transfer full) (element-type utf8): Lists that attached to @b us. | |||
* | * | |||
* Return lists that attached to @bus. | * Return lists that attached to @bus. | |||
* <note><para>[FixMe] Not implemented yet, only return NULL.</para></note> | * <note><para>[FixMe] Not implemented yet, only return NULL.</para></note> | |||
*/ | */ | |||
GList *ibus_bus_list_names (IBusBus *bus); | GList *ibus_bus_list_names (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_add_match: | * ibus_bus_add_match: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @rule: Match rule. | * @rule: Match rule. | |||
* | * | |||
* Add a match rule to an IBusBus. | * Add a match rule to an IBusBus synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
void ibus_bus_add_match (IBusBus *bus, | void ibus_bus_add_match (IBusBus *bus, | |||
const gchar *rule); | const gchar *rule); | |||
/** | /** | |||
* ibus_bus_remove_match: | * ibus_bus_remove_match: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @rule: Match rule. | * @rule: Match rule. | |||
* | * | |||
* Remove a match rule to an IBusBus. | * Remove a match rule to an IBusBus synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
void ibus_bus_remove_match (IBusBus *bus, | void ibus_bus_remove_match (IBusBus *bus, | |||
const gchar *rule); | const gchar *rule); | |||
/** | /** | |||
* ibus_bus_get_name_owner: | * ibus_bus_get_name_owner: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @name: Name. | * @name: Name. | |||
* @returns: Owner of the name. The returned value must be freed with g_fre e(). | * @returns: Owner of the name. The returned value must be freed with g_fre e(). | |||
* | * | |||
* Return the name owner. | * Return the name owner synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gchar *ibus_bus_get_name_owner (IBusBus *bus, | gchar *ibus_bus_get_name_owner (IBusBus *bus, | |||
const gchar *name); | const gchar *name); | |||
/* declare ibus methods */ | /* declare ibus methods */ | |||
/** | /** | |||
* ibus_bus_exit: | * ibus_bus_exit: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @restart: Whether restarting the ibus. | * @restart: Whether restarting the ibus. | |||
* @returns: TRUE if the "Exit" call is suceeded, FALSE otherwise. | * @returns: TRUE if the "Exit" call is suceeded, FALSE otherwise. | |||
* | * | |||
* Exit or restart an IBusBus. | * Exit or restart an IBusBus synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gboolean ibus_bus_exit (IBusBus *bus, | gboolean ibus_bus_exit (IBusBus *bus, | |||
gboolean restart); | gboolean restart); | |||
/** | /** | |||
* ibus_bus_create_input_context: | * ibus_bus_create_input_context: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @client_name: Name of client. | * @client_name: Name of client. | |||
* @returns: An newly allocated IBusInputContext if the "CreateInputContext " call | * @returns: An newly allocated IBusInputContext if the "CreateInputContext " call | |||
* is suceeded, NULL otherwise. | * is suceeded, NULL otherwise. | |||
* | * | |||
* Create an input context for client. | * Create an input context for client synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
IBusInputContext | IBusInputContext | |||
*ibus_bus_create_input_context | *ibus_bus_create_input_context | |||
(IBusBus *bus, | (IBusBus *bus, | |||
const gchar *client_name); | const gchar *client_name); | |||
/** | /** | |||
* ibus_bus_current_input_context: | * ibus_bus_current_input_context: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: The named of currently focued IBusInputContext if the | * @returns: The named of currently focued IBusInputContext if the | |||
* "CurrentInputContext" call suceeded, NULL otherwise. The retu rn | * "CurrentInputContext" call suceeded, NULL otherwise. The retu rn | |||
* value must be freed with g_free(). | * value must be freed with g_free(). | |||
* | * | |||
* Get the current focused input context. | * Get the current focused input context synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gchar *ibus_bus_current_input_context(IBusBus *bus); | gchar *ibus_bus_current_input_context(IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_register_component: | * ibus_bus_register_component: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @component: A input engine component. | * @component: A input engine component. | |||
* @returns: TRUE if the "RegisterComponent" call is suceeded, FALSE otherw ise. | * @returns: TRUE if the "RegisterComponent" call is suceeded, FALSE otherw ise. | |||
* | * | |||
* Register a componet to an IBusBus. | * Register a componet to an IBusBus synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gboolean ibus_bus_register_component(IBusBus *bus, | gboolean ibus_bus_register_component(IBusBus *bus, | |||
IBusComponent *component); | IBusComponent *component); | |||
/** | /** | |||
* ibus_bus_list_engines: | * ibus_bus_list_engines: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: (transfer container) (element-type IBusEngineDesc): A List of engines. | * @returns: (transfer container) (element-type IBusEngineDesc): A List of engines. | |||
* | * | |||
* List engines. | * List engines synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
GList *ibus_bus_list_engines (IBusBus *bus); | GList *ibus_bus_list_engines (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_list_active_engines: | * ibus_bus_list_active_engines: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: (transfer container) (element-type IBusEngineDesc): A List of active engines. | * @returns: (transfer container) (element-type IBusEngineDesc): A List of active engines. | |||
* | * | |||
* List active engines. | * List active engines synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
GList *ibus_bus_list_active_engines | GList *ibus_bus_list_active_engines | |||
(IBusBus *bus); | (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_get_use_sys_layout: | * ibus_bus_get_use_sys_layout: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: TRUE if "use_sys_layout" option is enabled. | * @returns: TRUE if "use_sys_layout" option is enabled. | |||
* | * | |||
* Check if the bus's "use_sys_layout" option is enabled or not. | * Check if the bus's "use_sys_layout" option is enabled or not synchronous | |||
ly. | ||||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gboolean ibus_bus_get_use_sys_layout(IBusBus *bus); | gboolean ibus_bus_get_use_sys_layout(IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_get_use_global_engine: | * ibus_bus_get_use_global_engine: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: TRUE if "use_global_engine" option is enabled. | * @returns: TRUE if "use_global_engine" option is enabled. | |||
* | * | |||
* Check if the bus's "use_global_engine" option is enabled or not. | * Check if the bus's "use_global_engine" option is enabled or not synchron | |||
ously. | ||||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gboolean ibus_bus_get_use_global_engine | gboolean ibus_bus_get_use_global_engine | |||
(IBusBus *bus); | (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_is_global_engine_enabled: | * ibus_bus_is_global_engine_enabled: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: TRUE if the current global engine is enabled. | * @returns: TRUE if the current global engine is enabled. | |||
* | * | |||
* Check if the current global engine is enabled or not. | * Check if the current global engine is enabled or not synchronously. | |||
* | ||||
* FIXME add an asynchronous version. | ||||
*/ | */ | |||
gboolean ibus_bus_is_global_engine_enabled | gboolean ibus_bus_is_global_engine_enabled | |||
(IBusBus *bus); | (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_get_global_engine: | * ibus_bus_get_global_engine: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @returns: The description of current global engine, or NULL if there is no | * @returns: The description of current global engine, or NULL if there is no | |||
* global engine. | * global engine. | |||
* | * | |||
* Get the description of current global engine. | * Get the description of current global engine synchronously. | |||
*/ | */ | |||
IBusEngineDesc | IBusEngineDesc | |||
*ibus_bus_get_global_engine (IBusBus *bus); | *ibus_bus_get_global_engine (IBusBus *bus); | |||
/** | /** | |||
* ibus_bus_set_global_engine: | * ibus_bus_set_global_engine: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @global_engine: A new engine name. | * @global_engine: A new engine name. | |||
* @returns: TRUE if the global engine was set successfully. | * @returns: TRUE if the global engine was set successfully. | |||
* | * | |||
* Set current global engine. | * Set current global engine synchronously. | |||
*/ | */ | |||
gboolean ibus_bus_set_global_engine (IBusBus *bus, | gboolean ibus_bus_set_global_engine (IBusBus *bus, | |||
const gchar *global_engine); | const gchar *global_engine); | |||
/** | /** | |||
* ibus_bus_set_global_engine_async: | ||||
* @bus: An IBusBus. | ||||
* @global_engine: A new engine name. | ||||
* @timeout_msec: The timeout in milliseconds or -1 to use the default time | ||||
out. | ||||
* @cancellable: A GCancellable or NULL. | ||||
* @callback: A GAsyncReadyCallback to call when the request is satisfied o | ||||
r NULL | ||||
* if you don't care about the result of the method invocation. | ||||
* @user_data: The data to pass to callback. | ||||
* | ||||
* Set current global engine asynchronously. | ||||
*/ | ||||
void ibus_bus_set_global_engine_async (IBusBus *bus, | ||||
const gchar *global_engine, | ||||
gint timeout_msec, | ||||
GCancellable *cancellable, | ||||
GAsyncReadyCallback callback, | ||||
gpointer user_data); | ||||
/** | ||||
* ibus_bus_set_global_engine_async_finish: | ||||
* @bus: An IBusBus. | ||||
* @res: A GAsyncResult obtained from the GAsyncReadyCallback passed to | ||||
* ibus_bus_set_global_engine(). | ||||
* @error: Return location for error or NULL. | ||||
* @returns: TRUE if no IPC errros. FALSE otherwise. | ||||
* | ||||
* Finishes an operation started with ibus_bus_set_global_engine(). | ||||
*/ | ||||
gboolean ibus_bus_set_global_engine_async_finish (IBusBus *bus, | ||||
GAsyncResult *res, | ||||
GError **error); | ||||
/** | ||||
* ibus_bus_set_watch_dbus_signal: | ||||
* @bus: An IBusBus. | ||||
* @watch: TRUE if you want ibusbus to emit "name-owner-changed" signal whe | ||||
n | ||||
* ibus-daemon emits the NameOwnerChanged DBus signal. | ||||
* | ||||
* Start or stop watching the NameOwnerChange DBus signal. | ||||
*/ | ||||
void ibus_bus_set_watch_dbus_signal | ||||
(IBusBus *bus, | ||||
gboolean watch); | ||||
/** | ||||
* ibus_bus_set_watch_ibus_signal: | * ibus_bus_set_watch_ibus_signal: | |||
* @bus: An IBusBus. | * @bus: An IBusBus. | |||
* @watch: TRUE if you want ibusbus to emit "global-engine-changed" signal when | * @watch: TRUE if you want ibusbus to emit "global-engine-changed" signal when | |||
* ibus-daemon emits the GlobalEngineChanged IBus signal. | * ibus-daemon emits the GlobalEngineChanged IBus signal. | |||
* | * | |||
* Start or stop watching the GlobalEngineChanged IBus signal. | * Start or stop watching the GlobalEngineChanged IBus signal. | |||
*/ | */ | |||
void ibus_bus_set_watch_ibus_signal | void ibus_bus_set_watch_ibus_signal | |||
(IBusBus *bus, | (IBusBus *bus, | |||
gboolean watch); | gboolean watch); | |||
End of changes. 18 change blocks. | ||||
17 lines changed or deleted | 97 lines changed or added | |||
ibusconfig.h | ibusconfig.h | |||
---|---|---|---|---|
skipping to change at line 100 | skipping to change at line 100 | |||
GCancellable *cancellabl e, | GCancellable *cancellabl e, | |||
GError **error); | GError **error); | |||
/** | /** | |||
* ibus_config_get_value: | * ibus_config_get_value: | |||
* @config: An IBusConfig | * @config: An IBusConfig | |||
* @section: Section name of the configuration option. | * @section: Section name of the configuration option. | |||
* @name: Name of the configure option. | * @name: Name of the configure option. | |||
* @returns: A #GVariant or %NULL. Free with g_variant_unref(). | * @returns: A #GVariant or %NULL. Free with g_variant_unref(). | |||
* | * | |||
* Get the value of a configuration option. | * Get the value of a configuration option synchronously. | |||
* | * | |||
* GConf stores configure options in a tree-like structure, | * GConf stores configure options in a tree-like structure, | |||
* and the IBus related setting is at /desktop/ibus, | * and the IBus related setting is at /desktop/ibus, | |||
* thus, @section here is a path from there, | * thus, @section here is a path from there, | |||
* while @name is the key of that configuration option. | * while @name is the key of that configuration option. | |||
* | * | |||
* ibus-chewing, for example, stores its setting in /desktop/ibus/engine/Ch ewing, | * ibus-chewing, for example, stores its setting in /desktop/ibus/engine/Ch ewing, | |||
* so the section name for it is "engine/Chewing". | * so the section name for it is "engine/Chewing". | |||
* @see_also: ibus_config_set_value. | * @see_also: ibus_config_set_value. | |||
*/ | */ | |||
GVariant *ibus_config_get_value (IBusConfig *config, | GVariant *ibus_config_get_value (IBusConfig *config, | |||
const gchar *section, | const gchar *section, | |||
const gchar *name); | const gchar *name); | |||
/** | /** | |||
* ibus_config_get_value_async: | * ibus_config_get_value_async: | |||
* @config: An IBusConfig | * @config: An IBusConfig | |||
* @section: Section name of the configuration option. | * @section: Section name of the configuration option. | |||
* @name: Name of the configure option. | * @name: Name of the configure option. | |||
* @timeout_msec: The timeout in milliseconds or -1 to use the default time out. | ||||
* @cancellable: A #GCancellable or %NULL. | * @cancellable: A #GCancellable or %NULL. | |||
* @callback: Callback function to invoke when the return value is ready. | * @callback: Callback function to invoke when the return value is ready. | |||
* @user_data: The data to pass to callback. | ||||
* | * | |||
* Get the value of a configuration option. | * Get the value of a configuration option asynchronously. | |||
* | * | |||
* @see_also: ibus_config_get_value. | * @see_also: ibus_config_get_value. | |||
*/ | */ | |||
void ibus_config_get_value_async(IBusConfig *config, | void ibus_config_get_value_async (IBusConfig *config, | |||
const gchar *section, | const gchar *section, | |||
const gchar *name, | const gchar *name, | |||
GCancellable *cancellabl | gint timeout_m | |||
e, | s, | |||
GAsyncReadyCallback callback, | GCancellable *cancellab | |||
gpointer user_data) | le, | |||
; | GAsyncReadyCallback callback, | |||
gpointer user_data | ||||
); | ||||
/** | /** | |||
* ibus_config_get_value_async_finish: | * ibus_config_get_value_async_finish: | |||
* @confi: A #IBusConfig. | * @confi: A #IBusConfig. | |||
* @result: A #GAsyncResult. | * @result: A #GAsyncResult. | |||
* @error: Return location for error or %NULL. | * @error: Return location for error or %NULL. | |||
* @returns: A #GVariant or %NULL if error is set. Free with g_variant_unre f(). | * @returns: A #GVariant or %NULL if error is set. Free with g_variant_unre f(). | |||
* | * | |||
* Finish get value of a configuration option. | * Finish get value of a configuration option. | |||
* | * | |||
skipping to change at line 155 | skipping to change at line 158 | |||
GVariant *ibus_config_get_value_async_finish | GVariant *ibus_config_get_value_async_finish | |||
(IBusConfig *config, | (IBusConfig *config, | |||
GAsyncResult *result, | GAsyncResult *result, | |||
GError **error); | GError **error); | |||
/** | /** | |||
* ibus_config_set_value: | * ibus_config_set_value: | |||
* @config: An IBusConfig | * @config: An IBusConfig | |||
* @section: Section name of the configuration option. | * @section: Section name of the configuration option. | |||
* @name: Name of the configure option its self. | * @name: Name of the configure option its self. | |||
* @value: A #GVariant that holds the value. | * @value: A #GVariant that holds the value. If the value is floating, the | |||
* function takes ownership of it. | ||||
* @returns: TRUE if succeed; FALSE otherwise. | * @returns: TRUE if succeed; FALSE otherwise. | |||
* | * | |||
* Set the value of a configuration option. | * Set the value of a configuration option synchronously. | |||
* @see_also: ibus_config_get_value. | * @see_also: ibus_config_get_value. | |||
*/ | */ | |||
gboolean ibus_config_set_value (IBusConfig *config, | gboolean ibus_config_set_value (IBusConfig *config, | |||
const gchar *section, | const gchar *section, | |||
const gchar *name, | const gchar *name, | |||
GVariant *value); | GVariant *value); | |||
/** | /** | |||
* ibus_config_set_value_async: | * ibus_config_set_value_async: | |||
* @config: An #IBusConfig | * @config: An #IBusConfig | |||
* @section: Section name of the configuration option. | * @section: Section name of the configuration option. | |||
* @name: Name of the configure option. | * @name: Name of the configure option. | |||
* @value: A #GVariant that holds the value. | * @value: A #GVariant that holds the value. If the value is floating, the | |||
* function takes ownership of it. | ||||
* @timeout_msec: The timeout in milliseconds or -1 to use the default time | ||||
out. | ||||
* @cancellable: A #GCancellable or %NULL. | * @cancellable: A #GCancellable or %NULL. | |||
* @callback: Callback function to invoke when the return value is ready. | * @callback: Callback function to invoke when the return value is ready. | |||
* @user_data: The data to pass to callback. | ||||
* | * | |||
* Set the value of a configuration option. | * Set the value of a configuration option asynchronously. | |||
* | * | |||
* @see_also: ibus_config_set_value. | * @see_also: ibus_config_set_value. | |||
*/ | */ | |||
void ibus_config_set_value_async(IBusConfig *config, | void ibus_config_set_value_async (IBusConfig *config, | |||
const gchar *section, | const gchar *section, | |||
const gchar *name, | const gchar *name, | |||
GVariant *value, | GVariant *value, | |||
GCancellable *cancellabl | gint timeout_m | |||
e, | s, | |||
GAsyncReadyCallback callback, | GCancellable *cancellab | |||
gpointer user_data) | le, | |||
; | GAsyncReadyCallback callback, | |||
gpointer user_data | ||||
); | ||||
/** | /** | |||
* ibus_config_set_value_async_finish: | * ibus_config_set_value_async_finish: | |||
* @confi: A #IBusConfig. | * @confi: A #IBusConfig. | |||
* @result: A #GAsyncResult. | * @result: A #GAsyncResult. | |||
* @error: Return location for error or %NULL. | * @error: Return location for error or %NULL. | |||
* @returns: %TRUE or %FALSE if error is set. | * @returns: %TRUE or %FALSE if error is set. | |||
* | * | |||
* Finish set value of a configuration option. | * Finish set value of a configuration option. | |||
* | * | |||
skipping to change at line 216 | skipping to change at line 224 | |||
* @section: Section name of the configuration option. | * @section: Section name of the configuration option. | |||
* @name: Name of the configure option its self. | * @name: Name of the configure option its self. | |||
* @returns: TRUE if succeed; FALSE otherwise. | * @returns: TRUE if succeed; FALSE otherwise. | |||
* | * | |||
* Remove an entry of a configuration option. | * Remove an entry of a configuration option. | |||
* @see_also: ibus_config_get_value. | * @see_also: ibus_config_get_value. | |||
*/ | */ | |||
gboolean ibus_config_unset (IBusConfig *config, | gboolean ibus_config_unset (IBusConfig *config, | |||
const gchar *section, | const gchar *section, | |||
const gchar *name); | const gchar *name); | |||
/* FIXME add an asynchronous version of unset */ | ||||
G_END_DECLS | G_END_DECLS | |||
#endif | #endif | |||
End of changes. 12 change blocks. | ||||
23 lines changed or deleted | 37 lines changed or added | |||