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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
/* 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: ibusproperty
* @short_description: UI component for input method engine property.
* @stability: Stable
* @see_also: #IBusEngine
*
* An IBusProperty is an UI component like a button or a menu item
* which shows the status of corresponding input method engine property.
* End user can operate and see the current status of IME through these components.
* For example, ibus-chewing users change the English/Chinese input mode by
* pressing ctrl-space or click on the Eng/Chi switch button.
* And the IBusProperty shows the change correspondingly.
*/
#ifndef __IBUS_PROPERTY_H_
#define __IBUS_PROPERTY_H_
#include "ibusserializable.h"
#include "ibustext.h"
G_BEGIN_DECLS
/*
* Type macros.
*/
/* define IBusProperty macros */
#define IBUS_TYPE_PROPERTY \
(ibus_property_get_type ())
#define IBUS_PROPERTY(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_PROPERTY, IBusProperty))
#define IBUS_PROPERTY_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_PROPERTY, IBusPropertyClass))
#define IBUS_IS_PROPERTY(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_PROPERTY))
#define IBUS_IS_PROPERTY_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_PROPERTY))
#define IBUS_PROPERTY_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_PROPERTY, IBusPropertyClass))
/* define IBusPropList macros */
/**
* IBUS_TYPE_PROP_LIST:
* @returns: IBusPropList GType.
*
* Returns GType of IBus property list.
*/
#define IBUS_TYPE_PROP_LIST \
(ibus_prop_list_get_type ())
/**
* IBUS_PROP_LIST:
* @obj: An object which is subject to casting.
*
* Casts an IBUS_PROP_LIST or derived pointer into a (IBusPropList*) pointer.
* Depending on the current debugging level, this function may invoke
* certain runtime checks to identify invalid casts.
*/
#define IBUS_PROP_LIST(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_PROP_LIST, IBusPropList))
/**
* IBUS_PROP_LIST_CLASS:
* @klass: A class to be casted.
*
* Casts a derived IBusPropListClass structure into a IBusPropListClass structure.
*/
#define IBUS_PROP_LIST_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_PROP_LIST, IBusPropListClass))
/**
* IBUS_IS_PROP_LIST:
* @obj: Instance to check for being a IBUS_PROP_LIST.
*
* Checks whether a valid GTypeInstance pointer is of type IBUS_PROP_LIST.
*/
#define IBUS_IS_PROP_LIST(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_PROP_LIST))
/**
* IBUS_IS_PROP_LIST_CLASS:
* @klass: A class to be checked.
*
* Checks whether class "is a" valid IBusPropListClass structure of type IBUS_PROP_LIST or derived.
*/
#define IBUS_IS_PROP_LIST_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_PROP_LIST))
/**
* IBUS_PROP_LIST_GET_CLASS:
* @obj: An object.
*
* Get the class of a given object and cast the class to IBusPropListClass.
*/
#define IBUS_PROP_LIST_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_PROP_LIST, IBusPropListClass))
/**
* IBusPropType:
* @PROP_TYPE_NORMAL: Property is shown as normal text.
* @PROP_TYPE_TOGGLE: Property is shown as a toggle button.
* @PROP_TYPE_RADIO: Property is shown as a radio selection option.
* @PROP_TYPE_MENU: Property is shown as a menu, usually imply it has sub menu
* items.
* @PROP_TYPE_SEPARATOR: A separator for menu.
*
* Type enumeration of IBusProperty.
*/
typedef enum {
PROP_TYPE_NORMAL = 0,
PROP_TYPE_TOGGLE = 1,
PROP_TYPE_RADIO = 2,
PROP_TYPE_MENU = 3,
PROP_TYPE_SEPARATOR = 4,
} IBusPropType;
/**
* IBusPropState:
* @PROP_STATE_UNCHECKED: Property option is unchecked.
* @PROP_STATE_CHECKED: Property option is checked.
* @PROP_STATE_INCONSISTENT: The state is inconsistent with the associated IME
* property.
*
* State of IBusProperty. The actual effect depends on #IBusPropType of the
* IBusProperty.
*
* <variablelist>
* <varlistentry>
* <term>PROP_TYPE_TOGGLE</term>
* <listitem><para>Emphasized if PROP_STATE_CHECKED, normal otherwise.</para></listitem>
* </varlistentry>
* <varlistentry>
* <term>PROP_TYPE_RADIO</term>
* <listitem><para>Option checked if PROP_STATE_CHECKED, unchecked otherwise.</para></listitem>
* </varlistentry>
* </variablelist>
* No effect on other types.
*/
typedef enum {
PROP_STATE_UNCHECKED = 0,
PROP_STATE_CHECKED = 1,
PROP_STATE_INCONSISTENT = 2,
} IBusPropState;
typedef struct _IBusProperty IBusProperty;
typedef struct _IBusPropertyClass IBusPropertyClass;
typedef struct _IBusPropList IBusPropList;
typedef struct _IBusPropListClass IBusPropListClass;
/**
* IBusProperty:
* @key: Unique Identity for the IBusProperty.
* @icon: Icon file for the IBusProperty.
* @label: Text shown in UI.
* @tooltip: Message shown if mouse hovered the IBusProperty.
* @sensitive: Whether the IBusProperty is sensitive to keyboard and mouse event.
* @visible: Whether the IBusProperty is visible.
* @type: IBusPropType of IBusProperty.
* @state: IBusPropState of IBusProperty.
* @sub_props: IBusPropList that contains sub IBusProperties. These IBusProperties are usually
* shown as sub menu item.
*
* UI component for input method engine property.
*/
struct _IBusProperty {
IBusSerializable parent;
/*< public >*/
gchar *key;
gchar *icon;
IBusText *label;
IBusText *tooltip;
gboolean sensitive;
gboolean visible;
guint type;
guint state;
IBusPropList *sub_props;
};
struct _IBusPropertyClass {
IBusSerializableClass parent;
};
/**
* IBusPropList:
* @properties: GArray that holds IBusProperties.
*
* An array of IBusProperties.
*/
struct _IBusPropList {
IBusSerializable parent;
/*< public >*/
GArray *properties;
};
struct _IBusPropListClass {
IBusSerializableClass parent;
};
GType ibus_property_get_type ();
/**
* ibus_property_new:
* @key: Unique Identity for the IBusProperty.
* @type: IBusPropType of IBusProperty.
* @label: Text shown in UI.
* @icon: Icon file for the IBusProperty.
* @tooltip: Message shown if mouse hovered the IBusProperty.
* @sensitive: Whether the IBusProperty is sensitive to keyboard and mouse event.
* @visible: Whether the IBusProperty is visible.
* @state: IBusPropState of IBusProperty.
* @prop_list: IBusPropList that contains sub IBusProperties.
* @returns: A newly allocated IBusProperty.
*
* New a IBusProperty.
*/
IBusProperty *ibus_property_new (const gchar *key,
IBusPropType type,
IBusText *label,
const gchar *icon,
IBusText *tooltip,
gboolean sensitive,
gboolean visible,
IBusPropState state,
IBusPropList *prop_list);
/**
* ibus_property_set_label:
* @prop: An IBusProperty.
* @label: Text shown in UI.
*
* Set the label of IBusProperty.
*/
void ibus_property_set_label (IBusProperty *prop,
IBusText *label);
/**
* ibus_property_set_icon:
* @prop: An IBusProperty.
* @icon: Icon shown in UI. It could be a full path of an icon file or an icon name.
*
* Set the icon of IBusProperty.
*/
void ibus_property_set_icon (IBusProperty *prop,
const gchar *icon);
/**
* ibus_property_set_tooltip:
* @prop: An IBusProperty.
* @tooltip: Text of the tooltip.
*
* Set the tooltip of IBusProperty.
*/
void ibus_property_set_tooltip (IBusProperty *prop,
IBusText *tooltip);
/**
* ibus_property_set_sensitive:
* @prop: An IBusProperty.
* @sensitive: Whether the IBusProperty is sensitive.
*
* Set whether the IBusProperty is sensitive.
*/
void ibus_property_set_sensitive(IBusProperty *prop,
gboolean sensitive);
/**
* ibus_property_set_visible:
* @prop: An IBusProperty.
* @visible: Whether the IBusProperty is visible.
*
* Set whether the IBusProperty is visible.
*/
void ibus_property_set_visible (IBusProperty *prop,
gboolean visible);
/**
* ibus_property_set_state:
* @prop: An IBusProperty.
* @state: The state of the IBusProperty.
*
* Set the state of the IBusProperty.
*/
void ibus_property_set_state (IBusProperty *prop,
IBusPropState state);
/**
* ibus_property_set_sub_props:
* @prop: An IBusProperty.
* @prop_list: IBusPropList that contains sub IBusProperties.
*
* Set the sub IBusProperties.
*/
void ibus_property_set_sub_props(IBusProperty *prop,
IBusPropList *prop_list);
/**
* ibus_property_update:
* @prop: An IBusProperty.
* @prop_update: IBusPropList that contains sub IBusProperties.
* @returns: TRUE for update suceeded; FALSE otherwise.
*
* Update the content of an IBusProperty.
* IBusProperty @prop_update can either be sub-property of @prop,
* or holds new values for @prop.
*/
gboolean ibus_property_update (IBusProperty *prop,
IBusProperty *prop_update);
GType ibus_prop_list_get_type ();
/**
* ibus_prop_list_new:
* @returns: A newly allocated IBusPropList.
*
* New a IBusPropList.
*/
IBusPropList *ibus_prop_list_new ();
/**
* ibus_prop_list_append:
* @prop_list: An IBusPropList.
* @prop: IBusProperty to be append to @prop_list.
*
* Append an IBusProperty to an IBusPropList, and increase reference.
*/
void ibus_prop_list_append (IBusPropList *prop_list,
IBusProperty *prop);
/**
* ibus_prop_list_get:
* @prop_list: An IBusPropList.
* @index: Index of an IBusPropList.
* @returns: IBusProperty at given index, NULL if no such IBusProperty.
*
* Returns IBusProperty at given index. Borrowed reference.
*/
IBusProperty *ibus_prop_list_get (IBusPropList *prop_list,
guint index);
/**
* ibus_prop_list_update_property:
* @prop_list: An IBusPropList.
* @prop: IBusProperty to be update.
* @returns: TRUE if succeeded, FALSE otherwise.
*
* Update an IBusProperty in IBusPropList.
*/
gboolean ibus_prop_list_update_property
(IBusPropList *prop_list,
IBusProperty *prop);
G_END_DECLS
#endif
|