| ibusbus.h | | ibusbus.h | |
| | | | |
| skipping to change at line 72 | | skipping to change at line 72 | |
| typedef struct _IBusBus IBusBus; | | typedef struct _IBusBus IBusBus; | |
| typedef struct _IBusBusClass IBusBusClass; | | typedef struct _IBusBusClass IBusBusClass; | |
| typedef struct _IBusBusPrivate IBusBusPrivate; | | typedef struct _IBusBusPrivate IBusBusPrivate; | |
| | | | |
| /** | | /** | |
| * IBusBus: | | * IBusBus: | |
| * | | * | |
| * An opaque data type representing IBus bus (daemon communication) status. | | * An opaque data type representing IBus bus (daemon communication) status. | |
| */ | | */ | |
| struct _IBusBus { | | struct _IBusBus { | |
|
| IBusObject parent; | | IBusObject parent; | |
| /* instance members */ | | /* instance members */ | |
| | | | |
|
| IBusBusPrivate *priv; | | IBusBusPrivate *priv; | |
| }; | | }; | |
| | | | |
| struct _IBusBusClass { | | struct _IBusBusClass { | |
|
| IBusObjectClass parent; | | IBusObjectClass parent; | |
| /* class members */ | | /* class members */ | |
| }; | | }; | |
| | | | |
| GType ibus_bus_get_type (void); | | GType ibus_bus_get_type (void); | |
|
| | | | |
| /** | | /** | |
| * ibus_bus_new: | | * ibus_bus_new: | |
|
| * @returns: A newly allocated IBusBus instance, and the instance is not fl
oating. | | * @returns: A newly allocated #IBusBus instance, and the instance is not f
loating. | |
| * | | * | |
|
| * New an IBusBus instance. | | * New an #IBusBus instance. | |
| */ | | */ | |
| IBusBus *ibus_bus_new (void); | | IBusBus *ibus_bus_new (void); | |
| | | | |
| /** | | /** | |
| * ibus_bus_is_connected: | | * ibus_bus_is_connected: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @returns: TRUE if @bus is connected, FALSE otherwise. | | * @returns: %TRUE if @bus is connected, %FALSE otherwise. | |
| * | | * | |
|
| * Return TRUE if @bus is connected to IBus daemon. | | * Return %TRUE if @bus is connected to IBus daemon. | |
| */ | | */ | |
| gboolean ibus_bus_is_connected (IBusBus *bus); | | gboolean ibus_bus_is_connected (IBusBus *bus); | |
| | | | |
| /** | | /** | |
| * ibus_bus_get_connection: | | * ibus_bus_get_connection: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @returns: (transfer none): A GDBusConnection of an IBusIBus instance. | | * @returns: (transfer none): A #GDBusConnection of an #IBusIBus instance. | |
| * | | * | |
|
| * Return GDBusConnection of an IBusIBus instance. | | * Return #GDBusConnection of an #IBusIBus instance. | |
| */ | | */ | |
|
| GDBusConnection | | GDBusConnection * | |
| *ibus_bus_get_connection (IBusBus *bus); | | ibus_bus_get_connection (IBusBus *bus); | |
| | | | |
| /** | | /** | |
| * ibus_bus_hello: | | * ibus_bus_hello: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @returns: The unique name of IBus process in DBus. | | * @returns: The unique name of #IBus process in DBus. | |
| * | | * | |
| * This function sends a "HELLO" message to DBus daemon, | | * This function sends a "HELLO" message to DBus daemon, | |
| * which replies the unique name of current IBus process. | | * which replies the unique name of current IBus process. | |
| */ | | */ | |
| 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 synchronously. | | * 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_request_name_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @name: Name to be requested. | |
| | | * @flags: Flags (FixMe). | |
| | | * @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 | |
| | | or %NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Request a name from IBus daemon asynchronously. | |
| | | */ | |
| | | void ibus_bus_request_name_async (IBusBus *bus, | |
| | | const gchar *name, | |
| | | guint flags, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_request_name_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_request_name_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: 0 if failed; positive number otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_request_name_async(). | |
| | | */ | |
| | | guint ibus_bus_request_name_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 synchronously. | | * 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_release_name_async: | |
| * @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. | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| * | | * | |
|
| * Whether the name has owner synchronously. | | * Release a name to IBus daemon asynchronously. | |
| | | */ | |
| | | void ibus_bus_release_name_async | |
| | | (IBusBus *bus, | |
| | | const gchar *name, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_release_name_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_release_name_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: 0 if failed; positive number otherwise. | |
| * | | * | |
|
| * FIXME add an asynchronous version. | | * Finishes an operation started with ibus_bus_release_name_async(). | |
| | | */ | |
| | | guint ibus_bus_release_name_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| | | * ibus_bus_name_has_owner: | |
| | | * @bus: An #IBusBus. | |
| | | * @name: Name to be checked. | |
| | | * @returns: %TRUE if the name has owner, %FALSE otherwise. | |
| | | * | |
| | | * Checks whether the name has owner synchronously. | |
| */ | | */ | |
| gboolean ibus_bus_name_has_owner (IBusBus *bus, | | gboolean ibus_bus_name_has_owner (IBusBus *bus, | |
| const gchar *name); | | const gchar *name); | |
| | | | |
| /** | | /** | |
|
| | | * ibus_bus_name_has_owner_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @name: Name to be checked. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Checks whether the name has owner asynchronously. | |
| | | */ | |
| | | void ibus_bus_name_has_owner_async | |
| | | (IBusBus *bus, | |
| | | const gchar *name, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_name_has_owner_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_name_has_owner_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if the name has owner, %FALSE otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_name_has_owner_async(). | |
| | | */ | |
| | | gboolean ibus_bus_name_has_owner_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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> | |
|
| | | * <note><para>[FixMe] Add async version.</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. | |
|
| | | * @returns: %TRUE if the rule is added. %FALSE otherwise. | |
| * | | * | |
|
| * Add a match rule to an IBusBus synchronously. | | * Add a match rule to an #IBusBus synchronously. | |
| * | | | |
| * FIXME add an asynchronous version. | | | |
| */ | | */ | |
|
| void ibus_bus_add_match (IBusBus *bus, | | gboolean ibus_bus_add_match (IBusBus *bus, | |
| const gchar *rule); | | const gchar *rule); | |
| | | | |
| /** | | /** | |
|
| * ibus_bus_remove_match: | | * ibus_bus_add_match_async: | |
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @rule: Match rule. | | * @rule: Match rule. | |
|
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| * | | * | |
|
| * Remove a match rule to an IBusBus synchronously. | | * Add a match rule to an #IBusBus asynchronously. | |
| | | */ | |
| | | void ibus_bus_add_match_async (IBusBus *bus, | |
| | | const gchar *rule, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_add_match_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_add_match_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if the rule is added. %FALSE otherwise. | |
| * | | * | |
|
| * FIXME add an asynchronous version. | | * Finishes an operation started with ibus_bus_add_match_async(). | |
| */ | | */ | |
|
| void ibus_bus_remove_match (IBusBus *bus, | | gboolean ibus_bus_add_match_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| | | * ibus_bus_remove_match: | |
| | | * @bus: An #IBusBus. | |
| | | * @rule: Match rule. | |
| | | * @returns: %TRUE if the rule is removed. %FALSE otherwise. | |
| | | * | |
| | | * Remove a match rule to an #IBusBus synchronously. | |
| | | */ | |
| | | gboolean ibus_bus_remove_match (IBusBus *bus, | |
| const gchar *rule); | | const gchar *rule); | |
| | | | |
| /** | | /** | |
|
| | | * ibus_bus_remove_match_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @rule: Match rule. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Remove a match rule to an IBusBus asynchronously. | |
| | | */ | |
| | | void ibus_bus_remove_match_async | |
| | | (IBusBus *bus, | |
| | | const gchar *rule, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_remove_match_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_remove_match_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if the rule is removed. %FALSE otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_remove_match_async(). | |
| | | */ | |
| | | gboolean ibus_bus_remove_match_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 synchronously. | | * 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); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_get_name_owner_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @name: 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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Return the name owner asynchronously. | |
| | | */ | |
| | | void ibus_bus_get_name_owner_async | |
| | | (IBusBus *bus, | |
| | | const gchar *name, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_get_name_owner_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_get_name_owner_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: Owner of the name. The returned value must be freed with g_fre | |
| | | e(). | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_get_name_owner_async(). | |
| | | */ | |
| | | gchar *ibus_bus_get_name_owner_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| /* 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 synchronously. | | * Exit or restart ibus-daemon synchronously. | |
| * | | | |
| * FIXME add an asynchronous version. | | | |
| */ | | */ | |
| gboolean ibus_bus_exit (IBusBus *bus, | | gboolean ibus_bus_exit (IBusBus *bus, | |
| gboolean restart); | | gboolean restart); | |
| | | | |
| /** | | /** | |
|
| | | * ibus_bus_exit_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @restart: Whether restarting the ibus. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Exit or restart ibus-daemon asynchronously. | |
| | | */ | |
| | | void ibus_bus_exit_async (IBusBus *bus, | |
| | | gboolean restart, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_exit_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_exit_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if the "Exit" call is suceeded, %FALSE otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_exit_async(). | |
| | | */ | |
| | | gboolean ibus_bus_exit_async_finish (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 | | * @returns: An newly allocated #IBusInputContext if the "CreateInputContex | |
| " call | | t" | |
| * is suceeded, NULL otherwise. | | * call is suceeded, %NULL otherwise. | |
| * | | * | |
| * Create an input context for client synchronously. | | * 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_create_input_context_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @client_name: Name of client. | |
| | | * @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. | |
| | | * It should not be %NULL. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Create an input context for client asynchronously. | |
| | | */ | |
| | | void ibus_bus_create_input_context_async | |
| | | (IBusBus *bus, | |
| | | const gchar *client_name, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_create_input_context_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_create_input_context_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: An newly allocated #IBusInputContext if the "CreateInputContex | |
| | | t" | |
| | | * call is suceeded, %NULL otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_create_input_context_async() | |
| | | . | |
| | | */ | |
| | | IBusInputContext * | |
| | | ibus_bus_create_input_context_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 | | * "CurrentInputContext" call suceeded, %NULL otherwise. The ret | |
| rn | | urn | |
| * value must be freed with g_free(). | | * value must be freed with g_free(). | |
| * | | * | |
| * Get the current focused input context synchronously. | | * Get the current focused input context synchronously. | |
|
| | | */ | |
| | | gchar *ibus_bus_current_input_context | |
| | | (IBusBus *bus); | |
| | | | |
| | | /** | |
| | | * ibus_bus_current_input_context_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Get the current focused input context asynchronously. | |
| | | */ | |
| | | void ibus_bus_current_input_context_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_current_input_context_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_current_input_context_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: The named of currently focued IBusInputContext if the | |
| | | * "CurrentInputContext" call suceeded, %NULL otherwise. The ret | |
| | | urn | |
| | | * value must be freed with g_free(). | |
| * | | * | |
|
| * FIXME add an asynchronous version. | | * Finishes an operation started with ibus_bus_current_input_context_async(
). | |
| */ | | */ | |
|
| gchar *ibus_bus_current_input_context(IBusBus *bus); | | gchar *ibus_bus_current_input_context_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| /** | | /** | |
| * 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 | | * @returns: %TRUE if the "RegisterComponent" call is suceeded, %FALSE othe | |
| ise. | | rwise. | |
| * | | | |
| * Register a componet to an IBusBus synchronously. | | | |
| * | | * | |
|
| * FIXME add an asynchronous version. | | * Register a componet to an #IBusBus synchronously. | |
| */ | | */ | |
|
| gboolean ibus_bus_register_component(IBusBus *bus, | | gboolean ibus_bus_register_component | |
| | | (IBusBus *bus, | |
| IBusComponent *component); | | IBusComponent *component); | |
| | | | |
| /** | | /** | |
|
| | | * ibus_bus_register_component_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @component: A input engine component. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Register a componet to an #IBusBus asynchronously. | |
| | | */ | |
| | | void ibus_bus_register_component_async | |
| | | (IBusBus *bus, | |
| | | IBusComponent *component, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_register_component_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_register_component_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if the "RegisterComponent" call is suceeded, %FALSE othe | |
| | | rwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_register_component_async(). | |
| | | */ | |
| | | gboolean ibus_bus_register_component_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 synchronously. | | * 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_engines_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | or %NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * List engines asynchronously. | |
| | | */ | |
| | | void ibus_bus_list_engines_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_list_engines_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_list_engines_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: (transfer container) (element-type IBusEngineDesc): A List of | |
| | | engines. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_list_engines_async(). | |
| | | */ | |
| | | GList *ibus_bus_list_engines_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 synchronously. | | * 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_list_active_engines_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | or %NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * List active engines asynchronously. | |
| | | */ | |
| | | void ibus_bus_list_active_engines_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_list_active_engines_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_list_active_engines_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: (transfer container) (element-type IBusEngineDesc): A List of | |
| | | active engines. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_list_active_engines_async(). | |
| | | */ | |
| | | GList *ibus_bus_list_active_engines_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 synchronous
ly. | | * Check if the bus's "use_sys_layout" option is enabled or not synchronous
ly. | |
|
| | | */ | |
| | | gboolean ibus_bus_get_use_sys_layout | |
| | | (IBusBus *bus); | |
| | | | |
| | | /** | |
| | | * ibus_bus_get_use_sys_layout_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Check if the bus's "use_sys_layout" option is enabled or not asynchronou | |
| | | sly. | |
| | | */ | |
| | | void ibus_bus_get_use_sys_layout_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_get_use_sys_layout_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_get_use_sys_layout_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: TRUE if "use_sys_layout" option is enabled. | |
| * | | * | |
|
| * FIXME add an asynchronous version. | | * Finishes an operation started with ibus_bus_get_use_sys_layout_async(). | |
| */ | | */ | |
|
| gboolean ibus_bus_get_use_sys_layout(IBusBus *bus); | | gboolean ibus_bus_get_use_sys_layout_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| /** | | /** | |
| * 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 synchron
ously. | | * 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_get_use_global_engine_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Check if the bus's "use_global_engine" option is enabled or not asynchro | |
| | | nously. | |
| | | */ | |
| | | void ibus_bus_get_use_global_engine_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_get_use_global_engine_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_get_use_global_engine_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if "use_global_engine" option is enabled. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_get_use_global_engine_async( | |
| | | ). | |
| | | */ | |
| | | gboolean ibus_bus_get_use_global_engine_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 synchronously. | | * 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_is_global_engine_enabled_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | * or %NULL if you don't care about the result of the method invocatio | |
| | | n. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Check if the current global engine is enabled or not asynchronously. | |
| | | */ | |
| | | void ibus_bus_is_global_engine_enabled_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_is_global_engine_enabled_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_is_global_engine_enabled_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE if the current global engine is enabled. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_is_global_engine_enabled_asy | |
| | | nc(). | |
| | | */ | |
| | | gboolean ibus_bus_is_global_engine_enabled_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * 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 | | * @returns: The description of current global engine, or %NULL if there is | |
| no | | no | |
| * global engine. | | * global engine. | |
| * | | * | |
| * Get the description of current global engine synchronously. | | * 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_get_global_engine_async: | |
| | | * @bus: An #IBusBus. | |
| | | * @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 | |
| | | or %NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Get the description of current global engine asynchronously. | |
| | | */ | |
| | | void ibus_bus_get_global_engine_async | |
| | | (IBusBus *bus, | |
| | | gint timeout_msec, | |
| | | GCancellable *cancellable, | |
| | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| | | /** | |
| | | * ibus_bus_get_global_engine_async_finish: | |
| | | * @bus: An #IBusBus. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_bus_get_global_engine_async_finish(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: The description of current global engine, or %NULL if there i | |
| | | s no | |
| | | * global engine. | |
| | | * | |
| | | * Finishes an operation started with ibus_bus_get_global_engine_async_fini | |
| | | sh(). | |
| | | */ | |
| | | IBusEngineDesc * | |
| | | ibus_bus_get_global_engine_async_finish | |
| | | (IBusBus *bus, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| /** | | /** | |
| * 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 synchronously. | | * 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: | | * ibus_bus_set_global_engine_async: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @global_engine: A new engine name. | | * @global_engine: A new engine name. | |
| * @timeout_msec: The timeout in milliseconds or -1 to use the default time
out. | | * @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: A GAsyncReadyCallback to call when the request is satisfied o | | * @callback: A #GAsyncReadyCallback to call when the request is satisfied | |
| r NULL | | * or %NULL if you don't care about the result of the method invocatio | |
| * if you don't care about the result of the method invocation. | | n. | |
| * @user_data: The data to pass to callback. | | * @user_data: The data to pass to callback. | |
| * | | * | |
| * Set current global engine asynchronously. | | * Set current global engine asynchronously. | |
| */ | | */ | |
|
| void ibus_bus_set_global_engine_async (IBusBus *bus, | | void ibus_bus_set_global_engine_async | |
| const gchar *global_engine, | | (IBusBus *bus, | |
| gint timeout_msec, | | const gchar *global_engine, | |
| GCancellable *cancellable, | | gint timeout_msec, | |
| GAsyncReadyCallback callback, | | GCancellable *cancellable, | |
| gpointer user_data); | | GAsyncReadyCallback | |
| | | callback, | |
| | | gpointer user_data); | |
| | | | |
| /** | | /** | |
| * ibus_bus_set_global_engine_async_finish: | | * ibus_bus_set_global_engine_async_finish: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @res: A GAsyncResult obtained from the GAsyncReadyCallback passed to | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| * ibus_bus_set_global_engine(). | | * ibus_bus_set_global_engine_async(). | |
| * @error: Return location for error or NULL. | | * @error: Return location for error or %NULL. | |
| * @returns: TRUE if no IPC errros. FALSE otherwise. | | * @returns: %TRUE if no IPC errros. %FALSE otherwise. | |
| * | | * | |
| * Finishes an operation started with ibus_bus_set_global_engine(). | | * Finishes an operation started with ibus_bus_set_global_engine_async(). | |
| */ | | */ | |
| gboolean ibus_bus_set_global_engine_async_finish (IBusBus *bus, | | gboolean ibus_bus_set_global_engine_async_finish | |
| GAsyncResult *res, | | (IBusBus *bus, | |
| GError **error); | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| /** | | /** | |
| * ibus_bus_set_watch_dbus_signal: | | * ibus_bus_set_watch_dbus_signal: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @watch: TRUE if you want ibusbus to emit "name-owner-changed" signal whe | | * @watch: %TRUE if you want ibusbus to emit "name-owner-changed" signal wh | |
| n | | en | |
| * ibus-daemon emits the NameOwnerChanged DBus signal. | | * ibus-daemon emits the NameOwnerChanged DBus signal. | |
| * | | * | |
|
| * Start or stop watching the NameOwnerChange DBus signal. | | * Start or stop watching the NameOwnerChanged DBus signal. | |
| */ | | */ | |
| void ibus_bus_set_watch_dbus_signal | | void ibus_bus_set_watch_dbus_signal | |
| (IBusBus *bus, | | (IBusBus *bus, | |
| gboolean watch); | | 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 | | * @watch: %TRUE if you want ibusbus to emit "global-engine-changed" signal | |
| when | | 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); | |
| | | | |
| /* declare config apis */ | | /* declare config apis */ | |
| /** | | /** | |
| * ibus_bus_get_config: | | * ibus_bus_get_config: | |
|
| * @bus: An IBusBus. | | * @bus: An #IBusBus. | |
| * @returns: (transfer none): An IBusConfig object which is configurable wi | | * @returns: (transfer none): An #IBusConfig object which is configurable w | |
| th | | ith | |
| * @bus. | | * @bus. | |
| * | | * | |
|
| * Get the config instance from IBusBus. | | * Get the config instance from #IBusBus. | |
| */ | | */ | |
| IBusConfig *ibus_bus_get_config (IBusBus *bus); | | IBusConfig *ibus_bus_get_config (IBusBus *bus); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 83 change blocks. |
| 124 lines changed or deleted | | 714 lines changed or added | |
|
| ibusinputcontext.h | | ibusinputcontext.h | |
| | | | |
| skipping to change at line 44 | | skipping to change at line 44 | |
| * text input in various natural languages. | | * text input in various natural languages. | |
| * | | * | |
| * Clients call the IBusInputContext to invoke BusInputContext, | | * Clients call the IBusInputContext to invoke BusInputContext, | |
| * through which invokes IBusEngine. | | * through which invokes IBusEngine. | |
| */ | | */ | |
| #ifndef __IBUS_INPUT_CONTEXT_H_ | | #ifndef __IBUS_INPUT_CONTEXT_H_ | |
| #define __IBUS_INPUT_CONTEXT_H_ | | #define __IBUS_INPUT_CONTEXT_H_ | |
| | | | |
| #include "ibusproxy.h" | | #include "ibusproxy.h" | |
| #include "ibusenginedesc.h" | | #include "ibusenginedesc.h" | |
|
| | | #include "ibustext.h" | |
| | | | |
| /* | | /* | |
| * Type macros. | | * Type macros. | |
| */ | | */ | |
| | | | |
| /* define GOBJECT macros */ | | /* define GOBJECT macros */ | |
| #define IBUS_TYPE_INPUT_CONTEXT \ | | #define IBUS_TYPE_INPUT_CONTEXT \ | |
| (ibus_input_context_get_type ()) | | (ibus_input_context_get_type ()) | |
| #define IBUS_INPUT_CONTEXT(obj) \ | | #define IBUS_INPUT_CONTEXT(obj) \ | |
| (G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_INPUT_CONTEXT, IBusInputC
ontext)) | | (G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_INPUT_CONTEXT, IBusInputC
ontext)) | |
| | | | |
| skipping to change at line 92 | | skipping to change at line 93 | |
| /*< private >*/ | | /*< private >*/ | |
| /* padding */ | | /* padding */ | |
| gpointer pdummy[24]; | | gpointer pdummy[24]; | |
| }; | | }; | |
| | | | |
| GType ibus_input_context_get_type (void); | | GType ibus_input_context_get_type (void); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_new: | | * ibus_input_context_new: | |
| * @path: The path to the object that emitting the signal. | | * @path: The path to the object that emitting the signal. | |
|
| * @connection: An GDBusConnection. | | * @connection: An #GDBusConnection. | |
| * @cancellable: A #GCancellable or %NULL. | | * @cancellable: A #GCancellable or %NULL. | |
| * @error: Return location for error or %NULL. | | * @error: Return location for error or %NULL. | |
| * | | * | |
| * @returns: A newly allocated IBusInputContext. | | * @returns: A newly allocated IBusInputContext. | |
| * | | * | |
| * New an IBusInputContext. | | * New an IBusInputContext. | |
| */ | | */ | |
|
| IBusInputContext | | IBusInputContext * | |
| *ibus_input_context_new (const gchar *path, | | ibus_input_context_new (const gchar *path, | |
| GDBusConnection *connection
, | | GDBusConnection *connection
, | |
| GCancellable *cancellabl
e, | | GCancellable *cancellabl
e, | |
| GError **error); | | GError **error); | |
|
| | | /** | |
| | | * ibus_input_context_new_async: | |
| | | * @path: The path to the object that emitting the signal. | |
| | | * @connection: An #GDBusConnection. | |
| | | * @cancellable: A #GCancellable or %NULL. | |
| | | * @callback: A #GAsyncReadyCallback to call when the request is satisfied. | |
| | | * The callback should not be %NULL. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * New an #IBusInputContext asynchronously. | |
| | | */ | |
| | | void ibus_input_context_new_async (const gchar *path, | |
| | | GDBusConnection *connection | |
| | | , | |
| | | GCancellable *cancellabl | |
| | | e, | |
| | | GAsyncReadyCallback callback, | |
| | | gpointer user_data) | |
| | | ; | |
| | | | |
| /** | | /** | |
|
| | | * ibus_input_context_new_async_finish: | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to | |
| | | * ibus_input_context_new_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * | |
| | | * @returns: A newly allocated #IBusInputContext. | |
| | | * | |
| | | * Finishes an operation started with ibus_input_context_new_async(). | |
| | | */ | |
| | | IBusInputContext * | |
| | | ibus_input_context_new_async_finish | |
| | | (GAsyncResult *res, | |
| | | GError **error); | |
| | | /** | |
| * ibus_input_context_get_input_context: | | * ibus_input_context_get_input_context: | |
| * @path: The path to the object that emitting the signal. | | * @path: The path to the object that emitting the signal. | |
|
| * @connection: An GDBusConnection. | | * @connection: An #GDBusConnection. | |
| * @returns: (transfer none): An existing IBusInputContext. | | * @returns: (transfer none): An existing #IBusInputContext. | |
| * | | * | |
| * Gets an existing IBusInputContext. | | * Gets an existing IBusInputContext. | |
| */ | | */ | |
|
| IBusInputContext | | IBusInputContext * | |
| *ibus_input_context_get_input_context | | ibus_input_context_get_input_context | |
| (const gchar *path, | | (const gchar *path, | |
| GDBusConnection *connection
); | | GDBusConnection *connection
); | |
|
| | | /** | |
| | | * ibus_input_context_get_input_context_async: | |
| | | * @path: The path to the object that emitting the signal. | |
| | | * @connection: An #GDBusConnection. | |
| | | * @cancellable: A #GCancellable or %NULL. | |
| | | * @callback: A #GAsyncReadyCallback to call when the request is satisfied. | |
| | | * The callback should not be %NULL. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * Get an existing #IBusInputContext asynchronously. | |
| | | */ | |
| | | void ibus_input_context_get_input_context_async | |
| | | (const gchar *path, | |
| | | GDBusConnection *connection | |
| | | , | |
| | | GCancellable *cancellabl | |
| | | e, | |
| | | GAsyncReadyCallback callback, | |
| | | gpointer user_data) | |
| | | ; | |
| | | | |
| | | /** | |
| | | * ibus_input_context_get_input_context_async_finish: | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to | |
| | | * ibus_input_context_get_input_context_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * | |
| | | * @returns: (transfer none): An existing #IBusInputContext. | |
| | | * | |
| | | * Finishes an operation started with ibus_input_contex_get_input_context_a | |
| | | sync(). | |
| | | */ | |
| | | IBusInputContext * | |
| | | ibus_input_context_get_input_context_async_finish | |
| | | (GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_process_key_event_async: | | * ibus_input_context_process_key_event_async: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @keyval: Key symbol of a key event. | | * @keyval: Key symbol of a key event. | |
| * @keycode: Keycode of a key event. | | * @keycode: Keycode of a key event. | |
| * @state: Key modifier flags. | | * @state: Key modifier flags. | |
| * @timeout_msec: The timeout in milliseconds or -1 to use the default time
out. | | * @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: A GAsyncReadyCallback to call when the request is satisfied o
r NULL | | * @callback: A GAsyncReadyCallback to call when the request is satisfied o
r NULL | |
| | | | |
| skipping to change at line 187 | | skipping to change at line 250 | |
| GError **error); | | GError **error); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_process_key_event: | | * ibus_input_context_process_key_event: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @keyval: Key symbol of a key event. | | * @keyval: Key symbol of a key event. | |
| * @keycode: Keycode of a key event. | | * @keycode: Keycode of a key event. | |
| * @state: Key modifier flags. | | * @state: Key modifier flags. | |
| * @returns: TRUE for successfully process the key; FALSE otherwise. | | * @returns: TRUE for successfully process the key; FALSE otherwise. | |
| * | | * | |
|
| * Pass the key event to input method engine and wait for the reply from ib
us. | | * Pass the key event to input method engine and wait for the reply from ib
us (i.e. synchronous IPC). | |
| * | | * | |
| * @see_also: ibus_input_context_process_key_event_async() | | * @see_also: ibus_input_context_process_key_event_async() | |
| */ | | */ | |
| gboolean ibus_input_context_process_key_event | | gboolean ibus_input_context_process_key_event | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| guint32 keyval, | | guint32 keyval, | |
| guint32 keycode, | | guint32 keycode, | |
| guint32 state); | | guint32 state); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_set_cursor_location: | | * ibus_input_context_set_cursor_location: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @x: X coordinate of the cursor. | | * @x: X coordinate of the cursor. | |
| * @y: Y coordinate of the cursor. | | * @y: Y coordinate of the cursor. | |
| * @w: Width of the cursor. | | * @w: Width of the cursor. | |
| * @h: Height of the cursor. | | * @h: Height of the cursor. | |
| * | | * | |
|
| * Set the cursor location of IBus input context. | | * Set the cursor location of IBus input context asynchronously. | |
| * | | * | |
| * see_also: #IBusEngine::set-cursor-location | | * see_also: #IBusEngine::set-cursor-location | |
| */ | | */ | |
| void ibus_input_context_set_cursor_location | | void ibus_input_context_set_cursor_location | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| gint32 x, | | gint32 x, | |
| gint32 y, | | gint32 y, | |
| gint32 w, | | gint32 w, | |
| gint32 h); | | gint32 h); | |
| /** | | /** | |
| * ibus_input_context_set_capabilities: | | * ibus_input_context_set_capabilities: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @capabilities: Capabilities flags of IBusEngine, see #IBusCapabilite | | * @capabilities: Capabilities flags of IBusEngine, see #IBusCapabilite | |
| * | | * | |
|
| * Set the capabilities flags of client application. | | * Set the capabilities flags of client application asynchronously. | |
| * When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIAR
Y_TEXT, IBUS_CAP_LOOKUP_TABLE, and IBUS_CAP_PROPERTY have to be all set. | | * When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIAR
Y_TEXT, IBUS_CAP_LOOKUP_TABLE, and IBUS_CAP_PROPERTY have to be all set. | |
| * The panel component does nothing for an application that doesn't support
focus. | | * The panel component does nothing for an application that doesn't support
focus. | |
| * | | * | |
| * see_also: #IBusEngine::set-capabilities | | * see_also: #IBusEngine::set-capabilities | |
| */ | | */ | |
| void ibus_input_context_set_capabilities | | void ibus_input_context_set_capabilities | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| guint32 capabiliti
es); | | guint32 capabiliti
es); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_property_activate | | * ibus_input_context_property_activate | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @prop_name: A property name (e.g. "InputMode.WideLatin") | | * @prop_name: A property name (e.g. "InputMode.WideLatin") | |
| * @state: A status of the property (e.g. PROP_STATE_CHECKED) | | * @state: A status of the property (e.g. PROP_STATE_CHECKED) | |
| * | | * | |
|
| * Activate the property. | | * Activate the property asynchronously. | |
| * | | * | |
| * @see_also: #IBusEngine::property_activate | | * @see_also: #IBusEngine::property_activate | |
| */ | | */ | |
| void ibus_input_context_property_activate | | void ibus_input_context_property_activate | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| const gchar *prop_name, | | const gchar *prop_name, | |
| guint32 state); | | guint32 state); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_focus_in: | | * ibus_input_context_focus_in: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
|
| * Invoked when the client application get focus. | | * Invoked when the client application get focus. An asynchronous IPC will
be performed. | |
| * | | * | |
| * see_also: #IBusEngine::focus_in. | | * see_also: #IBusEngine::focus_in. | |
| */ | | */ | |
| void ibus_input_context_focus_in (IBusInputContext *context); | | void ibus_input_context_focus_in (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_focus_out: | | * ibus_input_context_focus_out: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
|
| * Invoked when the client application get focus. | | * Invoked when the client application get focus. An asynchronous IPC will
be performed. | |
| * | | * | |
| * see_also: #IBusEngine::focus_out. | | * see_also: #IBusEngine::focus_out. | |
| */ | | */ | |
| void ibus_input_context_focus_out (IBusInputContext *context); | | void ibus_input_context_focus_out (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_reset: | | * ibus_input_context_reset: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
|
| * Invoked when the IME is reset. | | * Invoked when the IME is reset. An asynchronous IPC will be performed. | |
| * | | * | |
| * see_also: #IBusEngine::reset | | * see_also: #IBusEngine::reset | |
| */ | | */ | |
| void ibus_input_context_reset (IBusInputContext *context); | | void ibus_input_context_reset (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_enable: | | * ibus_input_context_enable: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the IME is enabled, either by IME switch hotkey or select f
rom the menu. | | * Invoked when the IME is enabled, either by IME switch hotkey or select f
rom the menu. | |
|
| | | * An asynchronous IPC will be performed. | |
| * | | * | |
| * see_also: #IBusEngine::enable | | * see_also: #IBusEngine::enable | |
| */ | | */ | |
| void ibus_input_context_enable (IBusInputContext *context); | | void ibus_input_context_enable (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_disable: | | * ibus_input_context_disable: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the IME is disabled, either by IME switch hotkey or select
from the menu. | | * Invoked when the IME is disabled, either by IME switch hotkey or select
from the menu. | |
|
| | | * An asynchronous IPC will be performed. | |
| * | | * | |
| * see_also: #IBusEngine::disable | | * see_also: #IBusEngine::disable | |
| */ | | */ | |
| void ibus_input_context_disable (IBusInputContext *context); | | void ibus_input_context_disable (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
|
| | | * ibus_input_context_is_enabled_async: | |
| | | * @context: An #IBusInputContext. | |
| | | * @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 | |
| | | or %NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * An asynchronous IPC will be performed. | |
| | | */ | |
| | | void ibus_input_context_is_enabled_async | |
| | | (IBusInputContext *context, | |
| | | gint timeout_ms | |
| | | ec, | |
| | | GCancellable *cancellabl | |
| | | e, | |
| | | GAsyncReadyCallback callback, | |
| | | gpointer user_data) | |
| | | ; | |
| | | | |
| | | /** | |
| | | * ibus_input_context_is_enabled_async_finish: | |
| | | * @context: An #IBusInputContext. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_input_context_is_enabled_async(). | |
| | | * @retval: If the the context is enabled, it will be assigned to %TRUE, %F | |
| | | ALSE otherwise. | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: %TRUE for success; %FALSE otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_input_context_is_enabled_async() | |
| | | . | |
| | | */ | |
| | | gboolean ibus_input_context_is_enabled_async_finish | |
| | | (IBusInputContext *context, | |
| | | GAsyncResult *res, | |
| | | gboolean *retval, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * ibus_input_context_is_enabled: | | * ibus_input_context_is_enabled: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @returns: TRUE if the IME is enabled on the context. | | * @returns: TRUE if the IME is enabled on the context. | |
| * | | * | |
| * Returns TRUE if the IME is enabled on the context. | | * Returns TRUE if the IME is enabled on the context. | |
|
| | | * A asynchronous IPC will be performed. | |
| */ | | */ | |
| gboolean ibus_input_context_is_enabled (IBusInputContext *context); | | gboolean ibus_input_context_is_enabled (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
|
| | | * ibus_input_context_get_engine_async: | |
| | | * @context: An #IBusInputContext. | |
| | | * @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 | |
| | | or %NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| | | * | |
| | | * An asynchronous IPC will be performed. | |
| | | */ | |
| | | void ibus_input_context_get_engine_async | |
| | | (IBusInputContext *context, | |
| | | gint timeout_ms | |
| | | ec, | |
| | | GCancellable *cancellabl | |
| | | e, | |
| | | GAsyncReadyCallback callback, | |
| | | gpointer user_data) | |
| | | ; | |
| | | | |
| | | /** | |
| | | * ibus_input_context_get_engine_async_finish: | |
| | | * @context: An #IBusInputContext. | |
| | | * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to | |
| | | * ibus_input_context_get_engine_async(). | |
| | | * @error: Return location for error or %NULL. | |
| | | * @returns: (transfer none): An IME engine description for the context, or | |
| | | %NULL. | |
| | | * | |
| | | * Finishes an operation started with ibus_input_context_get_engine_async() | |
| | | . | |
| | | */ | |
| | | IBusEngineDesc * | |
| | | ibus_input_context_get_engine_async_finish | |
| | | (IBusInputContext *context, | |
| | | GAsyncResult *res, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| * ibus_input_context_get_engine: | | * ibus_input_context_get_engine: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
|
| * @returns: (transfer none): An IME engine description for the context | | * @returns: (transfer none): An IME engine description for the context, or
NULL. | |
| * | | * | |
| * Returns an IME engine description for the context. | | * Returns an IME engine description for the context. | |
|
| | | * A synchronous IPC will be performed. | |
| */ | | */ | |
|
| IBusEngineDesc | | IBusEngineDesc * | |
| *ibus_input_context_get_engine (IBusInputContext *context); | | ibus_input_context_get_engine (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_set_engine: | | * ibus_input_context_set_engine: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @name: A name of the engine. | | * @name: A name of the engine. | |
| * | | * | |
| * Invoked when the IME engine is changed. | | * Invoked when the IME engine is changed. | |
|
| | | * An asynchronous IPC will be performed. | |
| */ | | */ | |
| void ibus_input_context_set_engine (IBusInputContext *context, | | void ibus_input_context_set_engine (IBusInputContext *context, | |
| const gchar *name); | | const gchar *name); | |
| | | | |
|
| | | /** | |
| | | * ibus_input_context_set_surrounding_text: | |
| | | * @context: An #IBusInputContext. | |
| | | * @text: An #IBusText surrounding the current cursor on the application. | |
| | | * @cursor_po: Current cursor position in characters in @text. | |
| | | */ | |
| | | void ibus_input_context_set_surrounding_text | |
| | | (IBusInputContext *context, | |
| | | IBusText *text, | |
| | | guint32 cursor_pos | |
| | | ); | |
| | | | |
| | | /** | |
| | | * ibus_input_context_needs_surrounding_text: | |
| | | * @context: An #IBusInputContext. | |
| | | * @returns: %TRUE if surrounding-text is needed by the current engine; | |
| | | * %FALSE otherwise. | |
| | | * | |
| | | * Check whether the current engine requires surrounding-text. | |
| | | */ | |
| | | gboolean ibus_input_context_needs_surrounding_text | |
| | | (IBusInputContext *context); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 25 change blocks. |
| 17 lines changed or deleted | | 198 lines changed or added | |
|