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
|
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* ibus - The Input Bus
* Copyright (c) 2009-2014 Google Inc. All rights reserved.
* Copyright (c) 2017-2018 Takao Fujiwara <takao.fujiwara1@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.1 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif
#ifndef __IBUS_PANEL_SERVICE_H_
#define __IBUS_PANEL_SERVICE_H_
/**
* SECTION: ibuspanelservice
* @short_description: Panel service back-end.
* @stability: Stable
*
* An IBusPanelService is a base class for UI services.
* Developers can "extend" this class for panel UI development.
*/
#include "ibuslookuptable.h"
#include "ibusservice.h"
#include "ibusproplist.h"
#include "ibusxevent.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_PANEL_SERVICE \
(ibus_panel_service_get_type ())
#define IBUS_PANEL_SERVICE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_PANEL_SERVICE, IBusPanelService))
#define IBUS_PANEL_SERVICE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_PANEL_SERVICE, IBusPanelServiceClass))
#define IBUS_IS_PANEL_SERVICE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_PANEL_SERVICE))
#define IBUS_IS_PANEL_SERVICE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_PANEL_SERVICE))
#define IBUS_PANEL_SERVICE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_PANEL_SERVICE, IBusPanelServiceClass))
G_BEGIN_DECLS
typedef struct _IBusPanelService IBusPanelService;
typedef struct _IBusPanelServiceClass IBusPanelServiceClass;
/**
* IBusPanelService:
*
* An opaque data type representing an IBusPanelService.
*/
struct _IBusPanelService {
IBusService parent;
/* instance members */
};
struct _IBusPanelServiceClass {
IBusServiceClass parent;
/* class members */
void (* focus_in) (IBusPanelService *panel,
const gchar
*input_context_path);
void (* focus_out) (IBusPanelService *panel,
const gchar
*input_context_path);
void (* register_properties) (IBusPanelService *panel,
IBusPropList *prop_list);
void (* set_cursor_location) (IBusPanelService *panel,
gint x,
gint y,
gint w,
gint h);
void (* update_auxiliary_text) (IBusPanelService *panel,
IBusText *text,
gboolean visible);
void (* update_lookup_table) (IBusPanelService *panel,
IBusLookupTable *lookup_table,
gboolean visible);
void (* update_preedit_text) (IBusPanelService *panel,
IBusText *text,
guint cursor_pos,
gboolean visible);
void (* update_property) (IBusPanelService *panel,
IBusProperty *prop);
void (* cursor_down_lookup_table) (IBusPanelService *panel);
void (* cursor_up_lookup_table) (IBusPanelService *panel);
void (* hide_auxiliary_text) (IBusPanelService *panel);
void (* hide_language_bar) (IBusPanelService *panel);
void (* hide_lookup_table) (IBusPanelService *panel);
void (* hide_preedit_text) (IBusPanelService *panel);
void (* page_down_lookup_table) (IBusPanelService *panel);
void (* page_up_lookup_table) (IBusPanelService *panel);
void (* reset) (IBusPanelService *panel);
void (* show_auxiliary_text) (IBusPanelService *panel);
void (* show_language_bar) (IBusPanelService *panel);
void (* show_lookup_table) (IBusPanelService *panel);
void (* show_preedit_text) (IBusPanelService *panel);
void (* start_setup) (IBusPanelService *panel);
void (* state_changed) (IBusPanelService *panel);
void (* destroy_context) (IBusPanelService *panel,
const gchar
*input_context_path);
void (* set_content_type) (IBusPanelService *panel,
guint purpose,
guint hints);
void (* set_cursor_location_relative)
(IBusPanelService *panel,
gint x,
gint y,
gint w,
gint h);
void (* panel_extension_received)
(IBusPanelService *panel,
IBusExtensionEvent *event);
gboolean (* process_key_event)
(IBusPanelService *panel,
guint keyval,
guint keycode,
guint state);
void (* commit_text_received)
(IBusPanelService *panel,
IBusText *text);
void (* candidate_clicked_lookup_table)
(IBusPanelService *panel,
guint index,
guint button,
guint state);
/*< private >*/
/* padding */
gpointer pdummy[2]; // We can add 8 pointers without breaking the ABI.
};
GType ibus_panel_service_get_type (void);
/**
* ibus_panel_service_new:
* @connection: An GDBusConnection.
*
* Creates a new #IBusPanelService from an #GDBusConnection.
*
* Returns: A newly allocated #IBusPanelService.
*/
IBusPanelService *ibus_panel_service_new (GDBusConnection *connection);
/**
* ibus_panel_service_candidate_clicked:
* @panel: An IBusPanelService
* @index: Index in the Lookup table
* @button: GdkEventButton::button (1: left button, etc.)
* @state: GdkEventButton::state (key modifier flags)
*
* Notify that a candidate is clicked
* by sending a "CandidateClicked" to IBus service.
*/
void ibus_panel_service_candidate_clicked (IBusPanelService *panel,
guint index,
guint button,
guint state);
/**
* ibus_panel_service_cursor_down:
* @panel: An IBusPanelService
*
* Notify that the cursor is down
* by sending a "CursorDown" to IBus service.
*/
void ibus_panel_service_cursor_down (IBusPanelService *panel);
/**
* ibus_panel_service_cursor_up:
* @panel: An IBusPanelService
*
* Notify that the cursor is up
* by sending a "CursorUp" to IBus service.
*/
void ibus_panel_service_cursor_up (IBusPanelService *panel);
/**
* ibus_panel_service_page_down:
* @panel: An IBusPanelService
*
* Notify that the page is down
* by sending a "PageDown" to IBus service.
*/
void ibus_panel_service_page_down (IBusPanelService *panel);
/**
* ibus_panel_service_page_up:
* @panel: An IBusPanelService
*
* Notify that the page is up
* by sending a "PageUp" to IBus service.
*/
void ibus_panel_service_page_up (IBusPanelService *panel);
/**
* ibus_panel_service_property_activate:
* @panel: An IBusPanelService
* @prop_name: A property name
* @prop_state: State of the property
*
* Notify that a property is active
* by sending a "PropertyActivate" message to IBus service.
*/
void ibus_panel_service_property_activate (IBusPanelService *panel,
const gchar *prop_name,
guint prop_state);
/**
* ibus_panel_service_property_show:
* @panel: An IBusPanelService
* @prop_name: A property name
*
* Notify that a property is shown
* by sending a "ValueChanged" message to IBus service.
*/
void ibus_panel_service_property_show (IBusPanelService *panel,
const gchar *prop_name);
/**
* ibus_panel_service_property_hide:
* @panel: An IBusPanelService
* @prop_name: A property name
*
* Notify that a property is hidden
* by sending a "ValueChanged" message to IBus service.
*/
void ibus_panel_service_property_hide (IBusPanelService *panel,
const gchar *prop_name);
/**
* ibus_panel_service_commit_text:
* @panel: An #IBusPanelService
* @text: An #IBusText
*
* Notify that a text is sent
* by sending a "CommitText" message to IBus service.
*/
void ibus_panel_service_commit_text (IBusPanelService *panel,
IBusText *text);
/**
* ibus_panel_service_panel_extension:
* @panel: An #IBusPanelService
* @event: (transfer full): A #PanelExtensionEvent which is sent to a
* panel extension.
*
* Enable or disable a panel extension with #IBusExtensionEvent.
* Notify that a data is sent
* by sending a "PanelExtension" message to IBus panel extension service.
*/
void ibus_panel_service_panel_extension (IBusPanelService *panel,
IBusExtensionEvent *event);
/**
* ibus_panel_service_panel_extension_register_keys:
* @panel: An #IBusPanelService
* @first_property_name: the first name of the shortcut keys. This is %NULL
" terminated.
*
* Register shortcut keys to enable panel extensions with #IBusExtensionEvent.
* Notify that a data is sent
* by sending a "PanelExtensionRegisterKeys" message to IBus panel extension
* service. Seems Vala does not support uint[][3] and use
* IBusProcessKeyEventData[]. E.g.
* IBusProcessKeyEventData[] keys = {{
* IBUS_KEY_e, 0, IBUS_SHIFT_MASK | IBUS_SUPER_MASK }};
* ibus_panel_service_panel_extension_register_keys(panel, "emoji", keys, NULL);
*/
void ibus_panel_service_panel_extension_register_keys
(IBusPanelService *panel,
const gchar *first_property_name,
...);
/**
* ibus_panel_service_update_preedit_text_received:
* @panel: An #IBusPanelService
* @text: Update content.
* @cursor_pos: Current position of cursor
* @visible: Whether the pre-edit buffer is visible.
*
* Notify that the preedit is updated by the panel extension
*
* (Note: The table object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_panel_service_update_preedit_text_received
(IBusPanelService *panel,
IBusText *text,
guint cursor_pos,
gboolean visible);
/**
* ibus_panel_service_show_preedit_text_received:
* @panel: An IBusPanelService
*
* Notify that the preedit is shown by the panel extension
*/
void ibus_panel_service_show_preedit_text_received
(IBusPanelService *panel);
/**
* ibus_panel_service_hide_preedit_text_received:
* @panel: An IBusPanelService
*
* Notify that the preedit is hidden by the panel extension
*/
void ibus_panel_service_hide_preedit_text_received
(IBusPanelService *panel);
/**
* ibus_panel_service_update_auxiliary_text_received:
* @panel: An #IBusPanelService
* @text: An #IBusText
* @visible: Whether the auxilirary text is visible.
*
* Notify that the auxilirary is updated by the panel extension.
*
* (Note: The table object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_panel_service_update_auxiliary_text_received
(IBusPanelService *panel,
IBusText *text,
gboolean visible);
/**
* ibus_panel_service_update_lookup_table_received:
* @panel: An #IBusPanelService
* @table: An #IBusLookupTable
* @visible: Whether the lookup table is visible.
*
* Notify that the lookup table is updated by the panel extension.
*
* (Note: The table object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_panel_service_update_lookup_table_received
(IBusPanelService *panel,
IBusLookupTable *table,
gboolean visible);
G_END_DECLS
#endif
|
