1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/* vim:set et sts=4: */
/* ibus - The Input Bus
* Copyright (C) 2008-2009 Huang Peng <shawn.p.huang@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION: ibusbus
* @short_description: iBus-daemon communicating functions.
*
* iBus-bus handles the communication with iBus-daemon, including
* component registration, name request/release,
* and connection status checking.
*
* It also provides some function to invoke functions in iBus-daemon.
*/
#ifndef __IBUS_BUS_H_
#define __IBUS_BUS_H_
#include <dbus/dbus.h>
#include "ibusinputcontext.h"
#include "ibusconfig.h"
#include "ibuscomponent.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_BUS \
(ibus_bus_get_type ())
#define IBUS_BUS(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_BUS, IBusBus))
#define IBUS_BUS_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_BUS, IBusBusClass))
#define IBUS_IS_BUS(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_BUS))
#define IBUS_IS_BUS_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_BUS))
#define IBUS_BUS_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_BUS, IBusBusClass))
G_BEGIN_DECLS
/**
* IBusBus:
*
* Struct for containing iBus bus (daemon communication) status.
*/
typedef struct _IBusBus IBusBus;
typedef struct _IBusBusClass IBusBusClass;
struct _IBusBus {
IBusObject parent;
/* instance members */
};
struct _IBusBusClass {
IBusObjectClass parent;
/* class members */
};
GType ibus_bus_get_type (void);
/**
* ibus_bus_new:
* @returns: A newly allocated IBusBus instance.
*
* New an IBusBus instance.
*/
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);
/**
* ibus_bus_get_connection:
* @bus: An IBusBus.
* @returns: TRUE if @bus is connected, FALSE otherwise.
*
* Return IBusConnection of an IBusIBus instance.
*/
IBusConnection
*ibus_bus_get_connection (IBusBus *bus);
/* declare dbus methods */
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,
const gchar *name,
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,
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,
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);
/**
* ibus_bus_add_match:
* @bus: An IBusBus.
* @rule: Match rule.
*
* Add a match rule to an IBusBus.
*/
void ibus_bus_add_match (IBusBus *bus,
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,
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 *name);
/* declare ibus methods */
gboolean ibus_bus_exit (IBusBus *bus,
gboolean restart);
IBusInputContext
*ibus_bus_create_input_context
(IBusBus *bus,
const gchar *client_name);
gboolean ibus_bus_register_component(IBusBus *bus,
IBusComponent *component);
GList *ibus_bus_list_engines (IBusBus *bus);
GList *ibus_bus_list_active_engines
(IBusBus *bus);
/* declare config apis */
IBusConfig *ibus_bus_get_config (IBusBus *bus);
G_END_DECLS
#endif
|
