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
|
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* bus - The Input Bus
* Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
* Copyright (C) 2008-2010 Red Hat, Inc.
*
* 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
*/
#ifndef __BUS_INPUT_CONTEXT_H_
#define __BUS_INPUT_CONTEXT_H_
#include <ibus.h>
#include "connection.h"
#include "factoryproxy.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define BUS_TYPE_INPUT_CONTEXT \
(bus_input_context_get_type ())
#define BUS_INPUT_CONTEXT(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), BUS_TYPE_INPUT_CONTEXT, BusInputContext))
#define BUS_INPUT_CONTEXT_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), BUS_TYPE_INPUT_CONTEXT, BusInputContextClass))
#define BUS_IS_INPUT_CONTEXT(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), BUS_TYPE_INPUT_CONTEXT))
#define BUS_IS_INPUT_CONTEXT_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), BUS_TYPE_INPUT_CONTEXT))
#define BUS_INPUT_CONTEXT_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), BUS_TYPE_INPUT_CONTEXT, BusInputContextClass))
G_BEGIN_DECLS
typedef struct _BusInputContext BusInputContext;
typedef struct _BusInputContextClass BusInputContextClass;
GType bus_input_context_get_type (void);
BusInputContext *bus_input_context_new (BusConnection *connection,
const gchar *client);
/**
* bus_input_context_focus_in:
*
* Give a focus to the context. Call FocusIn, Enable, SetCapabilities, and SetCursorLocation methods of the engine for the context,
* and then emit glib signals to the context object. This function does nothing if the context already has a focus.
*/
void bus_input_context_focus_in (BusInputContext *context);
/**
* bus_input_context_focus_out:
*
* Remove a focus from the context. Call FocusOut method of the engine for the context.
* This function does nothing if the context does not have a focus.
*/
void bus_input_context_focus_out (BusInputContext *context);
/**
* bus_input_context_has_focus:
* @returns: context->has_focus.
*/
gboolean bus_input_context_has_focus (BusInputContext *context);
/**
* bus_input_context_enable:
*
* Enable the current engine for the context. Request an engine (if needed), call FocusIn, Enable, SetCapabilities, and SetCursorLocation methods
* of the engine for the context, and then emit glib and D-Bus "enabled" signals.
*/
void bus_input_context_enable (BusInputContext *context);
/**
* bus_input_context_disable:
*
* Disable the current engine for the context. Request an engine (if needed), call FocusIn, Enable, SetCapabilities, and SetCursorLocation methods
* of the engine for the context, and then emit glib and D-Bus "enabled" signals.
*/
void bus_input_context_disable (BusInputContext *context);
/**
* bus_input_context_page_up:
*
* Call page_up method of the current engine proxy.
*/
void bus_input_context_page_up (BusInputContext *context);
/**
* bus_input_context_page_down:
*
* Call page_down method of the current engine proxy.
*/
void bus_input_context_page_down (BusInputContext *context);
/**
* bus_input_context_cursor_up:
*
* Call cursor_up method of the current engine proxy.
*/
void bus_input_context_cursor_up (BusInputContext *context);
/**
* bus_input_context_cursor_down:
*
* Call cursor_down method of the current engine proxy.
*/
void bus_input_context_cursor_down (BusInputContext *context);
/**
* bus_input_context_candidate_clicked:
*
* Call candidate_clicked method of the current engine proxy.
*/
void bus_input_context_candidate_clicked(BusInputContext *context,
guint index,
guint button,
guint state);
/**
* bus_input_context_set_engine:
*
* Use the engine on the context.
*/
void bus_input_context_set_engine (BusInputContext *context,
BusEngineProxy *engine);
/**
* bus_input_context_set_engine_by_desc:
* @desc: the engine to use on the context.
* @timeout: timeout (in ms) for D-Bus calls.
* @callback: a function to be called when bus_input_context_set_engine_by_desc is finished. if NULL, the default callback
* function, which just calls bus_input_context_set_engine_by_desc_finish, is used.
*
* Create a new BusEngineProxy object and use it on the context.
*/
void bus_input_context_set_engine_by_desc
(BusInputContext *context,
IBusEngineDesc *desc,
gint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
/**
* bus_input_context_set_engine_by_desc_finish:
*
* A function to be called by the GAsyncReadyCallback function for bus_input_context_set_engine_by_desc.
*/
gboolean bus_input_context_set_engine_by_desc_finish
(BusInputContext *context,
GAsyncResult *res,
GError **error);
/**
* bus_input_context_get_engine:
*
* Get a BusEngineProxy object of the current engine.
*/
BusEngineProxy *bus_input_context_get_engine (BusInputContext *context);
/**
* bus_input_context_get_engine_desc:
*
* Get an IBusEngineDesc object of the current engine.
*/
IBusEngineDesc *bus_input_context_get_engine_desc (BusInputContext *context);
/**
* bus_input_context_property_activate:
*
* Call property_activate method of the current engine proxy.
*/
void bus_input_context_property_activate(BusInputContext *context,
const gchar *prop_name,
gint prop_state);
/**
* bus_input_context_get_capabilities:
* @returns: context->capabilities.
*/
guint bus_input_context_get_capabilities (BusInputContext *context);
/**
* bus_input_context_set_capabilities:
*
* Call set_capabilities method of the current engine proxy.
*/
void bus_input_context_set_capabilities (BusInputContext *context,
guint capabilities);
/**
* bus_input_context_get_client:
* @returns: context->client.
*/
const gchar *bus_input_context_get_client (BusInputContext *context);
G_END_DECLS
#endif
|
