| ibusbus.h | | ibusbus.h | |
| | | | |
| skipping to change at line 20 | | skipping to change at line 20 | |
| * This library is distributed in the hope that it will be useful, | | * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
|
| | | /** | |
| | | * SECTION: ibusbus | |
| | | * @short_description: Connect with IBus daemon. | |
| | | * @stability: Stable | |
| | | * | |
| | | * An IBusBus connects with IBus daemon. | |
| | | */ | |
| #ifndef __IBUS_BUS_H_ | | #ifndef __IBUS_BUS_H_ | |
| #define __IBUS_BUS_H_ | | #define __IBUS_BUS_H_ | |
| | | | |
| #include <dbus/dbus.h> | | #include <dbus/dbus.h> | |
| #include "ibusinputcontext.h" | | #include "ibusinputcontext.h" | |
| #include "ibusconfig.h" | | #include "ibusconfig.h" | |
| #include "ibuscomponent.h" | | #include "ibuscomponent.h" | |
| | | | |
| /* | | /* | |
| * Type macros. | | * Type macros. | |
| | | | |
| skipping to change at line 51 | | skipping to change at line 58 | |
| #define IBUS_IS_BUS_CLASS(klass) \ | | #define IBUS_IS_BUS_CLASS(klass) \ | |
| (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_BUS)) | | (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_BUS)) | |
| #define IBUS_BUS_GET_CLASS(obj) \ | | #define IBUS_BUS_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_BUS, IBusBusClass)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_BUS, IBusBusClass)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusBus IBusBus; | | typedef struct _IBusBus IBusBus; | |
| typedef struct _IBusBusClass IBusBusClass; | | typedef struct _IBusBusClass IBusBusClass; | |
| | | | |
|
| | | /** | |
| | | * IBusBus: | |
| | | * | |
| | | * An opaque data type representing IBus bus (daemon communication) status. | |
| | | */ | |
| struct _IBusBus { | | struct _IBusBus { | |
| IBusObject parent; | | IBusObject parent; | |
| /* instance members */ | | /* instance members */ | |
| }; | | }; | |
| | | | |
| struct _IBusBusClass { | | struct _IBusBusClass { | |
| IBusObjectClass parent; | | IBusObjectClass parent; | |
| /* class members */ | | /* class members */ | |
| }; | | }; | |
| | | | |
| GType ibus_bus_get_type (void); | | GType ibus_bus_get_type (void); | |
|
| | | /** | |
| | | * ibus_bus_new: | |
| | | * @returns: A newly allocated IBusBus instance. | |
| | | * | |
| | | * New an IBusBus instance. | |
| | | */ | |
| IBusBus *ibus_bus_new (void); | | IBusBus *ibus_bus_new (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_is_connected: | |
| | | * @bus: An IBusBus. | |
| | | * @returns: TRUE if @bus is connected, FALSE otherwise. | |
| | | * | |
| | | * Return TRUE if @bus is connected to IBus daemon. | |
| | | */ | |
| gboolean ibus_bus_is_connected (IBusBus *bus); | | gboolean ibus_bus_is_connected (IBusBus *bus); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_get_connection: | |
| | | * @bus: An IBusBus. | |
| | | * @returns: TRUE if @bus is connected, FALSE otherwise. | |
| | | * | |
| | | * Return IBusConnection of an IBusIBus instance. | |
| | | */ | |
| IBusConnection | | IBusConnection | |
| *ibus_bus_get_connection (IBusBus *bus); | | *ibus_bus_get_connection (IBusBus *bus); | |
| /* declare dbus methods */ | | /* declare dbus methods */ | |
| const gchar *ibus_bus_hello (IBusBus *bus); | | const gchar *ibus_bus_hello (IBusBus *bus); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_request_name: | |
| | | * @bus: the IBusBus instance to be processed. | |
| | | * @name: Name to be requested. | |
| | | * @flags: Flags (FixMe). | |
| | | * @returns: 0 if failed; positive number otherwise. | |
| | | * | |
| | | * Request a name from IBus daemon. | |
| | | */ | |
| guint ibus_bus_request_name (IBusBus *bus, | | guint ibus_bus_request_name (IBusBus *bus, | |
| const gchar *name, | | const gchar *name, | |
| guint flags); | | guint flags); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_release_name: | |
| | | * @bus: An IBusBus. | |
| | | * @name: Name to be released. | |
| | | * @returns: 0 if failed; positive number otherwise. | |
| | | * | |
| | | * Release a name to IBus daemon. | |
| | | */ | |
| guint ibus_bus_release_name (IBusBus *bus, | | guint ibus_bus_release_name (IBusBus *bus, | |
| const gchar *name); | | const gchar *name); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_name_has_owner: | |
| | | * @bus: An IBusBus. | |
| | | * @name: Name to be released. | |
| | | * @returns: TRUE if the name has owner, FALSE otherwise. | |
| | | * | |
| | | * Whether the name has owner. | |
| | | */ | |
| gboolean ibus_bus_name_has_owner (IBusBus *bus, | | gboolean ibus_bus_name_has_owner (IBusBus *bus, | |
| const gchar *name); | | const gchar *name); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_list_names: | |
| | | * @bus: An IBusBus. | |
| | | * @returns: Lists that attached to @bus. | |
| | | * | |
| | | * Return lists that attached to @bus. | |
| | | * <note><para>[FixMe] Not implemented yet, only return NULL.</para></note> | |
| | | */ | |
| GList *ibus_bus_list_names (IBusBus *bus); | | GList *ibus_bus_list_names (IBusBus *bus); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_add_match: | |
| | | * @bus: An IBusBus. | |
| | | * @rule: Match rule. | |
| | | * | |
| | | * Add a match rule to an IBusBus. | |
| | | */ | |
| void ibus_bus_add_match (IBusBus *bus, | | void ibus_bus_add_match (IBusBus *bus, | |
| const gchar *rule); | | const gchar *rule); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_remove_match: | |
| | | * @bus: An IBusBus. | |
| | | * @rule: Match rule. | |
| | | * | |
| | | * Remove a match rule to an IBusBus. | |
| | | */ | |
| void ibus_bus_remove_match (IBusBus *bus, | | void ibus_bus_remove_match (IBusBus *bus, | |
| const gchar *rule); | | const gchar *rule); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_get_name_owner: | |
| | | * @bus: An IBusBus. | |
| | | * @name: Name. | |
| | | * @returns: Owner of the name. | |
| | | * | |
| | | * Return the name owner. | |
| | | */ | |
| const gchar *ibus_bus_get_name_owner (IBusBus *bus, | | const gchar *ibus_bus_get_name_owner (IBusBus *bus, | |
| const gchar *name); | | const gchar *name); | |
| /* declare ibus methods */ | | /* declare ibus methods */ | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_exit: | |
| | | * @bus: An IBusBus. | |
| | | * @restart: Whether restarting the ibus. | |
| | | * @returns: TRUE if the "Exit" call is suceeded, FALSE otherwise. | |
| | | * | |
| | | * Exit or restart an IBusBus. | |
| | | */ | |
| gboolean ibus_bus_exit (IBusBus *bus, | | gboolean ibus_bus_exit (IBusBus *bus, | |
| gboolean restart); | | gboolean restart); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_create_input_context: | |
| | | * @bus: An IBusBus. | |
| | | * @client_name: Name of client. | |
| | | * @returns: An newly allocated IBusInputContext if the "CreateInputContext | |
| | | " call | |
| | | * is suceeded, NULL otherwise. | |
| | | * | |
| | | * Create an input context for client. | |
| | | */ | |
| IBusInputContext | | IBusInputContext | |
| *ibus_bus_create_input_context | | *ibus_bus_create_input_context | |
| (IBusBus *bus, | | (IBusBus *bus, | |
| const gchar *client_name); | | const gchar *client_name); | |
|
| | | /** | |
| | | * ibus_bus_register_component: | |
| | | * @bus: An IBusBus. | |
| | | * @component: A input engine component. | |
| | | * @returns: TRUE if the "RegisterComponent" call is suceeded, FALSE otherw | |
| | | ise. | |
| | | * | |
| | | * Register a componet to an IBusBus. | |
| | | */ | |
| gboolean ibus_bus_register_component(IBusBus *bus, | | gboolean ibus_bus_register_component(IBusBus *bus, | |
| IBusComponent *component); | | IBusComponent *component); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_list_engines: | |
| | | * @bus: An IBusBus. | |
| | | * @returns: A GList of engines. | |
| | | * | |
| | | * List engines. | |
| | | * Note that this function is not yet implemented. | |
| | | */ | |
| GList *ibus_bus_list_engines (IBusBus *bus); | | GList *ibus_bus_list_engines (IBusBus *bus); | |
|
| | | | |
| | | /** | |
| | | * ibus_bus_list_active_engines: | |
| | | * @bus: An IBusBus. | |
| | | * @returns: A GList of active engines. | |
| | | * | |
| | | * List active engines. | |
| | | * Note that this function is not yet implemented. | |
| | | * <note><para>Not yet implemented.</para></note> | |
| | | */ | |
| GList *ibus_bus_list_active_engines | | GList *ibus_bus_list_active_engines | |
| (IBusBus *bus); | | (IBusBus *bus); | |
| /* declare config apis */ | | /* declare config apis */ | |
|
| IBusConfig *ibus_bus_get_config (IBusBus *bus); | | /** | |
| | | * ibus_bus_get_config: | |
| | | * @bus: An IBusBus. | |
| | | * @returns: An newly allocated IBusConfig which is configurable with @bus. | |
| | | * | |
| | | * Get the config instance from IBusBus. | |
| | | */ | |
| | | IBusConfig *ibus_bus_get_config (IBusBus *bus); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 18 change blocks. |
| 1 lines changed or deleted | | 152 lines changed or added | |
|
| ibuscomponent.h | | ibuscomponent.h | |
| | | | |
| skipping to change at line 20 | | skipping to change at line 20 | |
| * This library is distributed in the hope that it will be useful, | | * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
|
| | | /** | |
| | | * SECTION: ibuscomponent | |
| | | * @short_description: Component (executable) specification. | |
| | | * @stability: Stable | |
| | | * | |
| | | * 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="http://code.google.com/p/ibus/wiki/DevXML">http://code.googl | |
| | | e.com/p/ibus/wiki/DevXML</ulink> | |
| | | */ | |
| #ifndef __IBUS_COMPONENT_H_ | | #ifndef __IBUS_COMPONENT_H_ | |
| #define __IBUS_COMPONENT_H_ | | #define __IBUS_COMPONENT_H_ | |
| | | | |
| #include "ibusserializable.h" | | #include "ibusserializable.h" | |
| #include "ibusobservedpath.h" | | #include "ibusobservedpath.h" | |
| #include "ibusenginedesc.h" | | #include "ibusenginedesc.h" | |
| #include "ibusxml.h" | | #include "ibusxml.h" | |
| | | | |
| /* | | /* | |
| * Type macros. | | * Type macros. | |
| | | | |
| skipping to change at line 51 | | skipping to change at line 67 | |
| #define IBUS_IS_COMPONENT_CLASS(klass) \ | | #define IBUS_IS_COMPONENT_CLASS(klass) \ | |
| (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_COMPONENT)) | | (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_COMPONENT)) | |
| #define IBUS_COMPONENT_GET_CLASS(obj) \ | | #define IBUS_COMPONENT_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_COMPONENT, IBusComponentCl
ass)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_COMPONENT, IBusComponentCl
ass)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusComponent IBusComponent; | | typedef struct _IBusComponent IBusComponent; | |
| typedef struct _IBusComponentClass IBusComponentClass; | | typedef struct _IBusComponentClass IBusComponentClass; | |
| | | | |
|
| | | /** | |
| | | * 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. | |
| | | * @exec: path to component executable. | |
| | | * @textdomain: Domain name for dgettext() | |
| | | * | |
| | | * An IBusComponent stores component information. | |
| | | */ | |
| struct _IBusComponent { | | struct _IBusComponent { | |
| IBusSerializable parent; | | IBusSerializable parent; | |
| /* instance members */ | | /* instance members */ | |
| | | | |
|
| | | /*< public >*/ | |
| gchar *name; | | gchar *name; | |
| gchar *description; | | gchar *description; | |
| gchar *version; | | gchar *version; | |
| gchar *license; | | gchar *license; | |
| gchar *author; | | gchar *author; | |
| gchar *homepage; | | gchar *homepage; | |
| gchar *exec; | | gchar *exec; | |
| | | | |
| /* text domain for dgettext */ | | /* text domain for dgettext */ | |
| gchar *textdomain; | | gchar *textdomain; | |
| | | | |
|
| | | /*< private >*/ | |
| /* engines */ | | /* engines */ | |
| GList *engines; | | GList *engines; | |
| | | | |
| /* observed paths */ | | /* observed paths */ | |
| GList *observed_paths; | | GList *observed_paths; | |
| | | | |
| GPid pid; | | GPid pid; | |
| }; | | }; | |
| | | | |
| struct _IBusComponentClass { | | struct _IBusComponentClass { | |
| IBusSerializableClass parent; | | IBusSerializableClass parent; | |
| | | | |
| /* class members */ | | /* class members */ | |
| }; | | }; | |
| | | | |
| GType ibus_component_get_type (void); | | GType ibus_component_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_new: | |
| | | * @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. | |
| | | * @exec: path to component executable. | |
| | | * @textdomain: Domain name for dgettext() | |
| | | * @returns: A newly allocated IBusComponent. | |
| | | * | |
| | | * New an IBusComponent. | |
| | | */ | |
| IBusComponent *ibus_component_new (const gchar *name, | | IBusComponent *ibus_component_new (const gchar *name, | |
|
| const gchar *descritpio
n, | | const gchar *descriptio
n, | |
| const gchar *version, | | const gchar *version, | |
| const gchar *license, | | const gchar *license, | |
| const gchar *author, | | const gchar *author, | |
| const gchar *homepage, | | const gchar *homepage, | |
| const gchar *exec, | | const gchar *exec, | |
| const gchar *textdomain
); | | const gchar *textdomain
); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_new_from_xml_node: | |
| | | * @node: Root node of component XML tree. | |
| | | * @returns: A newly allocated IBusComponent. | |
| | | * | |
| | | * New an IBusComponent from an XML tree. | |
| | | */ | |
| IBusComponent *ibus_component_new_from_xml_node | | IBusComponent *ibus_component_new_from_xml_node | |
| (XMLNode *node); | | (XMLNode *node); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_new_from_file: | |
| | | * @filename: An XML file that contains component information. | |
| | | * @returns: A newly allocated IBusComponent. | |
| | | * | |
| | | * 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. | |
| | | */ | |
| IBusComponent *ibus_component_new_from_file (const gchar *filename); | | IBusComponent *ibus_component_new_from_file (const gchar *filename); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_add_observed_path: | |
| | | * @component: An IBusComponent | |
| | | * @path: Observed path to be added. | |
| | | * @access_fs: TRUE for filling the file status; FALSE otherwise. | |
| | | * | |
| | | * Add an observed path to IBusComponent. | |
| | | */ | |
| void ibus_component_add_observed_path | | void ibus_component_add_observed_path | |
| (IBusComponent *component, | | (IBusComponent *component, | |
| const gchar *path, | | const gchar *path, | |
| gboolean access_fs)
; | | gboolean access_fs)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_component_add_engine: | |
| | | * @component: An IBusComponent | |
| | | * @engine: A description of an engine. | |
| | | * | |
| | | * Add an engine to IBusComponent according to the description in @engine. | |
| | | */ | |
| void ibus_component_add_engine (IBusComponent *component, | | void ibus_component_add_engine (IBusComponent *component, | |
| IBusEngineDesc *engine); | | IBusEngineDesc *engine); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_get_engines: | |
| | | * @component: An IBusComponent. | |
| | | * @returns: A newly allocated GList that contains engines. | |
| | | * | |
| | | * Get the engines of this component. | |
| | | */ | |
| GList *ibus_component_get_engines (IBusComponent *component)
; | | GList *ibus_component_get_engines (IBusComponent *component)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_component_output: | |
| | | * @component: An IBusComponent. | |
| | | * @output: GString that holds the result. | |
| | | * @indent: level of 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 (IBusComponent *component, | | void ibus_component_output (IBusComponent *component, | |
| GString *output, | | GString *output, | |
| gint indent); | | gint indent); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_output_engines: | |
| | | * @component: An IBusComponent. | |
| | | * @output: GString that holds the result. | |
| | | * @indent: 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. | |
| | | */ | |
| void ibus_component_output_engines (IBusComponent *component, | | void ibus_component_output_engines (IBusComponent *component, | |
| GString *output, | | GString *output, | |
| gint indent); | | gint indent); | |
|
| | | | |
| | | /** | |
| | | * ibus_component_check_modification: | |
| | | * @component: An IBusComponent. | |
| | | * @returns: TRUE if at least one of the observed paths is modified; FALSE | |
| | | otherwise. | |
| | | * | |
| | | * Check whether the observed paths of component is modified. | |
| | | */ | |
| gboolean ibus_component_check_modification | | gboolean ibus_component_check_modification | |
| (IBusComponent *component)
; | | (IBusComponent *component)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_component_start: | |
| | | * @component: An IBusComponent. | |
| | | * @returns: TRUE if the component is started; FALSE otherwise. | |
| | | * | |
| | | * Whether the IBusComponent is started. | |
| | | */ | |
| gboolean ibus_component_start (IBusComponent *component)
; | | gboolean ibus_component_start (IBusComponent *component)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_component_stop: | |
| | | * @component: An IBusComponent. | |
| | | * @returns: TRUE if the component is stopped; FALSE otherwise. | |
| | | * | |
| | | * Whether the IBusComponent is stopped. | |
| | | */ | |
| gboolean ibus_component_stop (IBusComponent *component)
; | | gboolean ibus_component_stop (IBusComponent *component)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_component_is_running: | |
| | | * @component: An IBusComponent. | |
| | | * @returns: TRUE if the component is running; FALSE otherwise. | |
| | | * | |
| | | * Whether the IBusComponent is running. | |
| | | */ | |
| gboolean ibus_component_is_running (IBusComponent *component)
; | | gboolean ibus_component_is_running (IBusComponent *component)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_component_get_from_engine: | |
| | | * @engine: A description of an engine. | |
| | | * @returns: An IBusComponent of the engine. | |
| | | * | |
| | | * Get the IBusComponent from an engine description. | |
| | | */ | |
| IBusComponent *ibus_component_get_from_engine (IBusEngineDesc *engine); | | IBusComponent *ibus_component_get_from_engine (IBusEngineDesc *engine); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 18 change blocks. |
| 1 lines changed or deleted | | 153 lines changed or added | |
|
| ibusconfigservice.h | | ibusconfigservice.h | |
| | | | |
| skipping to change at line 20 | | skipping to change at line 20 | |
| * This library is distributed in the hope that it will be useful, | | * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
|
| | | /** | |
| | | * SECTION: ibusconfigservice | |
| | | * @short_description: Configuration service back-end. | |
| | | * @stability: Stable | |
| | | * | |
| | | * An IBusConfigService is a base class for other configuration services su | |
| | | ch 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.</lis | |
| | | titem> | |
| | | * </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.</lis | |
| | | titem> | |
| | | * </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> | |
| | | * </itemizedlist> | |
| | | */ | |
| #ifndef __IBUS_CONFIG_SERVICE_H_ | | #ifndef __IBUS_CONFIG_SERVICE_H_ | |
| #define __IBUS_CONFIG_SERVICE_H_ | | #define __IBUS_CONFIG_SERVICE_H_ | |
| | | | |
| #include "ibuserror.h" | | #include "ibuserror.h" | |
| #include "ibusservice.h" | | #include "ibusservice.h" | |
| | | | |
| /* | | /* | |
| * Type macros. | | * Type macros. | |
| */ | | */ | |
| | | | |
| | | | |
| skipping to change at line 49 | | skipping to change at line 127 | |
| #define IBUS_IS_CONFIG_SERVICE_CLASS(klass) \ | | #define IBUS_IS_CONFIG_SERVICE_CLASS(klass) \ | |
| (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_CONFIG_SERVICE)) | | (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_CONFIG_SERVICE)) | |
| #define IBUS_CONFIG_SERVICE_GET_CLASS(obj) \ | | #define IBUS_CONFIG_SERVICE_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_CONFIG_SERVICE, IBusConfig
ServiceClass)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_CONFIG_SERVICE, IBusConfig
ServiceClass)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusConfigService IBusConfigService; | | typedef struct _IBusConfigService IBusConfigService; | |
| typedef struct _IBusConfigServiceClass IBusConfigServiceClass; | | typedef struct _IBusConfigServiceClass IBusConfigServiceClass; | |
| | | | |
|
| | | /** | |
| | | * IBusConfigService: | |
| | | * | |
| | | * An opaque data type representing a configure service. | |
| | | */ | |
| struct _IBusConfigService { | | struct _IBusConfigService { | |
|
| | | /*< private >*/ | |
| IBusService parent; | | IBusService parent; | |
| | | | |
| /* instance members */ | | /* instance members */ | |
| }; | | }; | |
| | | | |
| struct _IBusConfigServiceClass { | | struct _IBusConfigServiceClass { | |
| IBusServiceClass parent; | | IBusServiceClass parent; | |
| | | | |
| /* class members */ | | /* class members */ | |
| gboolean (* set_value) (IBusConfigService *config, | | gboolean (* set_value) (IBusConfigService *config, | |
| | | | |
| skipping to change at line 76 | | skipping to change at line 160 | |
| const gchar *name, | | const gchar *name, | |
| GValue *value, | | GValue *value, | |
| IBusError **error); | | IBusError **error); | |
| | | | |
| /*< private >*/ | | /*< private >*/ | |
| /* padding */ | | /* padding */ | |
| gpointer pdummy[14]; | | gpointer pdummy[14]; | |
| }; | | }; | |
| | | | |
| GType ibus_config_service_get_type (void); | | GType ibus_config_service_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_config_service_new: | |
| | | * @connection: An IBusConnection. | |
| | | * @returns: A newly allocated IBusConfigServices. | |
| | | * | |
| | | * New an IBusConfigService from an IBusConnection. | |
| | | */ | |
| IBusConfigService *ibus_config_service_new (IBusConnection *co
nnection); | | IBusConfigService *ibus_config_service_new (IBusConnection *co
nnection); | |
|
| | | | |
| | | /** | |
| | | * ibus_config_service_value_changed: | |
| | | * @config: An IBusConfigService. | |
| | | * @section: Section name of the configuration option. | |
| | | * @name: Name of the configure option. | |
| | | * @value: GValue that holds the value. | |
| | | * | |
| | | * Change a value of a configuration option | |
| | | * by sending a "ValueChanged" message to IBus service. | |
| | | */ | |
| void ibus_config_service_value_changed | | void ibus_config_service_value_changed | |
| (IBusConfigService *co
nfig, | | (IBusConfigService *co
nfig, | |
| const gchar *se
ction, | | const gchar *se
ction, | |
| const gchar *na
me, | | const gchar *na
me, | |
| const GValue *va
lue); | | const GValue *va
lue); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 5 change blocks. |
| 0 lines changed or deleted | | 108 lines changed or added | |
|
| ibusconnection.h | | ibusconnection.h | |
| | | | |
| skipping to change at line 23 | | skipping to change at line 23 | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
| /** | | /** | |
| * SECTION: ibusconnection | | * SECTION: ibusconnection | |
| * @short_description: DBusConnection wrapper. | | * @short_description: DBusConnection wrapper. | |
|
| * @see_also: <ulink url="http://dbus.freedesktop.org/doc/api/html/structDB | | * @stability: Stable | |
| usConnection.html">DBusConnection</ulink> | | * @see_also: IBusMessage | |
| | | * <ulink url="http://dbus.freedesktop.org/doc/api/html/structDBusConnectio | |
| | | n.html">DBusConnection</ulink> | |
| * | | * | |
|
| * An IBusConnection provides DBusConnection wrapper. | | * An IBusConnection provides #DBusConnection wrapper, and is used to conne | |
| * It can be used to connect to either dBus or iBus daemon. | | ct to either D-Bus or IBus daemon. | |
| | | * Usually, IBusConnection is set to a #DBusConnection and emitting ibus-me | |
| | | ssage when | |
| | | * receiving incoming messages from the #DBusConnection. | |
| */ | | */ | |
| | | | |
| #ifndef __IBUS_CONNECTION_H_ | | #ifndef __IBUS_CONNECTION_H_ | |
| #define __IBUS_CONNECTION_H_ | | #define __IBUS_CONNECTION_H_ | |
| | | | |
| #include <dbus/dbus.h> | | #include <dbus/dbus.h> | |
| #include "ibusmessage.h" | | #include "ibusmessage.h" | |
| #include "ibuspendingcall.h" | | #include "ibuspendingcall.h" | |
| #include "ibusobject.h" | | #include "ibusobject.h" | |
| #include "ibuserror.h" | | #include "ibuserror.h" | |
| | | | |
| skipping to change at line 61 | | skipping to change at line 64 | |
| #define IBUS_IS_CONNECTION_CLASS(klass) \ | | #define IBUS_IS_CONNECTION_CLASS(klass) \ | |
| (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_CONNECTION)) | | (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_CONNECTION)) | |
| #define IBUS_CONNECTION_GET_CLASS(obj) \ | | #define IBUS_CONNECTION_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_CONNECTION, IBusConnection
Class)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_CONNECTION, IBusConnection
Class)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusConnection IBusConnection; | | typedef struct _IBusConnection IBusConnection; | |
| typedef struct _IBusConnectionClass IBusConnectionClass; | | typedef struct _IBusConnectionClass IBusConnectionClass; | |
| | | | |
|
| | | /** | |
| | | * IBusIBusMessageFunc: | |
| | | * @connection: An IBusConnection. | |
| | | * @message: An IBusMessage. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Prototype of an IBusIBusMessage callback function. | |
| | | */ | |
| typedef gboolean (* IBusIBusMessageFunc)(IBusConnection *connection, | | typedef gboolean (* IBusIBusMessageFunc)(IBusConnection *connection, | |
| IBusMessage *message); | | IBusMessage *message); | |
|
| | | | |
| | | /** | |
| | | * IBusIBusSignalFunc: | |
| | | * @connection: An IBusConnection. | |
| | | * @message: An IBusMessage. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Prototype of an IBusIBusSignal callback function. | |
| | | */ | |
| typedef gboolean (* IBusIBusSignalFunc) (IBusConnection *connection, | | typedef gboolean (* IBusIBusSignalFunc) (IBusConnection *connection, | |
| IBusMessage *message); | | IBusMessage *message); | |
|
| | | | |
| | | /** | |
| | | * IBusMessageFunc: | |
| | | * @connection: An IBusConnection. | |
| | | * @message: An IBusMessage. | |
| | | * @user_data: User data for the callback function. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Prototype of an IBusMessage callback function. | |
| | | */ | |
| typedef gboolean (* IBusMessageFunc) (IBusConnection *connection, | | typedef gboolean (* IBusMessageFunc) (IBusConnection *connection, | |
| IBusMessage *message, | | IBusMessage *message, | |
| gpointer user_data); | | gpointer user_data); | |
|
| | | | |
| | | /** | |
| | | * IBusConnectionReplyFunc: | |
| | | * @connection: An IBusConnection. | |
| | | * @reply: An IBusMessage. | |
| | | * @user_data: User data for the callback function. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Prototype of an IBusConnectionReplyFunc callback function. | |
| | | */ | |
| typedef void (* IBusConnectionReplyFunc) | | typedef void (* IBusConnectionReplyFunc) | |
| (IBusConnection *connection, | | (IBusConnection *connection, | |
| IBusMessage *reply, | | IBusMessage *reply, | |
| gpointer user_data); | | gpointer user_data); | |
| | | | |
|
| | | /** | |
| | | * IBusConnection: | |
| | | * | |
| | | * An opaque data type representing an IBusConnection. | |
| | | */ | |
| struct _IBusConnection { | | struct _IBusConnection { | |
| IBusObject parent; | | IBusObject parent; | |
| /* instance members */ | | /* instance members */ | |
| }; | | }; | |
| | | | |
| struct _IBusConnectionClass { | | struct _IBusConnectionClass { | |
| IBusObjectClass parent; | | IBusObjectClass parent; | |
| | | | |
| /* signals */ | | /* signals */ | |
| gboolean (* ibus_message) (IBusConnection *connection, | | gboolean (* ibus_message) (IBusConnection *connection, | |
| | | | |
| skipping to change at line 97 | | skipping to change at line 142 | |
| (IBusConnection *connection, | | (IBusConnection *connection, | |
| IBusMessage *message); | | IBusMessage *message); | |
| void (* disconnected) (IBusConnection *connection); | | void (* disconnected) (IBusConnection *connection); | |
| | | | |
| /*< private >*/ | | /*< private >*/ | |
| /* padding */ | | /* padding */ | |
| gpointer pdummy[4]; | | gpointer pdummy[4]; | |
| }; | | }; | |
| | | | |
| GType ibus_connection_get_type (void); | | GType ibus_connection_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_new: | |
| | | * @returns: An newly allocated IBusConnection. | |
| | | * | |
| | | * New an IBusConnection. | |
| | | */ | |
| IBusConnection *ibus_connection_new (void); | | IBusConnection *ibus_connection_new (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_set_connection: | |
| | | * @connection: An IBusConnection. | |
| | | * @dbus_connection: A D-Bus connection. | |
| | | * @shared: Whether the @dbus_connection is shared. | |
| | | * | |
| | | * Set an IBusConnection as data of a D-Bus connection. | |
| | | * Emit signal <constant>ibus-message</constant> when receiving incoming me | |
| | | ssage from @dbus_connection. | |
| | | */ | |
| void ibus_connection_set_connection (IBusConnection *co
nnection, | | void ibus_connection_set_connection (IBusConnection *co
nnection, | |
| DBusConnection *db
us_connection, | | DBusConnection *db
us_connection, | |
| gboolean sh
ared); | | gboolean sh
ared); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_open: | |
| | | * @address: A remote address. | |
| | | * @returns: A newly allocated IBusConnection which is set to a D-Bus conne | |
| | | ction corresponding to @address. | |
| | | * | |
| | | * Open an IBusConnection that is set to a D-Bus connection to the specifie | |
| | | d address. | |
| | | * Use ibus_connection_open_private() to get a dedicated connection not sha | |
| | | red with other callers of | |
| | | * ibus_connection_open(). | |
| | | * | |
| | | * @see_also: ibus_connection_open_private(). | |
| | | */ | |
| IBusConnection *ibus_connection_open (const gchar *ad
dress); | | IBusConnection *ibus_connection_open (const gchar *ad
dress); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_open_private: | |
| | | * @address: A remote address. | |
| | | * @returns: A newly allocated IBusConnection which is set to a D-Bus conne | |
| | | ction corresponding to @address. | |
| | | * | |
| | | * Open an IBusConnection that is set to a D-Bus connection to the specifie | |
| | | d address. | |
| | | * Unlike ibus_connection_open(), this function always creates a new D-Bus | |
| | | connection. | |
| | | * The D-Bus connection will not be saved or recycled by libdbus. | |
| | | * | |
| | | * In D-Bus documentation, dbus_connection_open() is preferred over dbus_co | |
| | | nnection_open_private(), | |
| | | * so should ibus_connection_open() be preferred over ibus_connection_open_ | |
| | | private(). | |
| | | * | |
| | | * @see_also: ibus_connection_open(). | |
| | | */ | |
| IBusConnection *ibus_connection_open_private (const gchar *ad
dress); | | IBusConnection *ibus_connection_open_private (const gchar *ad
dress); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_close: | |
| | | * @connection: An IBusConnection. | |
| | | * | |
| | | * Close an IBusCOnnection and corresponding D-Bus connection. | |
| | | */ | |
| void ibus_connection_close (IBusConnection *co
nnection); | | void ibus_connection_close (IBusConnection *co
nnection); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_is_connected: | |
| | | * @connection: An IBusConnection. | |
| | | * @returns: TRUE for connected; FALSE otherwise. | |
| | | * | |
| | | * Whether an IBusConnection is connected. | |
| | | */ | |
| gboolean ibus_connection_is_connected (IBusConnection *co
nnection); | | gboolean ibus_connection_is_connected (IBusConnection *co
nnection); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_get_connection: | |
| | | * @connection: An IBusConnection. | |
| | | * @returns: The corresponding DBusConnection. | |
| | | * | |
| | | * Return corresponding DBusConnection. | |
| | | */ | |
| DBusConnection *ibus_connection_get_connection (IBusConnection *co
nnection); | | DBusConnection *ibus_connection_get_connection (IBusConnection *co
nnection); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_read_write_dispatch: | |
| | | * @connection: An IBusConnection. | |
| | | * @timeout: Maximum time to block or -1 for infinite. | |
| | | * @returns: TRUE if the disconnect message has not been processed; FALSE o | |
| | | therwise. | |
| | | * | |
| | | * Return TRUE if the disconnect message has not been processed. | |
| | | * This function is a wrapper of dbus_connection_read_write_dispatch(), | |
| | | * which is also intended for use with applications that don't want to | |
| | | * write a main loop and deal with DBusWatch and DBusTimeout. | |
| | | * Following text is | |
| | | * from the documentation of dbus_connection_read_write_dispatch(): | |
| | | * An example usage would be: | |
| | | * <informalexample> | |
| | | * <programlisting> | |
| | | * while (dbus_connection_read_write_dispatch (connection, -1)) | |
| | | * ; // empty loop body | |
| | | * </programlisting> | |
| | | * </informalexample> | |
| | | * In this usage you would normally have set up a filter function to look a | |
| | | t each message as it is dispatched. | |
| | | * The loop terminates when the last message from the connection (the disco | |
| | | nnected signal) is processed. | |
| | | * | |
| | | * If there are messages to dispatch, this function will dbus_connection_di | |
| | | spatch() once, and return. | |
| | | * If there are no messages to dispatch, this function will block until it | |
| | | can read or write, | |
| | | * then read or write, then return. | |
| | | * | |
| | | * The way to think of this function is that it either makes some sort of p | |
| | | rogress, | |
| | | * or it blocks. Note that, while it is blocked on I/O, it cannot be interr | |
| | | upted (even by other threads), | |
| | | * which makes this function unsuitable for applications that do more than | |
| | | just react to received messages. | |
| | | * | |
| | | * @see_also: dbus_connection_read_write_dispatch(). | |
| | | */ | |
| gboolean ibus_connection_read_write_dispatch(IBusConnection *co
nnection, | | gboolean ibus_connection_read_write_dispatch(IBusConnection *co
nnection, | |
| gint ti
meout); | | gint ti
meout); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_send: | |
| | | * @connection: An IBusConnection. | |
| | | * @message: IBusMessage to be sent. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Send an IBusMessage to an IBusConnection. | |
| | | * If succeed, signal <constant>ibus-message-sent</constant> is emitted. | |
| | | * | |
| | | * @see_also: ibus_connection_send_with_reply(), ibus_connection_send_with_ | |
| | | reply_and_block(), | |
| | | * ibus_connection_send_signal(), ibus_connection_send_signal_valist(), ibu | |
| | | s_connection_send_valist(), | |
| | | * dbus_connection_send(). | |
| | | */ | |
| gboolean ibus_connection_send (IBusConnection *co
nnection, | | gboolean ibus_connection_send (IBusConnection *co
nnection, | |
| IBusMessage *me
ssage); | | IBusMessage *me
ssage); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_send_signal: | |
| | | * @connection: An IBusConnection. | |
| | | * @path: The path to the object emitting the signal. | |
| | | * @interface: The interface the signal is emitted from. | |
| | | * @name: Name of the signal. | |
| | | * @first_arg_type: Type of first arg. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Send a wrapped D-Bus signal to an IBusConnection. | |
| | | * This function wraps a signal as an IBusMessage, then sent the IBusMessag | |
| | | e | |
| | | * via ibus_connection_send(). | |
| | | * | |
| | | * @see_also: ibus_connection_send(), ibus_connection_send_signal_valist(), | |
| | | ibus_message_new_signal(). | |
| | | */ | |
| gboolean ibus_connection_send_signal (IBusConnection *co
nnection, | | gboolean ibus_connection_send_signal (IBusConnection *co
nnection, | |
| const gchar *pa
th, | | const gchar *pa
th, | |
| const gchar *in
terface, | | const gchar *in
terface, | |
| const gchar *na
me, | | const gchar *na
me, | |
| GType fi
rst_arg_type, | | GType fi
rst_arg_type, | |
| ...); | | ...); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_send_signal_valist: | |
| | | * @connection: An IBusConnection. | |
| | | * @path: The path to the object emitting the signal. | |
| | | * @interface: The interface the signal is emitted from. | |
| | | * @name: Name of the signal. | |
| | | * @first_arg_type: Type of first arg. | |
| | | * @args: Ret of arguments. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Send a wrapped D-Bus signal to an IBusConnection. | |
| | | * This function wraps a signal as an IBusMessage, then sent the IBusMessag | |
| | | e | |
| | | * via ibus_connection_send(). | |
| | | * | |
| | | * @see_also: ibus_connection_send(), ibus_connection_send_signal(), ibus_c | |
| | | onnection_send_valist(), | |
| | | * ibus_message_new_signal(). | |
| | | */ | |
| gboolean ibus_connection_send_signal_valist (IBusConnection *co
nnection, | | gboolean ibus_connection_send_signal_valist (IBusConnection *co
nnection, | |
| const gchar *pa
th, | | const gchar *pa
th, | |
| const gchar *in
terface, | | const gchar *in
terface, | |
| const gchar *na
me, | | const gchar *na
me, | |
| GType fi
rst_arg_type, | | GType fi
rst_arg_type, | |
| va_list ar
gs); | | va_list ar
gs); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_send_valist: | |
| | | * @connection: An IBusConnection. | |
| | | * @message_type: Message type. | |
| | | * @path: The path to the object emitting the signal. | |
| | | * @interface: The interface the signal is emitted from. | |
| | | * @name: Name of the signal. | |
| | | * @first_arg_type: Type of first arg. | |
| | | * @args: Ret of arguments. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Send a wrapped D-Bus message to an IBusConnection. | |
| | | * | |
| | | * This function wraps a D-Bus message as an IBusMessage, then sent the IBu | |
| | | sMessage | |
| | | * via ibus_connection_send(). | |
| | | * | |
| | | * Message type can be specified with @message_type. | |
| | | * Types include <constant>DBUS_MESSAGE_TYPE_METHOD_CALL</constant>, | |
| | | * <constant>DBUS_MESSAGE_TYPE_METHOD_RETURN</constant>, | |
| | | * <constant>DBUS_MESSAGE_TYPE_ERROR</constant>, | |
| | | * <constant>DBUS_MESSAGE_TYPE_SIGNAL</constant>, | |
| | | * but other types are allowed and all code must silently ignore messages o | |
| | | f unknown type. | |
| | | * <constant>DBUS_MESSAGE_TYPE_INVALID</constant> will never be returned. | |
| | | * | |
| | | * @see_also: ibus_connection_send(), ibus_connection_send_singal_valist(), | |
| | | * ibus_connection_call(), | |
| | | * ibus_message_new_signal(), | |
| | | * dbus_message_get_type(). | |
| | | */ | |
| gboolean ibus_connection_send_valist (IBusConnection *co
nnection, | | gboolean ibus_connection_send_valist (IBusConnection *co
nnection, | |
| gint me
ssage_type, | | gint me
ssage_type, | |
| const gchar *pa
th, | | const gchar *pa
th, | |
| const gchar *in
terface, | | const gchar *in
terface, | |
| const gchar *na
me, | | const gchar *na
me, | |
| GType fi
rst_arg_type, | | GType fi
rst_arg_type, | |
| va_list ar
gs); | | va_list ar
gs); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_send_with_reply: | |
| | | * @connection: An IBusConnection. | |
| | | * @message: An IBusMessage. | |
| | | * @pending_return: Return location for a DBusPendingCall object, or NULL i | |
| | | f connection is disconnected. | |
| | | * @timeout_milliseconds: timeout in milliseconds or -1 for default. | |
| | | * @returns: FALSE if no memory, TRUE otherwise. | |
| | | * | |
| | | * Queues an IBusMessage to send, but also returns a DBusPendingCall used | |
| | | to receive a reply to the message. | |
| | | * This function is a wrapper of dbus_connection_send_with_reply(). | |
| | | * | |
| | | * @see_also: ibus_connection_send(), ibus_connection_send_with_reply_and_b | |
| | | lock(), | |
| | | * #DBusPendingCall, dbus_connection_send_with_reply() | |
| | | */ | |
| gboolean ibus_connection_send_with_reply (IBusConnection *co
nnection, | | gboolean ibus_connection_send_with_reply (IBusConnection *co
nnection, | |
| IBusMessage *me
ssage, | | IBusMessage *me
ssage, | |
| IBusPendingCall **pe
nding_return, | | IBusPendingCall **pe
nding_return, | |
| gint ti
meout_milliseconds); | | gint ti
meout_milliseconds); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_send_with_reply_and_block: | |
| | | * @connection: An IBusConnection. | |
| | | * @message: An IBusMessage. | |
| | | * @timeout_milliseconds: timeout in milliseconds or -1 for default. | |
| | | * @error: Error is stored here; NULL to ignore error. | |
| | | * @returns: The message that is the reply or NULL with an error code if th | |
| | | e function fails. | |
| | | * | |
| | | * Sends an IBus message and blocks a certain time period while waiting for | |
| | | a reply. | |
| | | * If reply is not NULL, signal <constant>ibus-message-sent</constant> is | |
| | | emitted. | |
| | | * | |
| | | * @see_also: ibus_connection_send(), ibus_connection_send_with_reply(), | |
| | | * #DBusPendingCall, dbus_connection_send_with_reply_and_block() | |
| | | */ | |
| IBusMessage *ibus_connection_send_with_reply_and_block | | IBusMessage *ibus_connection_send_with_reply_and_block | |
| (IBusConnection *co
nnection, | | (IBusConnection *co
nnection, | |
| IBusMessage *me
ssage, | | IBusMessage *me
ssage, | |
| gint ti
meout_milliseconds, | | gint ti
meout_milliseconds, | |
| IBusError **e
rror); | | IBusError **e
rror); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_call: | |
| | | * @connection: An IBusConnection. | |
| | | * @name: Name of the signal. | |
| | | * @path: The path to the object emitting the signal. | |
| | | * @interface: The interface the signal is emitted from. | |
| | | * @member: The name of the member function to be called. | |
| | | * @error: Error is stored here; NULL to ignore error. | |
| | | * @first_arg_type: Type of first arg. | |
| | | * @returns: TRUE if succeed; FALSE otherwise. | |
| | | * | |
| | | * Invoke a member function by sending an IBusMessage. | |
| | | * | |
| | | * @see_also: ibus_connection_send_valist(). | |
| | | */ | |
| gboolean ibus_connection_call (IBusConnection *co
nnection, | | gboolean ibus_connection_call (IBusConnection *co
nnection, | |
| const gchar *na
me, | | const gchar *na
me, | |
| const gchar *pa
th, | | const gchar *pa
th, | |
| const gchar *in
terface, | | const gchar *in
terface, | |
| const gchar *me
mber, | | const gchar *me
mber, | |
| IBusError **e
rror, | | IBusError **e
rror, | |
| GType fir
st_arg_type, | | GType fir
st_arg_type, | |
| ...); | | ...); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_flush: | |
| | | * @connection: An IBusConnection. | |
| | | * | |
| | | * Blocks until the outgoing message queue is empty. | |
| | | * This function is a wrapper of dbus_connection_flush(). | |
| | | * | |
| | | * @see_also: dbus_connection_flush() | |
| | | */ | |
| void ibus_connection_flush (IBusConnection *co
nnection); | | void ibus_connection_flush (IBusConnection *co
nnection); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_register_object_path: | |
| | | * @connection: An IBusConnection. | |
| | | * @path: Object path to be register. | |
| | | * @message_func: Callback function for message handling. | |
| | | * @user_data: User data for @message_func. | |
| | | * @returns: FALSE if fail because of out of memory; TRUE otherwise. | |
| | | * | |
| | | * Registers a handler for a given path in the object hierarchy. | |
| | | * The given vtable handles messages sent to exactly the given path. | |
| | | * This function is a wrapper of dbus_connection_register_object_path(). | |
| | | * | |
| | | * @see_also: ibus_connection_register_object_path() | |
| | | */ | |
| gboolean ibus_connection_register_object_path | | gboolean ibus_connection_register_object_path | |
| (IBusConnection *co
nnection, | | (IBusConnection *co
nnection, | |
| const gchar *pa
th, | | const gchar *pa
th, | |
| IBusMessageFunc mes
sage_func, | | IBusMessageFunc mes
sage_func, | |
| gpointer use
r_data); | | gpointer use
r_data); | |
|
| | | | |
| | | /** | |
| | | * ibus_connection_unregister_object_path: | |
| | | * @connection: An IBusConnection. | |
| | | * @path: Object path to be unregister. | |
| | | * @returns: FALSE if fail because of out of memory; TRUE otherwise. | |
| | | * | |
| | | * Unregisters the handler registered with exactly the given path. | |
| | | * It's a bug to call this function for a path that isn't registered. | |
| | | * Can unregister both fallback paths and object paths. | |
| | | * This function is a wrapper of dbus_connection_unregister_object_path() | |
| | | */ | |
| gboolean ibus_connection_unregister_object_path | | gboolean ibus_connection_unregister_object_path | |
| (IBusConnection *co
nnection, | | (IBusConnection *co
nnection, | |
| const gchar *pa
th); | | const gchar *pa
th); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 25 change blocks. |
| 4 lines changed or deleted | | 343 lines changed or added | |
|
| ibusengine.h | | ibusengine.h | |
| | | | |
| skipping to change at line 20 | | skipping to change at line 20 | |
| * This library is distributed in the hope that it will be useful, | | * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
|
| | | /** | |
| | | * SECTION: ibusengine | |
| | | * @short_description: Input method engine abstract. | |
| | | * @stability: Stable | |
| | | * @see_also: #IBusComponent, #IBusEngineDesc | |
| | | * | |
| | | * An IBusEngine provides infrastructure for input method engine. | |
| | | * Developers can "extend" this class for input method engine development. | |
| | | */ | |
| #ifndef __IBUS_ENGINE_H_ | | #ifndef __IBUS_ENGINE_H_ | |
| #define __IBUS_ENGINE_H_ | | #define __IBUS_ENGINE_H_ | |
| | | | |
| #include <dbus/dbus.h> | | #include <dbus/dbus.h> | |
| #include "ibusservice.h" | | #include "ibusservice.h" | |
| #include "ibusattribute.h" | | #include "ibusattribute.h" | |
| #include "ibuslookuptable.h" | | #include "ibuslookuptable.h" | |
| #include "ibusproperty.h" | | #include "ibusproperty.h" | |
| | | | |
| /* | | /* | |
| | | | |
| skipping to change at line 52 | | skipping to change at line 61 | |
| #define IBUS_IS_ENGINE_CLASS(klass) \ | | #define IBUS_IS_ENGINE_CLASS(klass) \ | |
| (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_ENGINE)) | | (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_ENGINE)) | |
| #define IBUS_ENGINE_GET_CLASS(obj) \ | | #define IBUS_ENGINE_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_ENGINE, IBusEngineClass)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_ENGINE, IBusEngineClass)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusEngine IBusEngine; | | typedef struct _IBusEngine IBusEngine; | |
| typedef struct _IBusEngineClass IBusEngineClass; | | typedef struct _IBusEngineClass IBusEngineClass; | |
| | | | |
|
| | | /** | |
| | | * IBusEngine: | |
| | | * @enabled: Whether the engine is enabled. | |
| | | * @has_focus: Whether the engine has focus. | |
| | | * @cursor_area: Area of cursor. | |
| | | * @client_capabilities: IBusCapabilite (client capabilities) flags. | |
| | | * | |
| | | * IBusEngine properties. | |
| | | */ | |
| struct _IBusEngine { | | struct _IBusEngine { | |
| IBusService parent; | | IBusService parent; | |
| /* instance members */ | | /* instance members */ | |
|
| | | /*< public >*/ | |
| gboolean enabled; | | gboolean enabled; | |
| gboolean has_focus; | | gboolean has_focus; | |
| | | | |
| /* cursor location */ | | /* cursor location */ | |
| IBusRectangle cursor_area; | | IBusRectangle cursor_area; | |
| guint client_capabilities; | | guint client_capabilities; | |
| }; | | }; | |
| | | | |
| struct _IBusEngineClass { | | struct _IBusEngineClass { | |
| IBusServiceClass parent; | | IBusServiceClass parent; | |
| | | | |
| skipping to change at line 106 | | skipping to change at line 125 | |
| const gchar *prop_name); | | const gchar *prop_name); | |
| void (* property_hide) (IBusEngine *engine, | | void (* property_hide) (IBusEngine *engine, | |
| const gchar *prop_name); | | const gchar *prop_name); | |
| | | | |
| /*< private >*/ | | /*< private >*/ | |
| /* padding */ | | /* padding */ | |
| gpointer pdummy[9]; | | gpointer pdummy[9]; | |
| }; | | }; | |
| | | | |
| GType ibus_engine_get_type (void); | | GType ibus_engine_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_new: | |
| | | * @name: Name of the IBusObject. | |
| | | * @path: Path for IBusService. | |
| | | * @connection: An opened IBusConnection. | |
| | | * @returns: A newly allocated IBusEngine. | |
| | | * | |
| | | * New an IBusEngine. | |
| | | */ | |
| IBusEngine *ibus_engine_new (const gchar *name, | | IBusEngine *ibus_engine_new (const gchar *name, | |
| const gchar *path, | | const gchar *path, | |
| IBusConnection *connection); | | IBusConnection *connection); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_commit_text: | |
| | | * @engine: An IBusEngine. | |
| | | * @text: String commit to IBusEngine. | |
| | | * | |
| | | * Commit output of input method to IBus client. | |
| | | */ | |
| void ibus_engine_commit_text (IBusEngine *engine, | | void ibus_engine_commit_text (IBusEngine *engine, | |
| IBusText *text); | | IBusText *text); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_update_preedit_text: | |
| | | * @engine: An IBusEngine. | |
| | | * @text: Update content. | |
| | | * @cursor_pos: Current position of cursor | |
| | | * @visible: Whether the pre-edit buffer is visible. | |
| | | * | |
| | | * Update the pre-edit buffer. | |
| | | */ | |
| void ibus_engine_update_preedit_text | | void ibus_engine_update_preedit_text | |
| (IBusEngine *engine, | | (IBusEngine *engine, | |
| IBusText *text, | | IBusText *text, | |
| guint cursor_pos, | | guint cursor_pos, | |
| gboolean visible); | | gboolean visible); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_show_preedit_text: | |
| | | * @engine: An IBusEngine. | |
| | | * | |
| | | * Show the pre-edit buffer. | |
| | | */ | |
| void ibus_engine_show_preedit_text | | void ibus_engine_show_preedit_text | |
| (IBusEngine *engine); | | (IBusEngine *engine); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_hide_preedit_text: | |
| | | * @engine: An IBusEngine. | |
| | | * | |
| | | * Hide the pre-edit buffer. | |
| | | */ | |
| void ibus_engine_hide_preedit_text | | void ibus_engine_hide_preedit_text | |
| (IBusEngine *engine); | | (IBusEngine *engine); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_update_auxiliary_text: | |
| | | * @engine: An IBusEngine. | |
| | | * @text: Update content. | |
| | | * @visible: Whether the auxiliary text bar is visible. | |
| | | * | |
| | | * Update the auxiliary bar. | |
| | | */ | |
| void ibus_engine_update_auxiliary_text | | void ibus_engine_update_auxiliary_text | |
|
| (IBusEngine *engine, | | (IBusEngine *engine, | |
| IBusText *text, | | IBusText *text, | |
| gboolean visible); | | gboolean visible); | |
| | | | |
| | | /** | |
| | | * ibus_engine_show_auxiliary_text: | |
| | | * @engine: An IBusEngine. | |
| | | * | |
| | | * Show the auxiliary bar. | |
| | | */ | |
| void ibus_engine_show_auxiliary_text | | void ibus_engine_show_auxiliary_text | |
| (IBusEngine *engine); | | (IBusEngine *engine); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_hide_auxiliary_text: | |
| | | * @engine: An IBusEngine. | |
| | | * | |
| | | * Hide the auxiliary bar. | |
| | | */ | |
| void ibus_engine_hide_auxiliary_text | | void ibus_engine_hide_auxiliary_text | |
| (IBusEngine *engine); | | (IBusEngine *engine); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_update_lookup_table: | |
| | | * @engine: An IBusEngine. | |
| | | * @lookup_table: An lookup_table. | |
| | | * @visible: Whether the lookup_table is visible. | |
| | | * | |
| | | * Update the lookup table. | |
| | | */ | |
| void ibus_engine_update_lookup_table | | void ibus_engine_update_lookup_table | |
| (IBusEngine *engine, | | (IBusEngine *engine, | |
| IBusLookupTable *lookup_table, | | IBusLookupTable *lookup_table, | |
| gboolean visible); | | gboolean visible); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_update_lookup_table_fast: | |
| | | * @engine: An IBusEngine. | |
| | | * @lookup_table: An lookup_table. | |
| | | * @visible: 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(). | |
| | | * | |
| | | */ | |
| void ibus_engine_update_lookup_table_fast | | void ibus_engine_update_lookup_table_fast | |
| (IBusEngine *engine, | | (IBusEngine *engine, | |
| IBusLookupTable *lookup_table, | | IBusLookupTable *lookup_table, | |
| gboolean visible); | | gboolean visible); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_show_lookup_table: | |
| | | * @engine: An IBusEngine. | |
| | | * | |
| | | * Show the lookup table. | |
| | | */ | |
| void ibus_engine_show_lookup_table | | void ibus_engine_show_lookup_table | |
| (IBusEngine *engine); | | (IBusEngine *engine); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_hide_lookup_table: | |
| | | * @engine: An IBusEngine. | |
| | | * | |
| | | * Hide the lookup table. | |
| | | */ | |
| void ibus_engine_hide_lookup_table | | void ibus_engine_hide_lookup_table | |
| (IBusEngine *engine); | | (IBusEngine *engine); | |
| | | | |
|
| | | /** | |
| | | * ibus_engine_forward_key_event: | |
| | | * @engine: An IBusEngine. | |
| | | * @keyval: KeySym. | |
| | | * @state: Key modifier flags. | |
| | | * | |
| | | * Forward the key event. | |
| | | */ | |
| void ibus_engine_forward_key_event | | void ibus_engine_forward_key_event | |
| (IBusEngine *engine, | | (IBusEngine *engine, | |
| guint keyval, | | guint keyval, | |
| guint state); | | guint state); | |
| | | | |
|
| | | /** | |
| | | * ibus_engine_register_properties: | |
| | | * @engine: An IBusEngine. | |
| | | * @prop_list: Property List. | |
| | | * | |
| | | * Register and show properties in language bar. | |
| | | */ | |
| void ibus_engine_register_properties | | void ibus_engine_register_properties | |
| (IBusEngine *engine, | | (IBusEngine *engine, | |
| IBusPropList *prop_list); | | IBusPropList *prop_list); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_update_property: | |
| | | * @engine: An IBusEngine. | |
| | | * @prop: IBusProperty to be updated. | |
| | | * | |
| | | * Update the state displayed in language bar. | |
| | | */ | |
| void ibus_engine_update_property(IBusEngine *engine, | | void ibus_engine_update_property(IBusEngine *engine, | |
| IBusProperty *prop); | | IBusProperty *prop); | |
|
| | | | |
| | | /** | |
| | | * ibus_engine_get_name: | |
| | | * @engine: An IBusEngine. | |
| | | * @returns: Name of IBusEngine. | |
| | | * | |
| | | * Return the name of IBusEngine. | |
| | | */ | |
| const gchar *ibus_engine_get_name (IBusEngine *engine); | | const gchar *ibus_engine_get_name (IBusEngine *engine); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 19 change blocks. |
| 3 lines changed or deleted | | 154 lines changed or added | |
|
| ibusfactory.h | | ibusfactory.h | |
| | | | |
| skipping to change at line 20 | | skipping to change at line 20 | |
| * This library is distributed in the hope that it will be useful, | | * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
|
| | | /** | |
| | | * SECTION: ibusfactory | |
| | | * @short_description: Factory for creating engine instances. | |
| | | * @stability: Stable | |
| | | * @see_also: #IBusEngine | |
| | | * | |
| | | * 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. | |
| | | */ | |
| #ifndef __IBUS_FACTORY_H_ | | #ifndef __IBUS_FACTORY_H_ | |
| #define __IBUS_FACTORY_H_ | | #define __IBUS_FACTORY_H_ | |
| | | | |
| #include <dbus/dbus.h> | | #include <dbus/dbus.h> | |
| #include "ibusservice.h" | | #include "ibusservice.h" | |
| #include "ibusserializable.h" | | #include "ibusserializable.h" | |
| | | | |
| /* | | /* | |
| * Type macros. | | * Type macros. | |
| */ | | */ | |
| | | | |
| skipping to change at line 65 | | skipping to change at line 75 | |
| #define IBUS_FACTORY_INFO_GET_CLASS(obj) \ | | #define IBUS_FACTORY_INFO_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_FACTORY_INFO, IBusFactoryI
nfoClass)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_FACTORY_INFO, IBusFactoryI
nfoClass)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusFactory IBusFactory; | | typedef struct _IBusFactory IBusFactory; | |
| typedef struct _IBusFactoryClass IBusFactoryClass; | | typedef struct _IBusFactoryClass IBusFactoryClass; | |
| typedef struct _IBusFactoryInfo IBusFactoryInfo; | | typedef struct _IBusFactoryInfo IBusFactoryInfo; | |
| typedef struct _IBusFactoryInfoClass IBusFactoryInfoClass; | | typedef struct _IBusFactoryInfoClass IBusFactoryInfoClass; | |
| | | | |
|
| | | /** | |
| | | * IBusFactory: | |
| | | * | |
| | | * An opaque data type representing an IBusFactory. | |
| | | */ | |
| struct _IBusFactory { | | struct _IBusFactory { | |
| IBusService parent; | | IBusService parent; | |
| | | | |
| /* instance members */ | | /* instance members */ | |
| }; | | }; | |
| | | | |
| struct _IBusFactoryClass { | | struct _IBusFactoryClass { | |
| IBusServiceClass parent; | | IBusServiceClass parent; | |
| | | | |
| /* signals */ | | /* signals */ | |
| | | | |
| /*< private >*/ | | /*< private >*/ | |
| /* padding */ | | /* padding */ | |
| gpointer pdummy[8]; | | gpointer pdummy[8]; | |
| }; | | }; | |
| | | | |
|
| | | /** | |
| | | * IBusFactoryInfo: | |
| | | * @path: D-Bus path for the IME. | |
| | | * @name: D-Bus name for the IME. | |
| | | * @lang: Supporting language of the IME. | |
| | | * @icon: Icon file of the IME. | |
| | | * @authors: Authors of the IME. | |
| | | * @credits: Credits of the IME. | |
| | | * | |
| | | * An IBusFactoryInfo stores information about an IME. | |
| | | * So CreateEngine method can create instances of that IME. | |
| | | */ | |
| struct _IBusFactoryInfo { | | struct _IBusFactoryInfo { | |
| IBusSerializable parent; | | IBusSerializable parent; | |
| | | | |
| /* instance members */ | | /* instance members */ | |
|
| | | /*< public >*/ | |
| gchar *path; | | gchar *path; | |
| gchar *name; | | gchar *name; | |
| gchar *lang; | | gchar *lang; | |
| gchar *icon; | | gchar *icon; | |
| gchar *authors; | | gchar *authors; | |
| gchar *credits; | | gchar *credits; | |
| }; | | }; | |
| | | | |
| struct _IBusFactoryInfoClass { | | struct _IBusFactoryInfoClass { | |
| IBusSerializableClass parent; | | IBusSerializableClass parent; | |
| | | | |
| /* signals */ | | /* signals */ | |
| | | | |
| /*< private >*/ | | /*< private >*/ | |
| /* padding */ | | /* padding */ | |
| gpointer pdummy[8]; | | gpointer pdummy[8]; | |
| }; | | }; | |
| | | | |
| GType ibus_factory_get_type (void); | | GType ibus_factory_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_factory_new: | |
| | | * @connection: An IBusConnection. | |
| | | * @returns: A newly allocated IBusFactory. | |
| | | * | |
| | | * New an IBusFactory. | |
| | | */ | |
| IBusFactory *ibus_factory_new (IBusConnection *connection
); | | IBusFactory *ibus_factory_new (IBusConnection *connection
); | |
|
| | | | |
| | | /** | |
| | | * ibus_factory_add_engine: | |
| | | * @connection: An IBusConnection. | |
| | | * @engine_name: Name of an engine. | |
| | | * @engine_type: GType of an engine. | |
| | | * | |
| | | * Add an engine to the factory. | |
| | | */ | |
| void ibus_factory_add_engine (IBusFactory *factory, | | void ibus_factory_add_engine (IBusFactory *factory, | |
| const gchar *engine_nam
e, | | const gchar *engine_nam
e, | |
| GType engine_typ
e); | | GType engine_typ
e); | |
|
| | | | |
| | | /** | |
| | | * ibus_factory_get_info: | |
| | | * @factory: An IBusFactory | |
| | | * @returns: A corresponding IbusFactoryInfo. | |
| | | * | |
| | | * Get IBusFactoryInfo out of IBusFactory. | |
| | | * | |
| | | * <note><para>This function is currently commented out</para></note> | |
| | | */ | |
| IBusFactoryInfo *ibus_factory_get_info (IBusFactory *factory); | | IBusFactoryInfo *ibus_factory_get_info (IBusFactory *factory); | |
| GType ibus_factory_info_get_type (void); | | GType ibus_factory_info_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_factory_info_new: | |
| | | * @path: D-Bus path for the IME. | |
| | | * @name: IME name. | |
| | | * @lang: Supporting language of the IME. | |
| | | * @icon: Icon file of the IME. | |
| | | * @authors: Authors of the IME. | |
| | | * @credits: Credits of the IME. | |
| | | * @returns: A newly allocated IBusFactoryInfo. | |
| | | * | |
| | | * New an IBusFactoryInfo. | |
| | | */ | |
| IBusFactoryInfo *ibus_factory_info_new (const gchar *path, | | IBusFactoryInfo *ibus_factory_info_new (const gchar *path, | |
| const gchar *name, | | const gchar *name, | |
| const gchar *lang, | | const gchar *lang, | |
| const gchar *icon, | | const gchar *icon, | |
| const gchar *authors, | | const gchar *authors, | |
| const gchar *credits); | | const gchar *credits); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 8 change blocks. |
| 0 lines changed or deleted | | 70 lines changed or added | |
|
| ibuslookuptable.h | | ibuslookuptable.h | |
| | | | |
| skipping to change at line 20 | | skipping to change at line 20 | |
| * This library is distributed in the hope that it will be useful, | | * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | | * Lesser General Public License for more details. | |
| * | | * | |
| * You should have received a copy of the GNU Lesser General Public | | * You should have received a copy of the GNU Lesser General Public | |
| * License along with this library; if not, write to the | | * License along with this library; if not, write to the | |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| * Boston, MA 02111-1307, USA. | | * Boston, MA 02111-1307, USA. | |
| */ | | */ | |
|
| | | /** | |
| | | * SECTION: ibuslookuptable | |
| | | * @short_description: Candidate word/phrase lookup table. | |
| | | * @stability: Stable | |
| | | * @see_also: #IBusEngine | |
| | | * | |
| | | * An IBusLookuptable stores the candidate words or phrases for users to ch | |
| | | oose 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. | |
| | | */ | |
| #ifndef __IBUS_LOOKUP_TABLE_H_ | | #ifndef __IBUS_LOOKUP_TABLE_H_ | |
| #define __IBUS_LOOKUP_TABLE_H_ | | #define __IBUS_LOOKUP_TABLE_H_ | |
| | | | |
| #include "ibusserializable.h" | | #include "ibusserializable.h" | |
| #include "ibustext.h" | | #include "ibustext.h" | |
| | | | |
| /* | | /* | |
| * Type macros. | | * Type macros. | |
| */ | | */ | |
| /* define IBusLookupTable macros */ | | /* define IBusLookupTable macros */ | |
| | | | |
| skipping to change at line 48 | | skipping to change at line 60 | |
| #define IBUS_IS_LOOKUP_TABLE_CLASS(klass) \ | | #define IBUS_IS_LOOKUP_TABLE_CLASS(klass) \ | |
| (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_LOOKUP_TABLE)) | | (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_LOOKUP_TABLE)) | |
| #define IBUS_LOOKUP_TABLE_GET_CLASS(obj) \ | | #define IBUS_LOOKUP_TABLE_GET_CLASS(obj) \ | |
| (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_LOOKUP_TABLE, IBusLookupTa
bleClass)) | | (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_LOOKUP_TABLE, IBusLookupTa
bleClass)) | |
| | | | |
| G_BEGIN_DECLS | | G_BEGIN_DECLS | |
| | | | |
| typedef struct _IBusLookupTable IBusLookupTable; | | typedef struct _IBusLookupTable IBusLookupTable; | |
| typedef struct _IBusLookupTableClass IBusLookupTableClass; | | typedef struct _IBusLookupTableClass IBusLookupTableClass; | |
| | | | |
|
| | | /** | |
| | | * IBusLookupTable: | |
| | | * @page_size: number of candidate shown per page. | |
| | | * @cursor_pos: position index of cursor. | |
| | | * @cursor_visible: whether the cursor is visible. | |
| | | * @round: TRUE for lookup table wrap around. | |
| | | * @candidates: Candidate words/phrases/ | |
| | | * | |
| | | * An IBusLookuptable stores the candidate words or phrases for users to ch | |
| | | oose from. | |
| | | */ | |
| struct _IBusLookupTable { | | struct _IBusLookupTable { | |
| IBusSerializable parent; | | IBusSerializable parent; | |
| | | | |
|
| | | /*< public >*/ | |
| guint page_size; | | guint page_size; | |
| guint cursor_pos; | | guint cursor_pos; | |
| gboolean cursor_visible; | | gboolean cursor_visible; | |
| gboolean round; | | gboolean round; | |
| | | | |
| GArray *candidates; | | GArray *candidates; | |
| }; | | }; | |
| | | | |
| struct _IBusLookupTableClass { | | struct _IBusLookupTableClass { | |
| IBusSerializableClass parent; | | IBusSerializableClass parent; | |
| }; | | }; | |
| | | | |
| GType ibus_lookup_table_get_type (void); | | GType ibus_lookup_table_get_type (void); | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_new: | |
| | | * @page_size: number of candidate shown per page. | |
| | | * @cursor_pos: position index of cursor. | |
| | | * @cursor_visible: whether the cursor is visible. | |
| | | * @round: TRUE for lookup table wrap around. | |
| | | * @returns: A newly allocated IBusLookupTable. | |
| | | * | |
| | | * New a IBusLookupTable. | |
| | | */ | |
| IBusLookupTable *ibus_lookup_table_new (guint page_s
ize, | | IBusLookupTable *ibus_lookup_table_new (guint page_s
ize, | |
| guint cursor
_pos, | | guint cursor
_pos, | |
| gboolean cursor
_visible, | | gboolean cursor
_visible, | |
| gboolean round)
; | | gboolean round)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_append_candidate: | |
| | | * @table: An IBusLookupTable. | |
| | | * @text: candidate word/phrase to be appended (in IBusText format). | |
| | | * | |
| | | * Append a candidate word/phrase to IBusLookupTable. | |
| | | */ | |
| void ibus_lookup_table_append_candidate | | void ibus_lookup_table_append_candidate | |
| (IBusLookupTable *table, | | (IBusLookupTable *table, | |
| IBusText *text); | | IBusText *text); | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_get_candidate: | |
| | | * @table: An IBusLookupTable. | |
| | | * @index: Index in the Lookup table. | |
| | | * @returns: IBusText at the given index; NULL if no such IBusText. | |
| | | * | |
| | | * Return IBusText at the given index. | |
| | | */ | |
| IBusText *ibus_lookup_table_get_candidate | | IBusText *ibus_lookup_table_get_candidate | |
| (IBusLookupTable *table, | | (IBusLookupTable *table, | |
| guint index)
; | | guint index)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_set_cursor_pos: | |
| | | * @table: An IBusLookupTable. | |
| | | * @cursor_pos: The position of cursor. | |
| | | * | |
| | | * Set the cursor position of IBusLookupTable. | |
| | | */ | |
| void ibus_lookup_table_set_cursor_pos | | void ibus_lookup_table_set_cursor_pos | |
| (IBusLookupTable *table, | | (IBusLookupTable *table, | |
| guint cursor
_pos); | | guint cursor
_pos); | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_get_cursor_pos: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: The position of cursor. | |
| | | * | |
| | | * Get the cursor position of IBusLookupTable. | |
| | | */ | |
| guint ibus_lookup_table_get_cursor_pos | | guint ibus_lookup_table_get_cursor_pos | |
| (IBusLookupTable *table)
; | | (IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_set_cursor_visible: | |
| | | * @table: An IBusLookupTable. | |
| | | * @visible: Whether to make the cursor of @table visible. | |
| | | * | |
| | | * Set whether to make the cursor of an IBusLookupTable visible or not. | |
| | | */ | |
| void ibus_lookup_table_set_cursor_visible | | void ibus_lookup_table_set_cursor_visible | |
| (IBusLookupTable *table, | | (IBusLookupTable *table, | |
| gboolean visibl
e); | | gboolean visibl
e); | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_is_cursor_visible: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: Whether the cursor of @table is visible. | |
| | | * | |
| | | * Returns whether the cursor of an IBusLookupTable is visible. | |
| | | */ | |
| gboolean ibus_lookup_table_is_cursor_visible | | gboolean ibus_lookup_table_is_cursor_visible | |
| (IBusLookupTable *table)
; | | (IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_get_cursor_in_page: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: The position of cursor in current page. | |
| | | * | |
| | | * Get the cursor position in current page of IBusLookupTable. | |
| | | */ | |
| guint ibus_lookup_table_get_cursor_in_page | | guint ibus_lookup_table_get_cursor_in_page | |
| (IBusLookupTable *table)
; | | (IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_set_page_size: | |
| | | * @table: An IBusLookupTable. | |
| | | * @page_size: number of candidate shown per page. | |
| | | * | |
| | | * Set the number of candidate shown per page. | |
| | | */ | |
| void ibus_lookup_table_set_page_size | | void ibus_lookup_table_set_page_size | |
| (IBusLookupTable *table, | | (IBusLookupTable *table, | |
| guint page_s
ize); | | guint page_s
ize); | |
|
| | | /** | |
| | | * ibus_lookup_table_get_page_size: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: Page size, i.e., number of candidate shown per page. | |
| | | * | |
| | | * Get the number of candidate shown per page. | |
| | | */ | |
| guint ibus_lookup_table_get_page_size | | guint ibus_lookup_table_get_page_size | |
| (IBusLookupTable *table)
; | | (IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_clear: | |
| | | * @table: An IBusLookupTable. | |
| | | * | |
| | | * Clear and remove all candidate from an IBusLookupTable. | |
| | | */ | |
| void ibus_lookup_table_clear (IBusLookupTable *table)
; | | void ibus_lookup_table_clear (IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_page_up: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: TRUE if succeed. | |
| | | * | |
| | | * 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. | |
| | | */ | |
| gboolean ibus_lookup_table_page_up (IBusLookupTable *table)
; | | gboolean ibus_lookup_table_page_up (IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_page_down: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: TRUE if succeed. | |
| | | * | |
| | | * 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. | |
| | | */ | |
| gboolean ibus_lookup_table_page_down(IBusLookupTable *table)
; | | gboolean ibus_lookup_table_page_down(IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_cursor_up: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: TRUE if succeed. | |
| | | * | |
| | | * 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. | |
| | | */ | |
| gboolean ibus_lookup_table_cursor_up(IBusLookupTable *table)
; | | gboolean ibus_lookup_table_cursor_up(IBusLookupTable *table)
; | |
|
| | | | |
| | | /** | |
| | | * ibus_lookup_table_cursor_down: | |
| | | * @table: An IBusLookupTable. | |
| | | * @returns: TRUE if succeed. | |
| | | * | |
| | | * 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. | |
| | | */ | |
| gboolean ibus_lookup_table_cursor_down | | gboolean ibus_lookup_table_cursor_down | |
| (IBusLookupTable *table)
; | | (IBusLookupTable *table)
; | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 18 change blocks. |
| 0 lines changed or deleted | | 163 lines changed or added | |
|