Array of IBusAttribute.
Creates an new #IBusAttrList.
A newly allocated #IBusAttrList.
Append an IBusAttribute to IBusAttrList, and increase reference.
An IBusAttrList instance.
The IBusAttribute instance to be appended.
Returns #IBusAttribute at given index. Borrowed reference.
#IBusAttribute at given index, %NULL if no such
#IBusAttribute.
An IBusAttrList instance.
Index of the @attr_list.
GArray that holds #IBusAttribute.
Type enumeration of IBusText attribute.
Decorate with underline.
Foreground color.
Background color.
Type of IBusText attribute.
No underline.
Single underline.
Double underline.
Low underline ? FIXME
Error underline
Creates a new underline #IBusAttribute.
A newly allocated #IBusAttribute.
Type of underline.
Where attribute starts.
Where attribute ends.
An IBusAttribute represents an attribute that associate to IBusText.
It decorates preedit buffer and auxiliary text with underline, foreground
and background colors.
Creates a new IBusAttribute.
A newly allocated IBusAttribute.
Type of the attribute.
Value of the attribute.
Where attribute starts.
Where attribute ends.
Gets an enum of #IBusAttrType.
An enum of #IBusAttrType.
An #IBusAttribute
Gets an end unsigned index
A end unsigned index
An #IBusAttribute
Gets a start unsigned index
A start unsigned index
An #IBusAttribute
Gets an unsigned int value relative with #IBusAttrType.
If the type is %IBUS_ATTR_TYPE_UNDERLINE, the return value is
#IBusAttrUnderline. If the type is %IBUS_ATTR_TYPE_FOREGROUND,
the return value is the color RGB.
An unsigned int value relative with #IBusAttrType.
An #IBusAttribute
IBusAttributeType
Value for the type.
The starting index, inclusive.
The ending index, exclusive.
An IBusBus connects with IBus daemon.
Creates a new #IBusBus instance.
A newly allocated #IBusBus instance, and the instance is not
floating.
Creates a new #IBusBus instance. The instance will asynchronously connect
to the IBus daemon.
A newly allocated #IBusBus instance, and the instance is not
floating.
Creates a new #IBusBus instance for client use only. It will possibly
be limited in what it can do.
The instance will asynchronously connect to the IBus daemon.
A newly allocated #IBusBus instance, and the instance is not
floating.
Add a match rule to an #IBusBus synchronously.
%TRUE if the rule is added. %FALSE otherwise.
An #IBusBus.
Match rule.
Add a match rule to an #IBusBus asynchronously.
An #IBusBus.
Match rule.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_add_match_async().
%TRUE if the rule is added. %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_add_match_async().
Create an input context for client synchronously.
A newly allocated #IBusInputContext if the
"CreateInputContext" call is succeeded, %NULL otherwise.
An #IBusBus.
Name of client.
Create an input context for client asynchronously.
An #IBusBus.
Name of client.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied.
It should not be %NULL.
The data to pass to callback.
Finishes an operation started with ibus_bus_create_input_context_async().
A newly allocated #IBusInputContext if the
"CreateInputContext" call is succeeded, %NULL otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_create_input_context_async().
Get the current focused input context synchronously.
Name of the currently focused #IBusInputContext if the
"CurrentInputContext" call succeeded, %NULL otherwise. The return
value must be freed with g_free().
An #IBusBus.
Get the current focused input context asynchronously.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_current_input_context_async().
Name of the currently focused IBusInputContext if the
"CurrentInputContext" call succeeded, %NULL otherwise. The return
value must be freed with g_free().
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_current_input_context_async().
Exit or restart ibus-daemon synchronously.
%TRUE if the "Exit" call is successful, %FALSE otherwise.
An #IBusBus.
Whether restarting the ibus.
Exit or restart ibus-daemon asynchronously.
An #IBusBus.
Whether restarting the ibus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_exit_async().
%TRUE if the "Exit" call is successful, %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_exit_async().
Get the config instance from #IBusBus.
An #IBusConfig object which is configurable with
@bus.
An #IBusBus.
Gets a #GDBusConnection of an #IBusBus instance.
A #GDBusConnection of an #IBusBus instance.
An #IBusBus.
Get engines by given names synchronously. If some engine names do not exist,
this function will simply ignore them, and return rest of engines.
TODO(penghuang): add asynchronous version
A %NULL-terminated array of engines.
An #IBusBus.
A %NULL-terminated array of names.
Get the description of current global engine synchronously.
The description of current global engine,
or %NULL if there is no global engine.
An #IBusBus.
Get the description of current global engine asynchronously.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied or %NULL
if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_get_global_engine_async_finish().
The description of current global engine,
or %NULL if there is no global engine.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_get_global_engine_async_finish().
Get org.freedesktop.DBus.Properties.
The value in org.freedesktop.DBus.Properties.Get
The returned value must be freed with g_variant_unref().
An #IBusBus.
property name in org.freedesktop.DBus.Properties.Get
Get org.freedesktop.DBus.Properties asynchronously.
An #IBusBus.
property name in org.freedesktop.DBus.Properties.Get
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_get_ibus_property_async().
The value in org.freedesktop.DBus.Properties.Get
The returned value must be freed with g_variant_unref().
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_get_ibus_property_async().
Return the name owner synchronously.
Owner of the name. The returned value must be freed with g_free().
An #IBusBus.
Name.
Return the name owner asynchronously.
An #IBusBus.
Name.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_get_name_owner_async().
Owner of the name. The returned value must be freed with g_free().
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_get_name_owner_async().
Return the main service name to use for calls on the ibus connection.
at dbus name.
An #IBusBus.
Check if the bus's "use_global_engine" option is enabled or not
synchronously.
Currently global engine is always used.
TRUE if "use_global_engine" option is enabled.
An #IBusBus.
Check if the bus's "use_global_engine" option is enabled or not asynchronously.
Currently global engine is always used.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_get_use_global_engine_async().
Currently global engine is always used.
%TRUE if "use_global_engine" option is enabled.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_get_use_global_engine_async().
Check if the bus's "use_sys_layout" option is enabled or not synchronously.
Read dconf value
/desktop/ibus/general/use_system_keyboard_layout instead.
%TRUE if "use_sys_layout" option is enabled.
An #IBusBus.
Check if the bus's "use_sys_layout" option is enabled or not asynchronously.
Read dconf value
/desktop/ibus/general/use_system_keyboard_layout instead.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_get_use_sys_layout_async().
Read dconf value
/desktop/ibus/general/use_system_keyboard_layout instead.
TRUE if "use_sys_layout" option is enabled.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_get_use_sys_layout_async().
This function sends a "HELLO" message to DBus daemon,
which replies the unique name of current IBus process.
The unique name of IBus process in DBus.
An #IBusBus.
Return %TRUE if @bus is connected to IBus daemon.
%TRUE if @bus is connected, %FALSE otherwise.
An #IBusBus.
Check if the current global engine is enabled or not synchronously.
Probably this would be used for Chrome OS only.
Currently global engine is always used and ibus_bus_get_global_engine()
returns NULL until the first global engine is assigned.
You can use ibus_set_log_handler() to disable a warning when
ibus_bus_get_global_engine() returns NULL.
%TRUE if the current global engine is enabled.
An #IBusBus.
Check if the current global engine is enabled or not asynchronously.
Probably this would be used for Chrome OS only.
Currently global engine is always used and ibus_bus_get_global_engine()
returns NULL until the first global engine is assigned.
You can use ibus_set_log_handler() to disable a warning when
ibus_bus_get_global_engine() returns NULL.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_is_global_engine_enabled_async().
Probably this would be used for Chrome OS only.
Currently global engine is always used and ibus_bus_get_global_engine()
returns NULL until the first global engine is assigned.
You can use ibus_set_log_handler() to disable a warning when
ibus_bus_get_global_engine() returns NULL.
%TRUE if the current global engine is enabled.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_is_global_engine_enabled_async().
List active engines synchronously.
Read dconf value
/desktop/ibus/general/preload-engines instead.
A List of active engines.
An #IBusBus.
List active engines asynchronously.
Read dconf value
/desktop/ibus/general/preload-engines instead.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied or %NULL
if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_list_active_engines_async().
Read dconf value
/desktop/ibus/general/preload-engines instead.
A List of active engines.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_list_active_engines_async().
List engines synchronously.
A List of engines.
An #IBusBus.
List engines asynchronously.
An #IBusBus.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied or %NULL
if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_list_engines_async().
A List of engines.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_list_engines_async().
Return lists that attached to @bus.
<note><para>[FixMe] Not implemented yet, only return %NULL.</para></note>
<note><para>[FixMe] Add async version.</para></note>
Lists that attached to @bus.
An #IBusBus.
Lists the unique bus names of connections currently queued for a bus name.
FIXME add an asynchronous version.
The unique bus names of connections currently queued for @name.
An IBusBus.
Name to be queried.
Checks whether the name has owner synchronously.
%TRUE if the name has owner, %FALSE otherwise.
An #IBusBus.
Name to be checked.
Checks whether the name has owner asynchronously.
An #IBusBus.
Name to be checked.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_name_has_owner_async().
%TRUE if the name has owner, %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_name_has_owner_async().
Start bus components by engine names synchronously.
%TRUE if components start. %FALSE otherwise.
An #IBusBus.
A %NULL-terminated array of engine names.
Start bus components by engine names asynchronously.
An #IBusBus.
A %NULL-terminated array of engine names.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_preload_engines_async().
%TRUE if component starts. %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_preload_engines_async().
Register a component to an #IBusBus synchronously.
%TRUE if the "RegisterComponent" call is successful, %FALSE otherwise.
An #IBusBus.
A input engine component.
Register a component to an #IBusBus asynchronously.
An #IBusBus.
A input engine component.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_register_component_async().
%TRUE if the "RegisterComponent" call is successful, %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_register_component_async().
Release a name to IBus daemon synchronously.
0 if failed; positive number otherwise.
An #IBusBus.
Name to be released.
Release a name to IBus daemon asynchronously.
An #IBusBus.
Name to be released.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_release_name_async().
0 if failed; positive number otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_release_name_async().
Remove a match rule to an #IBusBus synchronously.
%TRUE if the rule is removed. %FALSE otherwise.
An #IBusBus.
Match rule.
Remove a match rule to an IBusBus asynchronously.
An #IBusBus.
Match rule.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_remove_match_async().
%TRUE if the rule is removed. %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_remove_match_async().
Request a name from IBus daemon synchronously.
0 if failed; IBusBusRequestNameReply otherwise.
the IBusBus instance to be processed.
Name to be requested.
IBusBusNameFlag.
Request a name from IBus daemon asynchronously.
An #IBusBus.
Name to be requested.
Flags (FixMe).
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied or %NULL
if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_request_name_async().
0 if failed; positive number otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_request_name_async().
Set current global engine synchronously.
%TRUE if the global engine was set successfully.
An #IBusBus.
A new engine name.
Set current global engine asynchronously.
An #IBusBus.
A new engine name.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_set_global_engine_async().
%TRUE if no IPC errros. %FALSE otherwise.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_set_global_engine_async().
Set org.freedesktop.DBus.Properties.
An #IBusBus.
property name in org.freedesktop.DBus.Properties.Set
value in org.freedesktop.DBus.Properties.Set
Set org.freedesktop.DBus.Properties asynchronously.
An #IBusBus.
property name in org.freedesktop.DBus.Properties.Set
value in org.freedesktop.DBus.Properties.Set
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied
or %NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_bus_set_ibus_property_async().
%TRUE if property is set with async. %FALSE failed.
An #IBusBus.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_bus_set_ibus_property_async().
Start or stop watching the NameOwnerChanged DBus signal.
An #IBusBus.
%TRUE if you want ibusbus to emit "name-owner-changed" signal when
ibus-daemon emits the NameOwnerChanged DBus signal.
Start or stop watching the GlobalEngineChanged IBus signal.
An #IBusBus.
%TRUE if you want ibusbus to emit "global-engine-changed" signal when
ibus-daemon emits the GlobalEngineChanged IBus signal.
Whether the #IBusBus object is for client use only.
Whether the #IBusBus object should connect asynchronously to the bus.
Emitted when #IBusBus is connected to ibus-daemon.
Emitted when #IBusBus is disconnected from ibus-daemon.
Emitted when global engine is changed.
The name of the new global engine.
Emitted when D-Bus name owner is changed.
The name which ower is changed.
The unique bus name of the old owner.
The unique bus name of the new owner.
same as DBUS_NAME_FLAG_ALLOW_REPLACEMENT
same as DBUS_NAME_FLAG_REPLACE_EXISTING
same as DBUS_NAME_FLAG_DO_NOT_QUEUE
same as DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
same as DBUS_REQUEST_NAME_REPLY_IN_QUEUE
same as DBUS_REQUEST_NAME_REPLY_EXISTS
same as DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER
same as DBUS_START_REPLY_SUCCESS
same as DBUS_START_REPLY_ALREADY_RUNNING
Check whether the current IBus version is equal to or greater than
given major.minor.micro.
Major version of ibus.
Minor version of ibus.
Micro version of ibus.
Capability flags of UI.
UI is capable to show pre-edit text.
UI is capable to show auxiliary text.
UI is capable to show the lookup table.
UI is capable to get focus.
UI is capable to have property.
Client can provide surround text,
or IME can handle surround text.
UI is owned by on-screen keyboard.
Asynchronous process key events are not
supported and the ibus_engine_forward_key_event() should not be
used for the return value of #IBusEngine::process_key_event().
International and multi-key character composition.
An IBusComponent is an executable program.
It provides services such as user interface, configuration,
and input method engine (IME).
It is recommended that IME developers provide
a component XML file and
load the XML file by ibus_component_new_from_file().
The format of a component XML file is described at
<ulink url="https://github.com/ibus/ibus/wiki/DevXML">https://github.com/ibus/ibus/wiki/DevXML</ulink>
Creates a new #IBusComponent.
A newly allocated #IBusComponent.
Name of the component.
Detailed description of component.
Component version.
Distribution license of this component.
Author(s) of the component.
Homepage of the component.
path to component executable.
Domain name for dgettext()
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.
A newly allocated #IBusComponent.
An XML file that contains component information.
Creates a new #IBusComponent from an XML tree.
A newly allocated #IBusComponent.
Root node of component XML tree.
Creates a new #IBusComponent.
ibus_component_new_varargs() supports the va_list format.
name property is required. e.g.
IBusComponent *component = ibus_component_new_varargs ("name", "ibus-foo",
"command_line", "/usr/libexec/ibus-engine-foo --ibus",
NULL)
A newly allocated #IBusComponent.
Name of the first property.
the NULL-terminated arguments of the properties and values.
Add an engine to #IBusComponent according to the description in @engine.
An #IBusComponent
A description of an engine.
Add an observed path to #IBusComponent.
An #IBusComponent
Observed path to be added.
%TRUE for filling the file status; %FALSE otherwise.
Check whether the observed paths of component is modified.
%TRUE if at least one of the observed paths is modified;
%FALSE otherwise.
An #IBusComponent.
Gets the author property in #IBusComponent. It should not be freed.
author property in #IBusComponent
An #IBusComponent
Gets the description property in #IBusComponent. It should not be freed.
description property in #IBusComponent
An #IBusComponent
Gets the engines of this component.
A newly allocated GList that contains engines.
An #IBusComponent.
Gets the exec property in #IBusComponent. It should not be freed.
exec property in #IBusComponent
An #IBusComponent
Gets the homepage property in #IBusComponent. It should not be freed.
homepage property in #IBusComponent
An #IBusComponent
Gets the license property in #IBusComponent. It should not be freed.
license property in #IBusComponent
An #IBusComponent
Gets the name property in #IBusComponent. It should not be freed.
name property in #IBusComponent
An #IBusComponent
Gets the observed paths of this component.
A
newly allocated GList that contains observed paths.
An #IBusComponent.
Gets the textdomain property in #IBusComponent. It should not be freed.
textdomain property in #IBusComponent
An #IBusComponent
Gets the version property in #IBusComponent. It should not be freed.
version property in #IBusComponent
An #IBusComponent
Output #IBusComponent as an XML-formatted string.
The output string can be then shown on the screen or written to file.
An #IBusComponent.
GString that holds the result.
level of indent.
Output engine description as an XML-formatted string.
The output string can be then shown on the screen or written to file.
An #IBusComponent.
GString that holds the result.
level of indent.
The author of component
The exec path of component
The description of component
The homepage of component
The license of component
The name of component
The textdomain of component
The version of component
An IBusConfig provides engine configuration methods
such as get and set the configure settings to configuration file.
Currently, IBusConfig supports gconf.
Create a new #IBusConfig from existing #GDBusConnection.
A newly allocated #IBusConfig corresponding to @connection.
A #GDBusConnection.
A #GCancellable or %NULL.
Finishes an operation started with ibus_config_new_async().
A newly allocated #IBusConfig.
A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
ibus_config_new_async().
New an #IBusConfig asynchronously.
An #GDBusConnection.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied.
The callback should not be %NULL.
The data to pass to callback.
Get the value of a configuration option synchronously.
GConf stores configure options in a tree-like structure,
and the IBus related setting is at /desktop/ibus,
thus, @section here is a path from there,
while @name is the key of that configuration option.
ibus-chewing, for example, stores its setting in /desktop/ibus/engine/Chewing,
so the section name for it is "engine/Chewing".
See also: ibus_config_set_value().
A #GVariant or %NULL. Free with g_variant_unref().
An #IBusConfig
Section name of the configuration option.
Name of the configure option.
Get the value of a configuration option asynchronously.
See also: ibus_config_get_value().
An #IBusConfig
Section name of the configuration option.
Name of the configure option.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
Callback function to invoke when the return value is ready.
The data to pass to callback.
Finish get value of a configuration option.
A #GVariant or %NULL if error is set. Free with g_variant_unref().
See also: ibus_config_get_value_async().
A #IBusConfig.
A #GAsyncResult.
Get all values in a section synchronously.
A #GVariant or %NULL. Free with g_variant_unref().
See also: ibus_config_set_value().
An #IBusConfig
Section name of the configuration option.
Get all values in a section asynchronously.
See also: ibus_config_get_values().
An #IBusConfig
Section name of the configuration option.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
Callback function to invoke when the return value is ready.
The data to pass to callback.
Finish get values in a section.
A #GVariant or %NULL if error is set. Free with g_variant_unref().
See also: ibus_config_get_values_async().
A #IBusConfig.
A #GAsyncResult.
Set the value of a configuration option synchronously.
%TRUE if succeed; %FALSE otherwise.
See also: ibus_config_get_value().
An #IBusConfig
Section name of the configuration option.
Name of the configure option its self.
A #GVariant that holds the value. If the value is floating, the
function takes ownership of it.
Set the value of a configuration option asynchronously.
See also: ibus_config_set_value().
An #IBusConfig
Section name of the configuration option.
Name of the configure option.
A #GVariant that holds the value. If the value is floating, the
function takes ownership of it.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
Callback function to invoke when the return value is ready.
The data to pass to callback.
Finish set value of a configuration option.
%TRUE or %FALSE if error is set.
See also: ibus_config_set_value_async().
A #IBusConfig.
A #GAsyncResult.
Remove an entry of a configuration option.
%TRUE if succeed; %FALSE otherwise.
See also: ibus_config_get_value().
An #IBusConfig
Section name of the configuration option.
Name of the configure option its self.
Unsubscribe from the configuration option change notification.
%TRUE if succeed; %FALSE otherwise.
See also: ibus_config_watch.
An #IBusConfig
Section name of the configuration option.
Name of the configure option its self.
Subscribe to the configuration option change notification.
Until this function is called, every change will be notified to the
client through #IBusConfig::value-changed signal. Clients should
call ibus_config_watch() with the sections they are interested in,
to reduce the number of D-Bus messages.
%TRUE if succeed; %FALSE otherwise.
See also: ibus_config_unwatch().
An #IBusConfig
Section name of the configuration option.
Name of the configure option its self.
Emitted when configuration value is changed.
<note><para>Argument @user_data is ignored in this function.</para></note>
Section name.
Name of the property.
Value.
An IBusConfigService is a base class for other configuration services such as GConf.
Currently, directly known sub class is IBusConfigGConf.
IBusConfigServiceClass has following member functions:
<itemizedlist>
<listitem>
<para>gboolean set_value(IBusConfigService *config, const gchar *section, const gchar *name,
const GValue *value, IBusError **error)
</para>
<variablelist>
<varlistentry>
<term>config:</term>
<listitem>A configure service</listitem>
</varlistentry>
<varlistentry>
<term>section:</term>
<listitem>Section name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>name:</term>
<listitem>Name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>value:</term>
<listitem>GValue that holds the value.</listitem>
</varlistentry>
<varlistentry>
<term>error:</term>
<listitem>Error outputs here.</listitem>
</varlistentry>
<varlistentry>
<term>Returns:</term>
<listitem>TRUE if succeed; FALSE otherwise.</listitem>
</varlistentry>
</variablelist>
<para>Set a value to a configuration option.
</para>
</listitem>
<listitem>
<para>gboolean get_value(IBusConfigService *config, const gchar *section, const gchar *name,
GValue *value, IBusError **error)
</para>
<variablelist>
<varlistentry>
<term>config:</term>
<listitem>A configure service</listitem>
</varlistentry>
<varlistentry>
<term>section:</term>
<listitem>Section name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>name:</term>
<listitem>Name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>value:</term>
<listitem>GValue that holds the value.</listitem>
</varlistentry>
<varlistentry>
<term>error:</term>
<listitem>Error outputs here.</listitem>
</varlistentry>
<varlistentry>
<term>Returns:</term>
<listitem>TRUE if succeed; FALSE otherwise.</listitem>
</varlistentry>
</variablelist>
<para>Get value of a configuration option.
</para>
</listitem>
<listitem>
<para>gboolean unset(IBusConfigService *config, const gchar *section, const gchar *name,
IBusError **error)
</para>
<variablelist>
<varlistentry>
<term>config:</term>
<listitem>A configure service</listitem>
</varlistentry>
<varlistentry>
<term>section:</term>
<listitem>Section name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>name:</term>
<listitem>Name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>error:</term>
<listitem>Error outputs here.</listitem>
</varlistentry>
<varlistentry>
<term>Returns:</term>
<listitem>TRUE if succeed; FALSE otherwise.</listitem>
</varlistentry>
</variablelist>
<para>Remove an entry to a configuration option.
</para>
</listitem>
</itemizedlist>
Creates an new #IBusConfigService from an #GDBusConnection.
A newly allocated #IBusConfigServices.
An #GDBusConnection.
Change a value of a configuration option
by sending a "ValueChanged" message to IBus service.
An IBusConfigService.
Section name of the configuration option.
Name of the configure option.
GVariant that holds the value.
Emoji data likes emoji unicode, annotations, description, category.
You can get extended values with g_object_get_properties.
Creates a new #IBusEmojiData.
emoji property is required. e.g.
ibus_emoji_data_new ("emoji", "😁", NULL)
A newly allocated #IBusEmojiData.
Name of the first property.
the NULL-terminated arguments of the properties and values.
An #IBusEmojiData list loaded from the saved cache file.
A path of the saved dictionary file.
Save the list of #IBusEmojiData to the cache file.
A path of the saved emoji data.
A list of emoji data.
Gets the annotation list in #IBusEmojiData. It should not be freed.
annotation list property in #IBusEmojiData
An #IBusEmojiData
Gets the emoji category in #IBusEmojiData. It should not be freed.
category property in #IBusEmojiData
An #IBusEmojiData
Gets the emoji description in #IBusEmojiData. It should not be freed.
description property in #IBusEmojiData
An #IBusEmojiData
Gets the emoji character in #IBusEmojiData. It should not be freed.
emoji property in #IBusEmojiData
An #IBusEmojiData
Sets the annotation list in #IBusEmojiData.
An #IBusEmojiData
List of emoji annotations
Sets the description in #IBusEmojiData.
An #IBusEmojiData
An emoji description
The emoji annotations
The emoji category
The emoji description
The emoji character
An IBusEngine provides infrastructure for input method engine.
Developers can "extend" this class for input method engine development.
see_also: #IBusComponent, #IBusEngineDesc
Create a new #IBusEngine.
A newly allocated IBusEngine.
Name of the IBusObject.
Path for IBusService.
An opened GDBusConnection.
Create a new #IBusEngine.
A newly allocated IBusEngine.
GType of #IBusEngine.
Name of the IBusObject.
Path for IBusService.
An opened GDBusConnection.
Commit output of input method to IBus client.
(Note: The text object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
String commit to IBusEngine.
Delete surrounding text.
An IBusEngine.
The offset of the first char.
Number of chars to be deleted.
Forward the key event.
An IBusEngine.
KeySym.
keyboard scancode.
Key modifier flags.
Get content-type (primary purpose and hints) of the current input
context.
See also: #IBusEngine::set-content-type
An #IBusEngine.
Primary purpose of the input context.
Hints that augument @purpose.
Return the name of #IBusEngine.
Name of #IBusEngine.
An IBusEngine.
Get surrounding text.
It is also used to tell the input-context that the engine will
utilize surrounding-text. In that case, it must be called in
#IBusEngine::enable handler, with both @text and @cursor set to
%NULL.
See also: #IBusEngine::set-surrounding-text
An IBusEngine.
Location to store surrounding text.
Cursor position in characters in @text.
Anchor position of selection in @text.
Hide the auxiliary bar.
An IBusEngine.
Hide the lookup table.
An IBusEngine.
Hide the pre-edit buffer.
An IBusEngine.
Register and show properties in language bar.
(Note: The prop_list object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
Property List.
Show the auxiliary bar.
An IBusEngine.
Show the lookup table.
An IBusEngine.
Show the pre-edit buffer.
An IBusEngine.
Update the auxiliary bar.
(Note: The text object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
Update content.
Whether the auxiliary text bar is visible.
Update the lookup table.
(Note: The table object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
An lookup_table.
Whether the lookup_table is visible.
Fast update for big lookup table.
If size of lookup table is not over table page size *4,
then it calls ibus_engine_update_lookup_table().
(Note: The table object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
An lookup_table.
Whether the lookup_table is visible.
Update the pre-edit buffer.
(Note: The text object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
Update content.
Current position of cursor
Whether the pre-edit buffer is visible.
Update the pre-edit buffer with commit mode. Similar to
ibus_engine_update_preedit_text(), this function allows users to specify
the behavior on focus out when the pre-edit buffer is visible.
If @mode is IBUS_ENGINE_PREEDIT_COMMIT, contents of the pre-edit buffer
will be committed and cleared.
If @mode is IBUS_ENGINE_PREEDIT_CLEAR, contents of the pre-edit buffer
will be cleared only.
(Note: The text object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
Update content.
Current position of cursor
Whether the pre-edit buffer is visible.
Pre-edit commit mode when the focus is lost.
Update the state displayed in language bar.
(Note: The prop object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An IBusEngine.
IBusProperty to be updated.
When this property is set to %TRUE, "RequireSurroundingText" D-Bus
signal will be called by ibus-daemon on every focus-in/out event, with
no need for the engine to call ibus_engine_get_surrounding_text().
This property can only be set at construct time.
Name of this IBusEngine.
Use #IBusEngine::focus_in_id()/focus_out_id() class method insteads of
focus_in()/focus_out() class methods when this property is set to %TRUE.
Otherwise, use #IBusEngine::focus_in()/focus_out class methods.
This property can only be set at construct time.
See also: IBusEngine::focus-in-id
Whether the engine is enabled.
Whether the engine has focus.
Area of cursor.
IBusCapabilite (client capabilities) flags.
Emitted when a hand writing operation is cancelled.
Implement the member function IBusEngineClass::cancel_hand_writing
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
The number of strokes to be removed. 0 means "remove all".
Emitted when candidate on lookup table is clicked.
Implement the member function IBusEngineClass::candidate_clicked
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Index of candidate be clicked.
Mouse button.
Keyboard state.
Emitted when the down cursor button is pressed.
Implement the member function IBusEngineClass::cursor_down
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the up cursor button is pressed.
Implement the member function IBusEngineClass::cursor_up
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the IME is disabled.
Implement the member function IBusEngineClass::disable
in extended class to receive this signal.
See also: ibus_bus_set_global_engine().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the IME is enabled.
Implement the member function IBusEngineClass::enable
in extended class to receive this signal.
See also: ibus_bus_set_global_engine().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the focus.
Implement the member function IBusEngineClass::focus_in
in extended class to receive this signal.
See also: ibus_input_context_focus_in()
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the focus.
Implement the member function IBusEngineClass::focus_in
in extended class to receive this signal.
@object_path is a unique id by input context.
@client indicates a client type:
'fake': focus is on desktop background or other programs where no
input is possible
'xim': old X11 programs like xterm, emacs, ...
GTK3 programs in a Gnome Xorg session when GTK_IM_MODULE
is unset also use xim
'gtk-im:<client-name>': Gtk2 input module is used
'gtk3-im:<client-name>': Gtk3 input module is used
'gtk4-im:<client-name>': Gtk4 input module is used
In case of the Gtk input modules, the name of the
client is also shown after the “:”, for example
like 'gtk3-im:firefox', 'gtk4-im:gnome-text-editor', …
'gnome-shell': Entries handled by gnome-shell
(like the command line dialog opened with Alt+F2
or the search field when pressing the Super key.)
When GTK_IM_MODULE is unset in a Gnome Wayland session
all programs which would show 'gtk3-im' or 'gtk4-im'
with GTK_IM_MODULE=ibus then show 'gnome-shell'
instead.
'Qt': Qt4 programs like keepassx-2.0.3 …
'QIBusInputContext': Qt5 programs like keepassxc-2.7.1, anki-2.1.15
telegram-desktop-3.7.3,
You need to set #IBusEngine::has-focus-id property to %TRUE when you
construct an #IBusEngine to use this class method.
See also: ibus_input_context_focus_in()
<note><para>Argument @user_data is ignored in this function.</para>
</note>
An object path.
An client name.
Emitted when the client application lost the focus.
Implement the member function IBusEngineClass::focus_out
in extended class to receive this signal.
See also: ibus_input_context_focus_out()
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application lost the focus.
Implement the member function IBusEngineClass::focus_out
in extended class to receive this signal.
@object_path is a unique id by input context.
You need to set #IBusEngine::has-focus-id property to %TRUE when you
construct an #IBusEngine to use this class method.
See also: ibus_input_context_focus_out()
<note><para>Argument @user_data is ignored in this function.</para>
</note>
An object path.
Emitted when the page-down button is pressed.
Implement the member function IBusEngineClass::page_down
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the page-up button is pressed.
Implement the member function IBusEngineClass::page_up
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when a hand writing operation is cancelled.
Implement the member function IBusEngineClass::cancel_hand_writing
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
An array of double (0.0 to 1.0) which represents a stroke
(i.e. [x1, y1, x2, y2, x3, y3, ...]).
The number of elements in the array.
Emitted when a key event is received.
Implement the member function IBusEngineClass::process_key_event
in extended class to receive this signal.
Both the key symbol and keycode are passed to the member function.
See ibus_input_context_process_key_event() for further explanation of
key symbol, keycode and which to use.
%TRUE for successfully process the key; %FALSE otherwise.
See also: ibus_input_context_process_key_event().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Key symbol of the key press.
KeyCode of the key press.
Key modifier flags.
Emitted when a property is activated or change changed.
Implement the member function IBusEngineClass::property_activate
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Property name.
Property state.
Emitted when a property is hidden.
Implement the member function IBusEngineClass::property_hide
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Property name.
Emitted when a property is shown.
Implement the member function IBusEngineClass::property_side
in extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Property name.
Emitted when the IME is reset.
Implement the member function IBusEngineClass::reset
in extended class to receive this signal.
See also: ibus_input_context_reset().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application capabilities is set.
Implement the member function IBusEngineClass::set_capabilities
in extended class to receive this signal.
See also: ibus_input_context_set_capabilities().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Capabilities flags of IBusEngine, see #IBusCapabilite
Emitted when the client application content-type (primary
purpose and hints) is set. The engine could change the
behavior according to the content-type. Implement the member
function IBusEngineClass::set_content_type
in extended class to receive this signal.
For example, if the client application wants to restrict input
to numbers, this signal will be emitted with @purpose set to
#IBUS_INPUT_PURPOSE_NUMBER, so the engine can switch the input
mode to latin.
<note><para>Argument @user_data is ignored in this
function.</para></note>
Primary purpose of the input context, as an #IBusInputPurpose.
Hints that augment @purpose, as an #IBusInputHints.
Emitted when the location of IME is set.
Implement the member function IBusEngineClass::set_cursor_location
in extended class to receive this signal.
See also: ibus_input_context_set_cursor_location().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
X coordinate of the cursor.
Y coordinate of the cursor.
Width of the cursor.
Height of the cursor.
Emitted when a surrounding text is set.
Implement the member function IBusEngineClass::set_surrounding_text
in extended class to receive this signal.
If anchor_pos equals to cursor_pos, it means "there are no selection"
or "does not support selection retrival".
<note><para>Argument @user_data is ignored in this function.</para>
</note>
The surrounding text.
The cursor position on surrounding text.
The anchor position on selection area.
An IBusEngineDesc stores description data of IBusEngine.
The description data can either be passed to ibus_engine_desc_new(),
or loaded from an XML node through ibus_engine_desc_new_from_xml_node()
to construct IBusEngineDesc.
However, the recommended way to load engine description data is
using ibus_component_new_from_file() to load a component file,
which also includes engine description data.
see_also: #IBusComponent, #IBusEngine
Creates a new #IBusEngineDesc.
If layout is "default", the engine inherits the current layout and
does not change the layout. The layouts "default" and "" are same.
E.g. If you switch JP XKB engine and an input method engine (IME),
the IME inherits the JP layout.
A newly allocated IBusEngineDesc.
Name of the engine.
Long name of the input method engine.
Input method engine description.
Language (e.g. zh, jp) supported by this input method engine.
License of the input method engine.
Author of the input method engine.
Icon file of this engine.
Keyboard layout
Creates a new IBusEngineDesc from an XML node.
<note><para>This function is called by ibus_component_new_from_file(),
so developers normally do not need to call it directly.
</para></note>
A newly allocated IBusEngineDesc that contains description from
@node.
An XML node
Creates a new #IBusEngineDesc.
ibus_engine_desc_new_varargs() supports the va_list format.
name property is required. e.g.
ibus_engine_desc_new_varargs("name", "ibus-foo", "language", "us", NULL)
If layout is "default", the engine inherits the current layout and
does not change the layout. The layouts "default" and "" are same.
E.g. If you switch JP XKB engine and an input method engine (IME),
the IME inherits the JP layout.
A newly allocated IBusEngineDesc.
Name of the first property.
the NULL-terminated arguments of the properties and values.
Gets the author property in IBusEngineDesc. It should not be freed.
author property in IBusEngineDesc
An IBusEngineDesc
Gets the description property in IBusEngineDesc. It should not be freed.
description property in IBusEngineDesc
An IBusEngineDesc
Gets the hotkeys property in IBusEngineDesc. It should not be freed.
hotkeys property in IBusEngineDesc
An IBusEngineDesc
Gets the icon property in IBusEngineDesc. It should not be freed.
icon property in IBusEngineDesc
An IBusEngineDesc
Gets the key of IBusProperty to load the panel icon dynamically
in IBusEngineDesc. It should not be freed.
IBusProperty.key for dynamic panel icon in IBusEngineDesc
An IBusEngineDesc
Gets the language property in IBusEngineDesc. It should not be freed.
language property in IBusEngineDesc
An IBusEngineDesc
Gets the layout property in IBusEngineDesc. It should not be freed.
layout property in IBusEngineDesc
An IBusEngineDesc
Gets the keyboard option property in IBusEngineDesc. It should not be freed.
keyboard option property in IBusEngineDesc
An IBusEngineDesc
Gets the keyboard variant property in IBusEngineDesc. It should not be freed.
keyboard variant property in IBusEngineDesc
An IBusEngineDesc
Gets the license property in IBusEngineDesc. It should not be freed.
license property in IBusEngineDesc
An IBusEngineDesc
Gets the longname property in IBusEngineDesc. It should not be freed.
longname property in IBusEngineDesc
An IBusEngineDesc
Gets the name property in IBusEngineDesc. It should not be freed.
name property in IBusEngineDesc
An IBusEngineDesc
Gets the rank property in IBusEngineDesc.
rank property in IBusEngineDesc
An IBusEngineDesc
Gets the setup property in IBusEngineDesc. It should not be freed.
setup property in IBusEngineDesc
An IBusEngineDesc
Gets the symbol property in IBusEngineDesc. It should not be freed.
symbol property in IBusEngineDesc
An IBusEngineDesc
Gets the textdomain property in IBusEngineDesc. It should not be freed.
textdomain in IBusEngineDesc
An IBusEngineDesc
Gets the version property in IBusEngineDesc. It should not be freed.
version in IBusEngineDesc
An IBusEngineDesc
Output XML-formatted input method engine description.
The result will be append to GString specified in @output.
An IBusEngineDesc
XML-formatted Input method engine description.
Number of indent (showed as 4 spaces).
The author of engine description
The description of engine description
The hotkeys of engine description
The icon of engine description
The key of IBusProperty to change panel icon dynamically.
The language of engine description
The layout of engine description
The keyboard option of engine description
The keyboard variant of engine description
The license of engine description
The longname of engine description
The name of engine description
The rank of engine description
The exec lists of the engine setup command
The symbol chars of engine description instead of icon image
The textdomain of engine description
The version number of engine description
An IBusEngineSimple provides table-based input method logic.
see_also: #IBusEngine
Call ibus_engine_simple_add_table() internally by locale.
%TRUE if the @file is loaded.
An IBusEngineSimple.
The compose file.
Adds an additional table to search to the engine. Each row of the table
consists of max_seq_len key symbols followed by two guint16 interpreted as
the high and low words of a gunicode value. Tables are searched starting from
the last added.
The table must be sorted in dictionary order on the numeric value of the key
symbol fields. (Values beyond the length of the sequence should be zero.)
An IBusEngineSimple.
The table which must be available
during the whole life of the simple engine.
Maximum length of a sequence in the table (cannot be greater
than %IBUS_MAX_COMPOSE_LEN)
number of sequences in the table
Call ibus_engine_simple_add_table() internally by locale.
%TRUE if the @locale is matched to the table.
An IBusEngineSimple.
The locale name. If the locale is %NULL,
the current locale is used.
There is no engine associated with input context.
There is no config module running.
General failure.
IBusExtensionEvent properties.
Create a new #IBusExtensionEvent.
A newly allocated #IBusExtensionEvent. E.g.
ibus_extension_event_new ("name", "emoji", "is-enabled", TRUE, NULL);
Name of the first property.
the NULL-terminated arguments of the properties and values.
Parameters to enable the extension for #IBusXEvent
An #IBusExtensionEvent.
Version of #IBusExtensionEvent
An #IBusExtensionEvent.
%TRUE if the extension is enabled for #IBusExtensionEvent
An #IBusExtensionEvent.
%TRUE if the #IBusExtensionEvent is called by an extension.
%FALSE if the #IBusExtensionEvent is called by an active engine or
panel.
If this value is %TRUE, the event is send to ibus-daemon, an active
engine. If it's %FALSE, the event is sned to ibus-daemon, panels.
An #IBusExtensionEvent.
%TRUE if the extension is enabled in the #IBusExtensionEvent.
%TRUE if the #IBusExtensionEvent is called by an extension.
%FALSE if the #IBusExtensionEvent is called by an active engine or
panel.
If this value is %TRUE, the event is send to ibus-daemon, an active
engine. If it's %FALSE, the event is sned to ibus-daemon, panels.
Name of the extension in the #IBusExtensionEvent.
Parameters to enable the extension in the #IBusExtensionEvent.
Version of the #IBusExtensionEvent.
Casts an IBUS_FACTORY or derived pointer into a (IBusFactory*) pointer.
Depending on the current debugging level, this function may invoke
certain runtime checks to identify invalid casts.
An object which is subject to casting.
Casts a derived IBusFactoryClass structure into a IBusFactoryClass structure.
A class to be casted.
Get the class of a given object and cast the class to IBusFactoryClass.
An object.
An IBusFactory is an #IBusService that creates input method engine (IME) instance.
It provides CreateEngine remote method, which creates an IME instance by name,
and returns the D-Bus object path to IBus daemon.
see_also: #IBusEngine
Creates a new #IBusFactory.
A newly allocated #IBusFactory.
An GDBusConnection.
Creates an #IBusEngine with @engine_name.
#IBusEngine with @engine_name.
An #IBusFactory.
Name of an engine.
Add an engine to the factory.
An IBusFactory.
Name of an engine.
GType of an engine.
Creates an #IBusEngine with @engine_name.
#IBusEngine with @engine_name.
An #IBusFactory.
Name of an engine.
The ::create-engine signal is a signal to create IBusEngine
with @engine_name, which gets emitted when IBusFactory
received CreateEngine dbus method. The callback functions
will be called until a callback returns a non-null object
of IBusEngine.
An IBusEngine
the engine_name which received the signal
#IBusEngine with @engine_name.
An #IBusFactory.
Name of an engine.
Free function prototype.
object to be freed.
Japanese keyboard support.
Japanese keyboard support.
Japanese keyboard support.
Japanese keyboard support.
An opaque data type representing an IBusHotkeyProfile.
Creates a new #IBusHotkeyProfile.
A newly allocated #IBusHotkeyProfile.
Adds a hotkey and its associated event to an #IBusHotkeyProfile.
Always %TRUE.
An IBusHotkeyProfile.
Keycode of the hotkey.
Modifiers of the hotkey.
The event to be associated.
Adds a hotkey and its associated event to an #IBusHotkeyProfile.
The hotkey is in string format, such like
<constant>Control+Shift+A</constant>.
FALSE if @str contains invalid symbol; TRUE otherwise.
An IBusHotkeyProfile.
Key in string representation. '+' is the separator.
The event to be associated.
Emits a <constant>::trigger</constant> signal when a hotkey is in a profile.
0 if releasing a hotkey and the hotkey is not in the profile;
an associated event otherwise.
See also: ::trigger
An IBusHotkeyProfile.
Keycode of the hotkey.
Modifiers of the hotkey.
Keycode of the hotkey.
Modifiers of the hotkey.
user data for signal "trigger".
The event associated to the hotkey or 0 if the hotkey is not in the
profile.
An IBusHotkeyProfile.
Keycode of the hotkey.
Modifiers of the hotkey.
Removes the hotkey for an #IBusHotkeyProfile.
%FALSE if the key is not in @profile, %TRUE otherwise.
An IBusHotkeyProfile.
Keycode of the hotkey.
Modifiers of the hotkey.
Removes the hotkey for an #IBusHotkeyProfile by event.
%FALSE if no such event in @profile, %TRUE otherwise.
An IBusHotkeyProfile.
The associated event.
Emitted when a hotkey is pressed and the hotkey is in profile.
Implement the member function trigger() in extended class to receive this signal.
<note><para>The last parameter, user_data is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note>
An event in GQuark.
User data for callback.
D-Bus interface for IBus config.
D-Bus interface for IBus engine.
D-Bus interface for IBus factory.
D-Bus interface for IBus.
D-Bus interface for IBus input context.
D-Bus interface for IBus notifications.
D-Bus interface for IBus panel.
D-Bus interface for IBus portal.
Checks whether a valid GTypeInstance pointer is of type IBUS_FACTORY.
Instance to check for being a IBUS_FACTORY.
Checks whether class "is a" valid IBusFactoryClass structure of type IBUS_FACTORY or derived.
A class to be checked.
An IBusInputContext is a proxy object of BusInputContext,
which manages the context for input methods that supports
text input in various natural languages.
Clients call the IBusInputContext to invoke BusInputContext,
through which invokes IBusEngine.
Creates a new #IBusInputContext.
A newly allocated #IBusInputContext.
The path to the object that emitting the signal.
A #GDBusConnection.
A #GCancellable or %NULL.
Finishes an operation started with ibus_input_context_new_async().
A newly allocated #IBusInputContext.
A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
ibus_input_context_new_async().
Gets an existing IBusInputContext.
An existing #IBusInputContext.
The path to the object that emitting the signal.
A GDBusConnection.
Gets an existing #IBusInputContext asynchronously.
The path to the object that emitting the signal.
A #GDBusConnection.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied.
The callback should not be %NULL.
The data to pass to callback.
Finishes an operation started with
ibus_input_context_get_input_context_async().
An existing #IBusInputContext.
A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
ibus_input_context_get_input_context_async().
Creates a new #IBusInputContext asynchronously.
The path to the object that emitting the signal.
A #GDBusConnection.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied.
The callback should not be %NULL.
The data to pass to callback.
Clear handwriting stroke(s) in the current input method engine.
see_also: #IBusEngine::cancel-hand-writing
An IBusInputContext.
The number of strokes to be removed. Pass 0 to remove all.
Invoked when the client application get focus. An asynchronous IPC will
be performed.
see_also: #IBusEngine::focus_in.
An #IBusInputContext.
Invoked when the client application get focus. An asynchronous IPC will be performed.
see_also: #IBusEngine::focus_out.
An #IBusInputContext.
Gets an IME engine description for the context.
A synchronous IPC will be performed.
An IME engine description for the context, or NULL.
An #IBusInputContext.
An asynchronous IPC will be performed.
An #IBusInputContext.
The timeout in milliseconds or -1 to use the default timeout.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when the request is satisfied or
%NULL if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with ibus_input_context_get_engine_async().
An IME engine description for the context, or
%NULL.
An #IBusInputContext.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_input_context_get_engine_async().
Check whether the current engine requires surrounding-text.
%TRUE if surrounding-text is needed by the current engine;
%FALSE otherwise.
An #IBusInputContext.
Pass a handwriting stroke to an input method engine.
In this API, a coordinate (0.0, 0.0) represents the top-left corner of an area for
handwriting, and (1.0, 1.0) does the bottom-right. Therefore, for example, if
a user writes a character 'L', the array would be something like [0.0, 0.0, 0.0, 1.0, 1.0, 1.0]
and coordinates_len would be 6.
The function is usually called when a user releases the mouse button in a hand
writing area.
see_also: #IBusEngine::process-hand-writing-event
An IBusInputContext.
An array of gdouble (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).
The number of elements in the array. The number should be even and >= 4.
Pass the key event to input method engine and wait for the reply from
ibus (i.e. synchronous IPC).
%TRUE for successfully process the key; %FALSE otherwise.
See also: ibus_input_context_process_key_event_async()
An #IBusInputContext.
Key symbol of a key event.
Keycode of a key event.
Key modifier flags.
Pass the key event to input method engine.
Key symbols are characters/symbols produced by key press, for example,
pressing "s" generates key symbol "s"; pressing shift-"s" generates key symbol "S".
Same key on keyboard may produce different key symbols on different keyboard layout.
e.g., "s" key on QWERTY keyboard produces "o" in DVORAK layout.
Unlike key symbol, keycode is only determined by the location of the key, and
irrelevant of the keyboard layout.
Briefly speaking, input methods that expect certain keyboard layout should use
keycode; otherwise keyval is sufficient.
For example, Chewing, Cangjie, Wubi expect an en-US QWERTY keyboard, these should
use keycode; while pinyin can rely on keyval only, as it is less sensitive to
the keyboard layout change, DVORAK users can still use DVORAK layout to input pinyin.
Use ibus_keymap_lookup_keysym() to convert keycode to keysym in given keyboard layout.
see_also: #IBusEngine::process-key-event
An IBusInputContext.
Key symbol of a key event.
Keycode of a key event.
Key modifier flags.
The timeout in milliseconds or -1 to use the default timeout.
A GCancellable or NULL.
A GAsyncReadyCallback to call when the request is satisfied or NULL
if you don't care about the result of the method invocation.
The data to pass to callback.
Finishes an operation started with
ibus_input_context_process_key_event_async().
%TRUE if the key event is processed;
%FALSE otherwise or some errors happen and the @error will be set.
An #IBusInputContext.
A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ibus_input_context_process_key_event_async().
Activate the property asynchronously.
See also: #IBusEngine::property_activate
An #IBusInputContext.
A property name (e.g. "InputMode.WideLatin")
A status of the property (e.g. PROP_STATE_CHECKED)
Invoked when the IME is reset. An asynchronous IPC will be performed.
see_also: #IBusEngine::reset
An #IBusInputContext.
Set the capabilities flags of client application asynchronously.
When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIARY_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.
see_also: #IBusEngine::set-capabilities
An IBusInputContext.
Capabilities flags of IBusEngine, see #IBusCapabilite
Set whether #IBusInputContext commits pre-edit texts or not.
If %TRUE, 'update-preedit-text-with-mode' signal is emitted
instead of 'update-preedit-text' signal.
If your client receives the 'update-preedit-text-with-mode' signal,
the client needs to implement commit_text() of pre-edit text when
GtkIMContextClass.focus_out() is called in case an IME desires that
behavior but it depends on each IME.
See also ibus_engine_update_preedit_text_with_mode().
An #IBusInputContext.
%TRUE if your input context commits pre-edit texts
with Space or Enter key events or mouse click events. %FALSE if
ibus-daemon commits pre-edit texts with those events.
The default is %FALSE. The behavior is decided with
ibus_engine_update_preedit_text_with_mode() to commit, clear or
keep the pre-edit text and this API is important in ibus-hangul.
Set content-type (primary purpose and hints) of the context. This
information is particularly useful to implement intelligent
behavior in engines, such as automatic input-mode switch and text
prediction. For example, to restrict input to numbers, the client
can call this function with @purpose set to
#IBUS_INPUT_PURPOSE_NUMBER.
See also: #IBusEngine::set-content-type
An #IBusInputContext.
Primary purpose of the input context, as an #IBusInputPurpose.
Hints that augment @purpose, as an #IBusInputHints.
Set the cursor location of IBus input context asynchronously.
see_also: #IBusEngine::set-cursor-location
An IBusInputContext.
X coordinate of the cursor.
Y coordinate of the cursor.
Width of the cursor.
Height of the cursor.
Set the relative cursor location of IBus input context asynchronously.
An IBusInputContext.
X coordinate of the cursor.
Y coordinate of the cursor.
Width of the cursor.
Height of the cursor.
Invoked when the IME engine is changed.
An asynchronous IPC will be performed.
An #IBusInputContext.
A name of the engine.
An #IBusInputContext.
An #IBusText surrounding the current cursor on the application.
Current cursor position in characters in @text.
Anchor position of selection in @text.
Emitted when the text is going to be committed.
(Note: The text object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
Text to be committed.
Emitted to select next candidate of lookup table.
Emitted to select previous candidate of lookup table.
Emitted to delete surrounding text event from IME to client of IME.
the character offset from the cursor position of the text to be deleted.
A negative value indicates a position before the cursor.
the number of characters to be deleted.
Emitted when an IME is disabled.
Emitted when an IME is enabled.
Emitted to forward key event from IME to client of IME.
Key symbol of the keyboard event.
Key symbol of the keyboard event.
Key modifier flags.
Emitted to hide auxiliary text.
Emitted to hide lookup table.
Emitted to hide preedit text.
Emitted to view the next page of lookup table.
Emitted to view the previous page of lookup table.
Emitted to register the properties in @props.
(Note: The props object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
An IBusPropList that contains properties.
Emitted to receive the RequireSurroundingText signal from the daemon.
Emitted to show auxiliary text.
Emitted to show lookup table.
Emitted to show preedit text.
Emitted to hide auxilary text.
(Note: The text object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
An auxiliary text
The visibility of @text
Emitted to update lookup table.
(Note: The table object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
An IBusLookupTable to be updated.
Whether the table should be visible.
Emitted to update preedit text.
(Note: The text object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
Text to be updated.
Cursor position.
Whether the update is visible.
Emitted to update preedit text with the mode.
(Note: The text object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
Text to be updated.
Cursor position.
Whether the update is visible.
Preedit mode.
Emitted to update the property @prop.
(Note: The prop object is floating, and it will be released after the
signal. If signal handler wants to keep the object, the handler should
use g_object_ref_sink() to get the ownership of the object.)
The IBusProperty to be updated.
Describes hints that might be taken into account by engines. Note
that engines may already tailor their behaviour according to the
#IBusInputPurpose of the entry.
Some common sense is expected when using these flags - mixing
@IBUS_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
This enumeration may be extended in the future; engines should
ignore unknown values.
No special behaviour suggested
Suggest checking for typos
Suggest not checking for typos
Suggest word completion
Suggest to convert all text to lowercase
Suggest to capitalize all text
Suggest to capitalize the first
character of each word
Suggest to capitalize the
first word of each sentence
Suggest to not show an onscreen keyboard
(e.g for a calculator that already has all the keys).
The text is vertical. Since 1.5.11
Suggest offering Emoji support. Since 1.5.24
Suggest not offering Emoji support. Since 1.5.24
Request that the input method should not
update personalized data (like typing history). Since 1.5.26
Describes primary purpose of the input context. This information
is particularly useful to implement intelligent behavior in
engines, such as automatic input-mode switch and text prediction.
Note that the purpose is not meant to impose a totally strict rule
about allowed characters, and does not replace input validation.
It is fine for an on-screen keyboard to let the user override the
character set restriction that is expressed by the purpose. The
application is expected to validate the entry contents, even if
it specified a purpose.
The difference between @IBUS_INPUT_PURPOSE_DIGITS and
@IBUS_INPUT_PURPOSE_NUMBER is that the former accepts only digits
while the latter also some punctuation (like commas or points, plus,
minus) and “e” or “E” as in 3.14E+000.
This enumeration may be extended in the future; engines should
interpret unknown values as 'free form'.
Allow any character
Allow only alphabetic characters
Allow only digits
Edited field expects numbers
Edited field expects phone number
Edited field expects URL
Edited field expects email address
Edited field expects the name of a person
Like @IBUS_INPUT_PURPOSE_FREE_FORM,
but characters are hidden
Like @IBUS_INPUT_PURPOSE_DIGITS, but
characters are hidden
Allow any character, in addition to control
codes. Since 1.5.24
Japanese keyboard support.
Japanese keyboard support.
An IBusKeymap defines the mapping between keyboard scancodes and
keyboard symbols such as numbers, alphabets, and punctuation marks.
Some input methods assume certain keyboard layout
(such as Chewing and Wubi requires an US-QWERTY layout),
and expect key symbols to be arranged in that order.
These input methods should new an IBusKeymap
instance and define the keyboard layout.
Then ibus_keymap_lookup_keysym() can
convert scancodes back to the key symbols.
see_also: #IBusComponent, #IBusEngineDesc
Get an #IBusKeymap associated with the giving name.
This function loads the keymap file specified in @name
in the IBUS_DATA_DIR/keymaps directory.
This function has been deprecated and should
not be used in newly written code. Please use ibus_keymap_get().
An #IBusKeymap associated with the giving name; or %NULL if failed.
The keymap file to be loaded, such as 'us', 'jp'.
Get an IBusKeymap associated with the giving name.
This function loads the keymap file specified in @name
in the IBUS_DATA_DIR/keymaps directory.
An #IBusKeymap associated with the giving name;
or %NULL if failed.
The keymap file to be loaded, such as 'us', 'jp'.
Converts the scancode to keysym, given the keymap.
Corresponding keysym.
An IBusKeymap.
A scancode to be converted.
Modifier flags(such as Ctrl, Shift).
The name of the keymap, such as 'us', 'jp'.
Keymap table. IME developers normally don have to touch this.
An IBusLookuptable stores the candidate words or phrases for users to
choose from.
Use ibus_engine_update_lookup_table(), ibus_engine_show_lookup_table(),
and ibus_engine_hide_lookup_table() to update, show and hide the lookup
table.
see_also: #IBusEngine
Craetes a new #IBusLookupTable.
A newly allocated #IBusLookupTable.
number of candidate shown per page, the max value is 16.
position index of cursor.
whether the cursor is visible.
TRUE for lookup table wrap around.
Append a candidate word/phrase to IBusLookupTable, and increase reference.
An IBusLookupTable.
candidate word/phrase to be appended (in IBusText format).
Append a candidate word/phrase to IBusLookupTable, and increase reference.
This function is needed if the input method select candidate with
non-numeric keys such as "asdfghjkl;".
An IBusLookupTable.
A candidate label to be appended (in IBusText format).
Clear and remove all candidate from an IBusLookupTable.
An IBusLookupTable.
Go to next candidate of an #IBusLookupTable.
It returns FALSE if it is already at the last candidate,
unless <code>table>-round==TRUE</code>, where it will go
to the first candidate.
%TRUE if succeed.
An IBusLookupTable.
Go to previous candidate of an #IBusLookupTable.
It returns FALSE if it is already at the first candidate,
unless <code>table>-round==TRUE</code>, where it will go
to the last candidate.
%TRUE if succeed.
An IBusLookupTable.
Return #IBusText at the given index. Borrowed reference.
IBusText at the given index; NULL if no such
#IBusText.
An IBusLookupTable.
Index in the Lookup table.
Gets the cursor position in current page of #IBusLookupTable.
The position of cursor in current page.
An IBusLookupTable.
Gets the cursor position of #IBusLookupTable.
The position of cursor.
An IBusLookupTable.
Return #IBusText at the given index. Borrowed reference.
#IBusText at the given index; %NULL if no such
#IBusText.
An IBusLookupTable.
Index in the Lookup table.
Return the number of candidate in the table.
The number of candidates in the table
An IBusLookupTable.
Returns the orientation of the #IBusLookupTable.
The orientation of the @table.
An IBusLookupTable.
Gets the number of candidate shown per page.
Page size, i.e., number of candidate shown per page.
dd
An IBusLookupTable.
Returns whether the cursor of an #IBusLookupTable is visible.
Whether the cursor of @table is visible.
An #IBusLookupTable.
Returns whether the #IBusLookupTable is round.
Whether the @table is round.
An IBusLookupTable.
Go to next page of an #IBusLookupTable.
It returns FALSE if it is already at the last page,
unless <code>table>-round==TRUE</code>, where it will go
to the first page.
%TRUE if succeed.
An IBusLookupTable.
Go to previous page of an #IBusLookupTable.
It returns FALSE if it is already at the first page,
unless <code>table>-round==TRUE</code>, where it will go
to the last page.
%TRUE if succeed.
An IBusLookupTable.
Set the cursor position of IBusLookupTable.
An IBusLookupTable.
The position of cursor.
Set whether to make the cursor of an IBusLookupTable visible or not.
An IBusLookupTable.
Whether to make the cursor of @table visible.
Append a candidate word/phrase to IBusLookupTable, and increase reference.
This function is needed if the input method select candidate with
non-numeric keys such as "asdfghjkl;".
An IBusLookupTable.
Intex in the Lookup table.
A candidate label to be appended (in IBusText format).
Set the orientation.
An IBusLookupTable.
.
Set the number of candidate shown per page.
An IBusLookupTable.
number of candidate shown per page.
Set whether to make the IBusLookupTable round or not.
An IBusLookupTable.
Whether to make @table round.
number of candidate shown per page.
position index of cursor.
whether the cursor is visible.
TRUE for lookup table wrap around.
orientation of the table.
Candidate words/phrases.
Candidate labels which identify individual candidates in the same page. Default is 1, 2, 3, 4 ...
IBus major version.
IBus micro version.
IBus minor version.
Handles key modifier such as control, shift and alt and release event.
Note that nits 15 - 25 are currently unused, while bit 29 is used internally.
Shift is activated.
Cap Lock is locked.
Control key is activated.
Modifier 1 (Usually Alt_L (0x40), Alt_R (0x6c), Meta_L (0xcd)) activated.
Modifier 2 (Usually Num_Lock (0x4d)) activated.
Modifier 3 activated.
Modifier 4 (Usually Super_L (0xce), Hyper_L (0xcf)) activated.
Modifier 5 (ISO_Level3_Shift (0x5c), Mode_switch (0xcb)) activated.
Mouse button 1 (left) is activated.
Mouse button 2 (middle) is activated.
Mouse button 3 (right) is activated.
Mouse button 4 (scroll up) is activated.
Mouse button 5 (scroll down) is activated.
Handled mask indicates the event has been handled by ibus.
Forward mask indicates the event has been forward from ibus.
It is an alias of IBUS_FORWARD_MASK.
Super (Usually Win) key is activated.
Hyper key is activated.
Meta key is activated.
Key is released.
Modifier mask for the all the masks above.
Japanese keyboard support.
Key for composing characters.
A.k.a. Compose Key.
IBusObject is the base object for all objects in IBus.
Creates a new #IBusObject.
A newly allocated #IBusObject
Emit the "destroy" signal notifying all reference holders that they should
release the #IBusObject.
The memory for the object itself won't be deleted until its reference count
actually drops to 0; ibus_object_destroy merely asks reference holders to
release their references. It does not free the object.
an #IBusObject to destroy.
Emit the "destroy" signal notifying all reference holders that they should
release the #IBusObject.
The memory for the object itself won't be deleted until its reference count
actually drops to 0; ibus_object_destroy merely asks reference holders to
release their references. It does not free the object.
an #IBusObject to destroy.
Destroy and free an IBusObject
See also: ibus_object_destroy().
<note><para>Argument @user_data is ignored in this function.</para></note>
an #IBusObject to destroy.
The flags are used internally.
Used in GObjectClass::dispose
Used during emitting IBusObject::destroy signal.
Reserved.
Reserved.
IBusObservedPath provides methods for file path manipulation,
such as monitor modification, directory tree traversal.
Creates a new #IBusObservedPath from an XML node.
A newly allocated #IBusObservedPath.
The path string.
Auto-fill the path status.
Creates an new #IBusObservedPath from an XML node.
A newly allocated #IBusObservedPath.
An XML node that contain path.
Auto-fill the path status.
Checks whether the path is modified by comparing the mtime in object and
mtime in file system.
%TRUE if imtime is changed, otherwise %FALSE.
An IBusObservedPath.
Append the observed path to a string with following format:
<path mtime="<i>modified time</i>" ><i>path</i></path>
An IBusObservedPath.
Path is appended to.
number of indent.
Recursively traverse the path and put the files and subdirectory in to
a newly allocated
GLists, if the @path is a directory. Otherwise returns NULL.
A newly allocate
GList which holds content in path; NULL if @path is not directory.
An IBusObservedPath.
Only looks for subdirs, not files
Path to be handled.
Modified time.
Whether the file is the path directory.
Whether the file exists.
Orientation of UI.
Horizontal orientation.
Vertival orientation.
Use ibus global orientation setup.
D-Bus path for IBus config.
D-Bus path for IBus factory.
D-Bus path for IBus
Template of D-Bus path for IBus input context.
D-Bus path for IBus notifications.
D-Bus path for IBus panel.
D-Bus path for IBus extension panel for emoji.
This service provides emoji, Unicode code point, Unicode name features.
An IBusPanelService is a base class for UI services.
Developers can "extend" this class for panel UI development.
Creates a new #IBusPanelService from an #GDBusConnection.
A newly allocated #IBusPanelService.
An GDBusConnection.
Notify that a candidate is clicked
by sending a "CandidateClicked" to IBus service.
An IBusPanelService
Index in the Lookup table
GdkEventButton::button (1: left button, etc.)
GdkEventButton::state (key modifier flags)
Notify that a text is sent
by sending a "CommitText" message to IBus service.
An #IBusPanelService
An #IBusText
Notify that the cursor is down
by sending a "CursorDown" to IBus service.
An IBusPanelService
Notify that the cursor is up
by sending a "CursorUp" to IBus service.
An IBusPanelService
Notify that the preedit is hidden by the panel extension
An IBusPanelService
Notify that the page is down
by sending a "PageDown" to IBus service.
An IBusPanelService
Notify that the page is up
by sending a "PageUp" to IBus service.
An IBusPanelService
Enable or disable a panel extension with #IBusExtensionEvent.
Notify that a data is sent
by sending a "PanelExtension" message to IBus panel extension service.
An #IBusPanelService
A #PanelExtensionEvent which is sent to a
panel extension.
Register shortcut keys to enable panel extensions with #IBusExtensionEvent.
Notify that a data is sent
by sending a "PanelExtensionRegisterKeys" message to IBus panel extension
service. Seems Vala does not support uint[][3] and use
IBusProcessKeyEventData[]. E.g.
IBusProcessKeyEventData[] keys = {{
IBUS_KEY_e, 0, IBUS_SHIFT_MASK | IBUS_SUPER_MASK }};
ibus_panel_service_panel_extension_register_keys(panel, "emoji", keys, NULL);
An #IBusPanelService
the first name of the shortcut keys. This is %NULL
" terminated.
Notify that a property is active
by sending a "PropertyActivate" message to IBus service.
An IBusPanelService
A property name
State of the property
Notify that a property is hidden
by sending a "ValueChanged" message to IBus service.
An IBusPanelService
A property name
Notify that a property is shown
by sending a "ValueChanged" message to IBus service.
An IBusPanelService
A property name
Notify that the preedit is shown by the panel extension
An IBusPanelService
Notify that the auxilirary is updated by the panel extension.
(Note: The table object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An #IBusPanelService
An #IBusText
Whether the auxilirary text is visible.
Notify that the lookup table is updated by the panel extension.
(Note: The table object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An #IBusPanelService
An #IBusLookupTable
Whether the lookup table is visible.
Notify that the preedit is updated by the panel extension
(Note: The table object will be released, if it is floating.
If caller want to keep the object, caller should make the object
sink by g_object_ref_sink.)
An #IBusPanelService
Update content.
Current position of cursor
Whether the pre-edit buffer is visible.
Emitted when the client application get the ::commit-text-received.
Implement the member function
IBusPanelServiceClass::commit_text_received in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
A #IBusText
Emitted when the client application get the ::cursor-down-lookup-table.
Implement the member function
IBusPanelServiceClass::cursor_down_lookup_table in extended
class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::cursor-up-lookup-table.
Implement the member function
IBusPanelServiceClass::cursor_up_lookup_table in extended
class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application destroys.
Implement the member function
IBusPanelServiceClass::destroy_context in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Object path of InputContext.
Emitted when the client application get the ::focus-in.
Implement the member function
IBusPanelServiceClass::focus_in in extended class to receive
this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Object path of InputContext.
Emitted when the client application get the ::focus-out.
Implement the member function
IBusPanelServiceClass::focus_out in extended class to receive
this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Object path of InputContext.
Emitted when the client application get the ::hide-auxiliary-text.
Implement the member function
IBusPanelServiceClass::hide_auxiliary_text in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::hide-language-bar.
Implement the member function
IBusPanelServiceClass::hide_language_bar in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::hide-lookup-table.
Implement the member function
IBusPanelServiceClass::hide_lookup_table in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::hide-preedit-text.
Implement the member function
IBusPanelServiceClass::hide_preedit_text in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::page-down-lookup-table.
Implement the member function
IBusPanelServiceClass::page_down_lookup_table in extended
class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::page-up-lookup-table.
Implement the member function
IBusPanelServiceClass::page_up_lookup_table in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::panel-extension-received.
Implement the member function
IBusPanelServiceClass::panel_extension_received in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
A #GVariant
Emitted when a key event is received.
Implement the member function IBusPanelServiceClass::process_key_event
in extended class to receive this signal.
Both the key symbol and keycode are passed to the member function.
See ibus_input_context_process_key_event() for further explanation of
key symbol, keycode and which to use.
%TRUE for successfully process the key; %FALSE otherwise.
See also: ibus_input_context_process_key_event().
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Key symbol of the key press.
KeyCode of the key press.
Key modifier flags.
Emitted when the client application get the ::register-properties.
Implement the member function
IBusPanelServiceClass::register_properties in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
An IBusPropList that contains properties.
Emitted when the client application get the ::reset.
Implement the member function
IBusPanelServiceClass::reset in extended class to receive this
signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::set-content-type.
Implement the member function
IBusPanelServiceClass::set_content_type in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Input purpose.
Input hints.
Emitted when the client application get the ::set-cursor-location.
Implement the member function
IBusPanelServiceClass::set_cursor_location in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
X coordinate of the cursor.
Y coordinate of the cursor.
Width of the cursor.
Height of the cursor.
Emitted when the client application get the set-cursor-location-relative.
Implement the member function set_cursor_location_relative() in
extended class to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
X coordinate of the cursor.
Y coordinate of the cursor.
Width of the cursor.
Height of the cursor.
Emitted when the client application get the ::show-auxiliary-text.
Implement the member function
IBusPanelServiceClass::show_auxiliary_text in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::show-language-bar.
Implement the member function
IBusPanelServiceClass::show_language_bar in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::show-lookup-table.
Implement the member function
IBusPanelServiceClass::show_lookup_table in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::show-preedit-text.
Implement the member function
IBusPanelServiceClass::show_preedit_text in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::start-setup.
Implement the member function
IBusPanelServiceClass::start_setup in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::state-changed.
Implement the member function
IBusPanelServiceClass::state_changed in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
Emitted when the client application get the ::update-auxiliary-text.
Implement the member function
IBusPanelServiceClass::update_auxiliary_text in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
A preedit text to be updated.
Whether the update is visible.
Emitted when the client application get the ::update-lookup-table.
Implement the member function
IBusPanelServiceClass::update_lookup_table in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
A lookup table to be updated.
Whether the update is visible.
Emitted when the client application get the ::update-preedit-text.
Implement the member function
IBusPanelServiceClass::update_preedit_text in extended class
to receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
A preedit text to be updated.
The cursor position of the text.
Whether the update is visible.
Emitted when the client application get the ::update-property.
Implement the member function
IBusPanelServiceClass::update_property in extended class to
receive this signal.
<note><para>Argument @user_data is ignored in this function.</para>
</note>
The IBusProperty to be updated.
Pre-edit commit mode when the focus is lost.
pre-edit text is cleared.
pre-edit text is committed.
IBuProcessKeyEventData properties.
See_also: #IBusProperty, #IBusEngine
Create a new #IBusPropList.
A newly allocated #IBusPropList.
Append an IBusProperty to an IBusPropList, and increase reference.
An IBusPropList.
IBusProperty to be append to @prop_list.
Gets #IBusProperty at given index. Borrowed reference.
#IBusProperty at given index, %NULL if no such
#IBusProperty.
An IBusPropList.
Index of an IBusPropList.
Update an IBusProperty in IBusPropList.
%TRUE if succeeded, %FALSE otherwise.
An IBusPropList.
IBusProperty to be update.
GArray that holds IBusProperties.
Class structure for #IBusPropList.
The parent class.
State of #IBusProperty. The actual effect depends on #IBusPropType of the
IBusProperty.
<variablelist>
<varlistentry>
<term>PROP_TYPE_TOGGLE</term>
<listitem><para>Emphasized if PROP_STATE_CHECKED, normal otherwise.</para></listitem>
</varlistentry>
<varlistentry>
<term>PROP_TYPE_RADIO</term>
<listitem><para>Option checked if PROP_STATE_CHECKED, unchecked otherwise.</para></listitem>
</varlistentry>
</variablelist>
No effect on other types.
Property option is unchecked.
Property option is checked.
The state is inconsistent with the associated IME
property.
Type enumeration of IBusProperty.
Property is shown as normal text.
Property is shown as a toggle button.
Property is shown as a radio selection option.
Property is shown as a menu, usually imply it has sub menu
items.
A separator for menu.
An IBusProperty is an UI component like a button or a menu item
which shows the status of corresponding input method engine property.
End user can operate and see the current status of IME through these components.
For example, ibus-chewing users change the English/Chinese input mode by
pressing ctrl-space or click on the Eng/Chi switch button.
And the IBusProperty shows the change correspondingly.
see_also: #IBusPropList, #IBusEngine
Creates a new #IBusProperty.
A newly allocated #IBusProperty.
Unique Identity for the #IBusProperty.
#IBusPropType of #IBusProperty.
Text shown in UI.
Icon file for the #IBusProperty.
Message shown if mouse hovered the #IBusProperty.
Whether the #IBusProperty is sensitive to keyboard and mouse event.
Whether the #IBusProperty is visible.
IBusPropState of #IBusProperty.
#IBusPropList that contains sub IBusProperties.
Creates a new #IBusProperty.
ibus_property_new_varargs() supports the va_list format.
name property is required. e.g.
ibus_property_new_varargs("key", "TypingMode", "type", PROP_TYPE_MENU, NULL)
A newly allocated #IBusProperty.
Name of the first property.
the NULL-terminated arguments of the properties and values.
Get the icon of #IBusProperty.
the icon of #IBusProperty. Should not be freed.
An #IBusProperty.
Get the key of #IBusProperty.
the key of #IBusProperty. Should not be freed.
An #IBusProperty.
Get the label of #IBusProperty.
the label of #IBusProperty. Should not be freed.
An #IBusProperty.
Get the sensitive of #IBusProperty.
the sensitive of #IBusProperty.
An #IBusProperty.
Get the state of #IBusProperty.
the state of #IBusProperty.
An #IBusProperty.
Get the IBusPropList of #IBusProperty.
the IBusPropList of #IBusProperty.
Should not be freed.
An #IBusProperty.
Get the symbol of #IBusProperty.
the symbol of #IBusProperty. Should not be freed.
An #IBusProperty.
Get the tooltip of #IBusProperty.
the tooltip of #IBusProperty. Should not be freed.
An #IBusProperty.
Get the visible of #IBusProperty.
the visible of #IBusProperty.
An #IBusProperty.
Set the icon of #IBusProperty.
An #IBusProperty.
Icon shown in UI. It could be a full path of an icon file or an icon name.
Set the label of #IBusProperty.
An #IBusProperty.
Text shown in UI.
Set whether the #IBusProperty is sensitive.
An #IBusProperty.
Whether the #IBusProperty is sensitive.
Set the state of the #IBusProperty.
An #IBusProperty.
The state of the #IBusProperty.
Set the sub IBusProperties.
An #IBusProperty.
#IBusPropList that contains sub IBusProperties.
Set the symbol of #IBusProperty.
An #IBusProperty.
Text shown in UI.
Set the tooltip of #IBusProperty.
An #IBusProperty.
Text of the tooltip.
Set whether the #IBusProperty is visible.
An #IBusProperty.
Whether the #IBusProperty is visible.
Update the content of an #IBusProperty.
#IBusProperty @prop_update can either be sub-property of @prop,
or holds new values for @prop.
TRUE if update succeeded; FALSE otherwise.
An #IBusProperty.
#IBusPropList that contains sub IBusProperties.
An IBusProxy is the base of all proxy objects,
which communicate the corresponding #IBusServices on the other end of
IBusConnection.
For example, IBus clients (such as editors, web browsers) invoke the proxy
object,
IBusInputContext to communicate with the InputContext service of the
ibus-daemon.
Almost all services have corresponding proxies, except very simple services.
Dispose the proxy object. If the dbus connection is alive and the own
variable above is TRUE (which is the default),
org.freedesktop.IBus.Service.Destroy method will be called.
Note that "destroy" signal might be emitted when ibus_proxy_destroy is
called or the underlying dbus connection for the proxy is terminated.
In the callback of the destroy signal, you might have to call something
like 'g_object_unref(the_proxy);'.
An #IBusProxy
Dispose the proxy object. If the dbus connection is alive and the own
variable above is TRUE (which is the default),
org.freedesktop.IBus.Service.Destroy method will be called.
Note that "destroy" signal might be emitted when ibus_proxy_destroy is
called or the underlying dbus connection for the proxy is terminated.
In the callback of the destroy signal, you might have to call something
like 'g_object_unref(the_proxy);'.
An #IBusProxy
Destroy and free an IBusProxy
See also: ibus_proxy_destroy().
<note><para>Argument @user_data is ignored in this function.</para></note>
An #IBusProxy
Rectangle definition.
x coordinate.
y coordinate.
width of the rectangle.
height of the renctangl.
An #IBusRegistry loads IBus component files and generates the cache files.
see_also: #IBusComponent
Creates a new #IBusRegistry
A newly allocated #IBusRegistry.
Check if the registry is updated.
%TRUE if mtime is changed; %FALSE otherwise.
An #IBusRegistry.
List components.
a list of #IBusComponent objects.
The caller has to call g_list_free() for the returned list.
An #IBusRegistry.
List observed paths.
a list of #IBusObservedPath objects.
The caller has to call g_list_free() for the returned list.
An #IBusRegistry.
Read all XML files in a IBus component directory (typically
/usr/share/ibus/component/ *.xml) and update the registry object.
IBUS_COMPONENT_PATH environment valuable is also available for
the custom component directories, whose delimiter is ':'.
An #IBusRegistry.
Load the user or system registry cache.
%TRUE if the cache exists and is loaded successfully,
%FALSE otherwise.
An #IBusRegistry.
%TRUE if the registry cache is loaded in the user directory.
Load the registry cache @filename.
%TRUE if the cache exists and is loaded successfully,
%FALSE otherwise.
An #IBusRegistry.
The file path of the registry cache
Read all XML files in @dirname, create a #IBusComponent object for each file,
and add the component objects to the registry.
If @dirname is "/usr/share/ibus/component", this API and
ibus_registry_load() are same.
An #IBusRegistry.
IBus component directory which includes XML files.
Output #IBusRegistry as an XML-formatted string.
The output string can be then shown on the screen or written to file.
An #IBusRegistry.
GString that holds the result.
level of indent.
Save the registry in a user directory or system directory.
%TRUE if the cache is saved successfully, %FALSE otherwise.
An #IBusRegistry.
%TRUE if the registry cache is saved in the user directory.
Save the registry cache @filename.
%TRUE if the cache is saved successfully, %FALSE otherwise.
An #IBusRegistry.
The file path of the registry cache
Start to monitor observed paths.
An #IBusRegistry.
Emitted when any observed paths are changed.
A method is not associated in this class. the "changed"
signal would be handled in other classes.
See also: ibus_registry_start_monitor_changes().
Japanese keyboard support.
Address of IBus config service.
Address of IBus service.
Address of IBus notification service.
Address of IBus panel service.
Address of IBus panel extension service.
Address of IBus panel extension service for emoji.
This service provides emoji, Unicode code point, Unicode name features.
Address of IBus portalservice.
An #IBusSerializable is an IBus object which can be serialized, that is,
to be to and from a #GVariant.
This class is to be extended by other class that requires serialization.
An extended class should overrides following methods:
<itemizedlist>
<listitem>
<para><function>serialize(object,iter)</function>: for serialize.</para>
</listitem>
<listitem>
<para><function>deserialize(object,iter)</function>: for deserialize.</para>
</listitem>
<listitem>
<para><function>copy(desc,src)</function>: for copy between IBusSerializable.</para>
</listitem>
</itemizedlist>
See IBusSerializableSerializeFunc(), IBusSerializableDeserializeFunc(), IBusSerializableCopyFunc()
for function prototype.
Creates a new instance of an #IBusSerializable.
a new instance of #IBusSerializable.
Deserialize a #GVariant to an #IBusSerializable/
The deserialize method should be implemented in extended class.
The deserialized #IBusSerializable.
See also: IBusSerializableCopyFunc().
A #GVariant.
Clone an #IBusSerializable.
The copy method should be implemented in extended class.
A newly allocated clone object; or %NULL
if @object is not serializable.
See also: IBusSerializableCopyFunc().
An #IBusSerializable.
Gets a value from attachment of an #IBusSerializable.
The attached value; or %NULL if fail to retrieve the value.
See also: ibus_serializable_set_attachment().
An #IBusSerializable.
String formatted key for indexing value.
Remove a value from attachment of an #IBusSerializable.
See also: ibus_serializable_remove_attachment().
An #IBusSerializable.
String formatted key for indexing value.
Serialize an #IBusSerializable to a #GVariant.
The serialize method should be implemented in extended class.
A #GVariant.
See also: IBusSerializableCopyFunc().
An #IBusSerializable.
Attach a value to an #IBusSerializable. If the value is floating,
the serializable will take the ownership.
See also: ibus_serializable_set_attachment().
An #IBusSerializable.
String formatted key for indexing value.
Value to be attached or %NULL to remove any prevoius value.
Prototype of copy function.
Copy function copy from source #IBusSerializable to the destination one.
Returns a gboolean value which indicates whether the copying is success.
%TRUE if succeed; %FALSE otherwise.
The destination #IBusSerializable.
A source #IBusSerializable.
Prototype of deserialize function.
Deserialize function convert a #GVariant to #IBusSerializable.
Returns an integer value which indicates how many values in
the variant(tuple) are consumed.
The number of values in the variant(tuple) are consumed.
An #IBusSerializable.
A #GVariant contains a tuple.
Prototype of serialize function.
Serialize function convert an #IBusSerializable to #GVariantBuilder.
Returns a gboolean value which indicates whether the conversion is success.
Return %TRUE if succeed.
%TRUE if succeed; %FALSE otherwise.
An #IBusSerializable.
A #GVariantBuilder.
An IBusService is a base class for services.
Creantes a new #IBusService.
A newly allocated #IBusService
A GDBusConnection.
Object path.
The ::service_get_property class method is to connect
GDBusInterfaceGetPropertyFunc().
A variant.
An #IBusService.
A dbus connection.
A sender.
An object path.
An interface name.
A property name.
The ::service_method_call class method is to connect
GDBusInterfaceMethodCallFunc().
An #IBusService.
A dbus connection.
A sender.
An object path.
An interface name.
A method name.
A parameters.
A dbus method invocation.
The ::service_set_property class method is to connect
GDBusInterfaceSetPropertyFunc().
%TRUE if set the value else %FALSE.
An #IBusService.
A dbus connection.
A sender.
An object path.
An interface name.
An property name.
An property value.
Gets a connections.
A #GDBusConnection of an #IBusService instance.
An IBusService.
Gets the object path of an IBusService.
The object path of @service
An IBusService.
Registers service to a connection.
%TRUE if the service was registered, %FALSE otherwise.
An IBusService.
A GDBusConnection the service will be registered to.
Unregisters service from a connection.
An IBusService.
A GDBusConnection the service was registered with.
The connection of service object.
The path of service object.
An #IBusService.
A dbus connection.
A sender.
An object path.
An interface name.
A method name.
A parameters.
A dbus method invocation.
A variant.
An #IBusService.
A dbus connection.
A sender.
An object path.
An interface name.
A property name.
%TRUE if set the value else %FALSE.
An #IBusService.
A dbus connection.
A sender.
An object path.
An interface name.
An property name.
An property value.
Set the interface introspection information with the service class.
%TRUE if @xml_data is valid and succeeded to be added;
%FALSE otherwise.
An IBusServiceClass.
The introspection xml data.
An IBusText is the main text object in IBus.
The text is decorated according to associated IBusAttribute,
e.g. the foreground/background color, underline, and
applied scope.
see_also: #IBusAttribute
Creates a new #IBusText from a printf expression.
The result of printf expression is stored in the new IBusText instance.
A newly allocated #IBusText.
printf format string.
arguments for @fmt.
Creates a new #IBusText from a static string.
Since @str is a static string which won't be freed.
This function will NOT duplicate @str.
A newly allocated #IBusText.
An text string to be set.
Creates a new #IBusText from a string.
@str will be duplicated in #IBusText, so feel free to free @str after this
function.
A newly allocated #IBusText.
An text string to be set.
Creates a new #IBusText from an UCS-4 encoded string.
@str will be duplicated in IBusText, so feel free to free @str after this
function.
A newly allocated #IBusText.
An text string to be set.
Creates a new #IBusText from a single UCS4-encoded character.
A newly allocated #IBusText.
A single UCS4-encoded character.
Append an IBusAttribute for IBusText.
an IBusText
IBusAttributeType for @text.
Value for the type.
The starting index, inclusive.
The ending index, exclusive.
Return the attributes in an #IBusText. Should not be freed.
the attrs in @text.
An #IBusText.
Return the is_static in an #IBusText.
the is_static in @text.
An #IBusText.
Return number of characters in an #IBusText.
This function is based on g_utf8_strlen(), so unlike strlen(),
it does not count by bytes but characters instead.
Number of character in @text, not counted by bytes.
An #IBusText.
Return the text in an #IBusText. Should not be freed.
the text in @text.
An #IBusText.
An IBusText.
An IBusAttrList
Whether @text is static, i.e., no need and will not be freed. Only TRUE if IBusText is newed from ibus_text_new_from_static_string().
The string content of IBusText in UTF-8.
Associated IBusAttributes.
Creates a new #IBusUnicodeBlock.
block property is required. e.g.
ibus_unicode_block_new ("start", 0x0000, "end", "0x007f", "name", "basic",
NULL)
A newly allocated #IBusUnicodeBlock.
Name of the first property.
the NULL-terminated arguments of the properties and values.
An #IBusUnicodeBlock list loaded from the saved cache file.
A path of the saved dictionary file.
Save the list of #IBusUnicodeBlock to the cache file.
A path of the saved Unicode block.
A list of unicode
block.
Gets the end code point in #IBusUnicodeBlock.
end property in #IBusUnicodeBlock
An #IBusUnicodeData
Gets the name in #IBusUnicodeBlock. It should not be freed.
name property in #IBusUnicodeBlock
An #IBusUnicodeBlock
Gets the start code point in #IBusUnicodeBlock.
start property in #IBusUnicodeBlock
An #IBusUnicodeData
The Uniode end code point
The Uniode block name
The Uniode start code point
Unicode data likes code, name, alias, block-name.
You can get extended values with g_object_get_properties.
Creates a new #IBusUnicodeData.
code property is required. e.g.
ibus_unicode_data_new ("code", 0x3042, NULL)
A newly allocated #IBusUnicodeData.
Name of the first property.
the NULL-terminated arguments of the properties and values.
An #IBusUnicodeData list loaded from the saved cache file.
A path of the saved dictionary file.
If the #GObject has "unicode-deserialize-progress"
signal, this function will emit (the number of desrialized
#IBusUnicodeData, * the total number of #IBusUnicodeData) of uint values
with that signal by 100 times. Otherwise %NULL.
IBusUnicodeDataLoadAsyncFinish can receive the list of #IBusUnicodeData.
A path of the saved dictionary file.
If the #GObject has "unicode-deserialize-progress"
signal, this function will emit (the number of desrialized
#IBusUnicodeData, * the total number of #IBusUnicodeData) of uint values
with that signal by 100 times. Otherwise %NULL.
cancellable.
IBusUnicodeDataLoadAsyncFinish.
User data.
Save the list of #IBusUnicodeData to the cache file.
A path of the saved Unicode data.
A list of unicode
data.
Gets the alias in #IBusUnicodeData. It should not be freed.
alias property in #IBusUnicodeData
An #IBusUnicodeData
Gets the block name in #IBusUnicodeData. It should not be freed.
block-name property in #IBusUnicodeData
An #IBusUnicodeData
Gets the code point in #IBusUnicodeData.
code property in #IBusUnicodeData
An #IBusUnicodeData
Gets the name in #IBusUnicodeData. It should not be freed.
name property in #IBusUnicodeData
An #IBusUnicodeData
Sets the block name in #IBusUnicodeData.
An #IBusUnicodeData
A block name
The Uniode alias name
The Uniode block name
The Uniode code point
The Uniode name
This callback can receive the list of #IBusUnicodeData.
An IBusXEvent provides a wrapper of XEvent.
see_also: #IBusComponent, #IBusEngineDesc
Create a new #IBusXEvent.
A newly allocated #IBusXEvent. E.g.
ibus_x_event_new ("event-type", IBUS_X_EVENT_KEY_PRESS, NULL);
Name of the first property.
the NULL-terminated arguments of the properties and values.
IBusXEventType of #IBusXEvent
An #IBusXEvent.
group of #IBusXEvent
An #IBusXEvent.
hardware keycode of #IBusXEvent
An #IBusXEvent.
is_modifier of #IBusXEvent
An #IBusXEvent.
keyval of #IBusXEvent
An #IBusXEvent.
length of #IBusXEvent
An #IBusXEvent.
purpose of #IBusXEvent
An #IBusXEvent.
root window of #IBusXEvent
An #IBusXEvent.
same_screen of #IBusXEvent
An #IBusXEvent.
send_event of #IBusXEvent
An #IBusXEvent.
serial of #IBusXEvent
An #IBusXEvent.
state of #IBusXEvent
An #IBusXEvent.
string of #IBusXEvent
An #IBusXEvent.
subwindow of #IBusXEvent
An #IBusXEvent.
time of #IBusXEvent
An #IBusXEvent.
Version of #IBusXEvent
An #IBusXEvent.
XID of #IBusXEvent
An #IBusXEvent.
x of #IBusXEvent
An #IBusXEvent.
x-root of #IBusXEvent
An #IBusXEvent.
y of #IBusXEvent
An #IBusXEvent.
y-root of #IBusXEvent
An #IBusXEvent.
IBusXEventType of this IBusXEvent.
group of this IBusXEvent.
hardware keycode of this IBusXEvent.
is_modifier of this IBusXEvent.
keyval of this IBusXEvent.
keyval of this IBusXEvent.
purpose of this IBusXEvent.
root window of this IBusXEvent.
same_screen of this IBusXEvent.
send_event of this IBusXEvent.
serial of this IBusXEvent.
state of this IBusXEvent.
string of this IBusXEvent.
subwindow of this IBusXEvent.
time of this IBusXEvent.
Version of this IBusXEvent.
window of this IBusXEvent.
x of this IBusXEvent.
root-x of this IBusXEvent.
x of this IBusXEvent.
root-y of this IBusXEvent.
IBusXML lists data structure and handling function for XML in IBus.
Name of XML tag.
Text enclosed by XML start tag and end tag. i.e. <tag>text</tag>.
Attributes of the XML node.
Children node of this XML node.
Creates a copy of @node, which should be freed with
ibus_xml_free(). Primarily used by language bindings,
not that useful otherwise (since @node can just be copied
by assignment in C).
the newly allocated #IBusXML, which should
be freed with ibus_xml_free(), or %NULL
if @node was %NULL.
Root node of an XML tree.
Free an XML tree.
Root node of an XML tree.
Output an XML tree to a GString.
Root node of an XML tree.
GString which stores the output.
Parse a string buffer which contains an XML-formatted string,
and return a corresponding XML tree.
Root node of parsed XML tree.
Buffer to be parsed.
Parse an XML file and return a corresponding XML tree.
Root node of parsed XML tree.
File name to be parsed.
Converts an accelerator keyval and modifier mask into a string
parseable by gtk_accelerator_parse(). For example, if you pass in
#IBUS_KEY_q and #IBUS_CONTROL_MASK, this function returns “<Control>q”.
If you need to display accelerators in the user interface,
see gtk_accelerator_get_label().
a newly-allocated accelerator name
accelerator keyval
accelerator modifier mask
Parses a string representing an accelerator. The format looks like
“<Control>a” or “<Shift><Alt>F1” or “<Release%gt;z”
(the last one is for key release).
The parser is fairly liberal and allows lower or upper case, and also
abbreviations such as “<Ctl>” and “<Ctrl>”. Key names are
parsed using gdk_keyval_from_name(). For character keys the name is not the
symbol, but the lowercase name, e.g. one would use “<Ctrl>minus”
instead of “<Ctrl>-”.
If the parse fails, @accelerator_key and @accelerator_mods will
be set to 0 (zero).
string representing an accelerator
return location for accelerator
keyval, or %NULL
return location for accelerator
modifier mask, %NULL
Determines whether a given keyval and modifier mask constitute
a valid keyboard accelerator. For example, the #IBUS_KEY_a keyval
plus #IBUS_CONTROL_MASK is valid - this is a “Ctrl+a” accelerator.
But, you can't, for instance, use the #IBUS_KEY_Control_L keyval
as an accelerator.
%TRUE if the accelerator is valid
a GDK keyval
modifier mask
Creates a new background #IBusAttribute.
A newly allocated #IBusAttribute.
Color in RGB.
Where attribute starts.
Where attribute ends.
Creates a new foreground #IBusAttribute.
A newly allocated #IBusAttribute.
Color in RGB.
Where attribute starts.
Where attribute ends.
Creates a new underline #IBusAttribute.
A newly allocated #IBusAttribute.
Type of underline.
Where attribute starts.
Where attribute ends.
An Emoji dictionary
file loaded from the saved cache file.
A hash table of { emoji character, #IBusEmojiData object } is loaded
from the saved cache file.
Recommend to use ibus_emoji_data_load() instead becase GSList in
GHashTable does not work with Gir and Vala.
Calls ibus_emoji_data_load() internally.
A path of the saved dictionary file.
An #IBusEmojiData of @emoji.
This API was prepared for the old dict foramat with Gir and Vala
but no longer needed.
Use ibus_emoji_data_load() instead.
An Emoji dictionary
an emoji character
Saves the Emoji dictionary to the cache file.
Recommend to use ibus_emoji_data_save() instead becase GSList in
GHashTable does not work with Gir and Vala.
Calls ibus_emoji_data_save() internally. The format of the hash table
changed and now is { emoji character, #IBusEmojiData object }.
A path of the saved dictionary file.
An Emoji dictionary
Free a list of strings.
This function has been deprecated and should
not be used in newly written code.
List of strings.
Return the D-Bus address of IBus.
It will find the address from following source:
<orderedlist>
<listitem><para>Environment variable IBUS_ADDRESS</para></listitem>
<listitem><para>Socket file under ~/.config/ibus/bus/</para></listitem>
</orderedlist>
D-Bus address of IBus. %NULL for not found.
See also: ibus_write_address().
Get UID of ibus-daemon.
This function has been deprecated and should
not be used in newly written code.
UID of ibus-daemon; or 0 if UID is not available.
translated language name
A const locale name.
Obtains the machine UUID of the machine this process is running on.
A newly allocated string that shows the UUID of the machine.
Get the path of socket file.
A newly allocated string that stores the path of socket file.
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.
A GDBus timeout in milliseconds. -1 when default timeout for
GDBus should be used.
untranslated language name
A const locale name.
Get the current user name.
It is determined by:
<orderedlist>
<listitem><para>getlogin()</para></listitem>
<listitem><para>Environment variable SUDO_USER</para></listitem>
<listitem><para>Environment variable USERHELPER_UID</para></listitem>
<listitem><para>Environment variable USERNAME</para></listitem>
<listitem><para>Environment variable LOGNAME</para></listitem>
<listitem><para>Environment variable USER</para></listitem>
<listitem><para>Environment variable LNAME</para></listitem>
</orderedlist>
A newly allocated string that stores current user name.
Provides ibus_accelerator_parse()
This section lists functions that generate debug and warning messages.
miscellaneous emoji APIs.
This file defines some error functions and definition.
An IBusHotkeyProfile associates a hotkey and an event.
This section defines the key symbols (keysym) used in IBus.
Those keysym data is converted from keysymdef.h in
FreeDesktop.
Most of the key symbols are not explicit documented,
because they are self-explaining.
see_also: #IBusKeymap, #IBusHotkeyProfile
This file defines some utility functions and definition
which are shared among ibus component and services.
This section consists generic types for IBus, including shift/control key
modifiers,
and a rectangle structure.
miscellaneous unicode APIs.
Utilized functions are available for miscellaneous purposes.
IBusVersion shows the current IBus version.
Initialize the ibus types.
Parse key event string and return key symbol and modifiers.
%TRUE for succeed; %FALSE if failed.
Key event string.
Variable that hold key symbol result.
Variable that hold modifiers result.
Return the name of a key symbol and modifiers.
For example, if press ctrl, shift, and enter, then this function returns:
Shift+Control+enter.
The name of a key symbol and modifier.
Key symbol.
Modifiers such as Ctrl or Shift.
Obtains the upper- and lower-case versions of the keyval @symbol.
Examples of keyvals are #IBUS_KEY_a, #IBUS_KEY_Return, #IBUS_KEY_F1, etc.
a keyval
return location for lowercase version of @symbol
return location for uppercase version of @symbol
Return the key symbol that associate with the key name.
Corresponding key symbol.
Key name in #gdk_keys_by_name.
Return the name of a key symbol.
Note that the returned string is used internally, so don't free it.
Corresponding key name. %NULL if no such key symbol.
Key symbol.
Converts a key value to lower case, if applicable.
the lower case form of @keyval, or @keyval itself if it is already
in lower case or it is not subject to case conversion.
a key value.
Convert from an IBus key symbol to the corresponding ISO10646 (Unicode)
character.
the corresponding unicode character, or 0 if there
is no corresponding character.
an IBus key symbol
Converts a key value to upper case, if applicable.
the upper case form of @keyval, or @keyval itself if it is already
in upper case or it is not subject to case conversion.
a key value.
Runs an IBus main loop until ibus_quit() is called in the loop.
See also: ibus_quit().
Stops an IBus from running.
Any calls to ibus_quit() for the loop will return.
See also: ibus_main().
Get a value from attachment of an #IBusSerializable.
This macro is an convenient wrapper of ibus_serializable_get_qattachment().
An #IBusSerializable.
String formatted key for indexing value.
Remove a value from attachment of an #IBusSerializable.
This macro is an convenient wrapper of ibus_serializable_remove_qattachment().
An #IBusSerializable.
String formatted key for indexing value.
Attach a value to an IBusSerializable.
This macro is an convenient wrapper of ibus_serializable_set_qattachment().
An IBusSerializable.
String formatted key for indexing value.
Value to be attached. Should be also serializable.
Set the display address.
Display address, as in DISPLAY environment for X.
Sets GLIB's log handler to ours. Our log handler adds time info
including hour, minute, second, and microsecond, like:
(ibus-daemon:7088): IBUS-DEBUG: 18:06:45.822819: ibus-daemon started
If @verbose is %TRUE, all levels of messages will be logged. Otherwise,
DEBUG and WARNING messages will be ignored. The function is used in
ibus-daemon, but can be useful for IBus client programs as well for
debugging. It's totally fine for not calling this function. If you
don't set a custom GLIB log handler, the default GLIB log handler will
be used.
TRUE for verbose logging.
Convert from a ISO10646 character to a key symbol.
the corresponding IBus key symbol, if one exists.
or, if there is no corresponding symbol,
wc | 0x01000000
a ISO10646 encoded character
Remove the log handler which is set by ibus_set_log_handler.
Write D-Bus address to socket file.
See also: ibus_get_address().
D-Bus address of IBus.
Parse a string buffer which contains an XML-formatted string,
and return a corresponding XML tree.
Root node of parsed XML tree.
Buffer to be parsed.
Parse an XML file and return a corresponding XML tree.
Root node of parsed XML tree.
File name to be parsed.