| Top |
| IBusComponent * | ibus_component_new () |
| IBusComponent * | ibus_component_new_varargs () |
| IBusComponent * | ibus_component_new_from_xml_node () |
| IBusComponent * | ibus_component_new_from_file () |
| const gchar * | ibus_component_get_name () |
| const gchar * | ibus_component_get_description () |
| const gchar * | ibus_component_get_version () |
| const gchar * | ibus_component_get_license () |
| const gchar * | ibus_component_get_author () |
| const gchar * | ibus_component_get_homepage () |
| const gchar * | ibus_component_get_exec () |
| const gchar * | ibus_component_get_textdomain () |
| void | ibus_component_add_observed_path () |
| void | ibus_component_add_engine () |
| GList * | ibus_component_get_engines () |
| void | ibus_component_output () |
| void | ibus_component_output_engines () |
| gboolean | ibus_component_check_modification () |
| GList * | ibus_component_get_observed_paths () |
| gchar * | author | Read / Write / Construct Only |
| gchar * | command-line | Read / Write / Construct Only |
| gchar * | description | Read / Write / Construct Only |
| gchar * | homepage | Read / Write / Construct Only |
| gchar * | license | Read / Write / Construct Only |
| gchar * | name | Read / Write / Construct Only |
| gchar * | textdomain | Read / Write / Construct Only |
| gchar * | version | Read / Write / Construct Only |
GObject
╰── GInitiallyUnowned
╰── IBusObject
╰── IBusSerializable
╰── IBusComponent
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
http://code.google.com/p/ibus/wiki/DevXMLIBusComponent * ibus_component_new (const gchar *name,const gchar *description,const gchar *version,const gchar *license,const gchar *author,const gchar *homepage,const gchar *command_line,const gchar *textdomain);
New an IBusComponent.
name |
Name of the component. |
|
description |
Detailed description of component. |
|
version |
Component version. |
|
license |
Distribution license of this component. |
|
author |
Author(s) of the component. |
|
homepage |
Homepage of the component. |
|
command_line |
path to component executable. |
|
textdomain |
Domain name for |
IBusComponent * ibus_component_new_varargs (const gchar *first_property_name,...);
New an 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)
IBusComponent *
ibus_component_new_from_xml_node (XMLNode *node);
New an IBusComponent from an XML tree.
IBusComponent *
ibus_component_new_from_file (const gchar *filename);
New an 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.
const gchar *
ibus_component_get_name (IBusComponent *component);
Return the name property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_description (IBusComponent *component);
Return the description property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_version (IBusComponent *component);
Return the version property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_license (IBusComponent *component);
Return the license property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_author (IBusComponent *component);
Return the author property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_homepage (IBusComponent *component);
Return the homepage property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_exec (IBusComponent *component);
Return the exec property in IBusComponent. It should not be freed.
const gchar *
ibus_component_get_textdomain (IBusComponent *component);
Return the textdomain property in IBusComponent. It should not be freed.
void ibus_component_add_observed_path (IBusComponent *component,const gchar *path,gboolean access_fs);
Add an observed path to IBusComponent.
void ibus_component_add_engine (IBusComponent *component,IBusEngineDesc *engine);
Add an engine to IBusComponent according to the description in engine
.
GList *
ibus_component_get_engines (IBusComponent *component);
Get the engines of this component.
void ibus_component_output (IBusComponent *component,GString *output,gint indent);
Output IBusComponent as an XML-formatted string. The output string can be then shown on the screen or written to file.
void ibus_component_output_engines (IBusComponent *component,GString *output,gint indent);
Output engine description as an XML-formatted string. The output string can be then shown on the screen or written to file.
gboolean
ibus_component_check_modification (IBusComponent *component);
Check whether the observed paths of component is modified.
GList *
ibus_component_get_observed_paths (IBusComponent *component);
Get the observed paths of this component.
struct IBusComponent {
/* padding */
gpointer pdummy[7]; // We can add 7 pointers without breaking the ABI.
};
An IBusComponent stores component information.
You can get extended values with g_object_get_properties.
name: Name of the component.
description: Detailed description of component.
version: Component version.
license: Distribution license of this component.
author: Author(s) of the component.
homepage: Homepage of the component.
command_line: path to component executable.
textdomain: Domain name for dgettext()
“author” property “author” gchar *
The author of component
Flags: Read / Write / Construct Only
Default value: NULL
“command-line” property “command-line” gchar *
The exec path of component
Flags: Read / Write / Construct Only
Default value: NULL
“description” property “description” gchar *
The description of component
Flags: Read / Write / Construct Only
Default value: NULL
“homepage” property “homepage” gchar *
The homepage of component
Flags: Read / Write / Construct Only
Default value: NULL
“license” property “license” gchar *
The license of component
Flags: Read / Write / Construct Only
Default value: NULL
“name” property “name” gchar *
The name of component
Flags: Read / Write / Construct Only
Default value: NULL
“textdomain” property “textdomain” gchar *
The textdomain of component
Flags: Read / Write / Construct Only
Default value: NULL