summaryrefslogtreecommitdiff
path: root/src/ibusxevent.h
blob: f35f14e45120ea95acee99aa091b46bd0747b723 (plain)
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
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* ibus - The Input Bus
 * Copyright (C) 2018 Takao Fujiwara <takao.fujiwara1@gmail.com>
 * Copyright (C) 2018 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
 */

#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif

#ifndef __IBUS_X_EVENT_H_
#define __IBUS_X_EVENT_H_

/**
 * SECTION: ibusxevent
 * @short_description: XEvent wrapper object
 * @title: IBusXEvent
 * @stability: Unstable
 *
 * An IBusXEvent provides a wrapper of XEvent.
 *
 * see_also: #IBusComponent, #IBusEngineDesc
 */

#include "ibusserializable.h"

/*
 * Type macros.
 */

/* define GOBJECT macros */
#define IBUS_TYPE_X_EVENT            \
    (ibus_x_event_get_type ())
#define IBUS_X_EVENT(obj)            \
    (G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_X_EVENT, IBusXEvent))
#define IBUS_X_EVENT_CLASS(klass)    \
    (G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_X_EVENT, IBusXEventClass))
#define IBUS_IS_X_EVENT(obj)         \
    (G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_X_EVENT))
#define IBUS_IS_X_EVENT_CLASS(klass) \
    (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_X_EVENT))
#define IBUS_X_EVENT_GET_CLASS(obj)  \
    (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_X_EVENT, IBusXEventClass))

G_BEGIN_DECLS

typedef struct _IBusXEvent IBusXEvent;
typedef struct _IBusXEventClass IBusXEventClass;
typedef struct _IBusXEventPrivate IBusXEventPrivate;

typedef enum {
    IBUS_X_EVENT_NOTHING           = -1,
    IBUS_X_EVENT_KEY_PRESS         = 0,
    IBUS_X_EVENT_KEY_RELEASE       = 1,
    IBUS_X_EVENT_OTHER             = 2,
    IBUS_X_EVENT_EVENT_LAST        /* helper variable for decls */
} IBusXEventType;

/**
 * IBusXEvent:
 * @type: event type
 *
 * IBusEngine properties.
 */
struct _IBusXEvent {
    /*< private >*/
    IBusSerializable parent;
    IBusXEventPrivate *priv;

    /* instance members */
    /*< public >*/
    IBusXEventType event_type;
    guint          window;
    gint8          send_event;
    gulong         serial;
};

struct _IBusXEventClass {
    /*< private >*/
    IBusSerializableClass parent;

    /* class members */
    /*< public >*/

    /*< private >*/
    /* padding */
    gpointer pdummy[10];
};

GType        ibus_x_event_get_type       (void);

/**
 * ibus_x_event_new:
 * @first_property_name: Name of the first property.
 * @...: the NULL-terminated arguments of the properties and values.
 *
 * Create a new #IBusXEvent.
 *
 * Returns: A newly allocated #IBusXEvent. E.g.
 * ibus_x_event_new ("event-type", IBUS_X_EVENT_KEY_PRESS, NULL);
 */
IBusXEvent *   ibus_x_event_new            (const gchar
                                                           *first_property_name,
                                            ...);

/**
 * ibus_x_event_get_version:
 * @event: An #IBusXEvent.
 *
 * Returns: Version of #IBusXEvent
 */
guint          ibus_x_event_get_version    (IBusXEvent         *event);

/**
 * ibus_x_event_get_event_type:
 * @event: An #IBusXEvent.
 *
 * Returns: IBusXEventType of #IBusXEvent
 */
IBusXEventType ibus_x_event_get_event_type (IBusXEvent         *event);

/**
 * ibus_x_event_get_window:
 * @event: An #IBusXEvent.
 *
 * Returns: XID of #IBusXEvent
 */
guint32        ibus_x_event_get_window     (IBusXEvent         *event);

/**
 * ibus_x_event_get_send_event:
 * @event: An #IBusXEvent.
 *
 * Returns: send_event of #IBusXEvent
 */
gint8          ibus_x_event_get_send_event (IBusXEvent         *event);

/**
 * ibus_x_event_get_serial:
 * @event: An #IBusXEvent.
 *
 * Returns: serial of #IBusXEvent
 */
gulong         ibus_x_event_get_serial     (IBusXEvent         *event);

/**
 * ibus_x_event_get_time:
 * @event: An #IBusXEvent.
 *
 * Returns: time of #IBusXEvent
 */
guint32        ibus_x_event_get_time       (IBusXEvent         *event);

/**
 * ibus_x_event_get_state:
 * @event: An #IBusXEvent.
 *
 * Returns: state of #IBusXEvent
 */
guint          ibus_x_event_get_state      (IBusXEvent         *event);

/**
 * ibus_x_event_get_keyval:
 * @event: An #IBusXEvent.
 *
 * Returns: keyval of #IBusXEvent
 */
guint          ibus_x_event_get_keyval     (IBusXEvent         *event);

/**
 * ibus_x_event_get_length:
 * @event: An #IBusXEvent.
 *
 * Returns: length of #IBusXEvent
 */
gint           ibus_x_event_get_length     (IBusXEvent         *event);

/**
 * ibus_x_event_get_string:
 * @event: An #IBusXEvent.
 *
 * Returns: string of #IBusXEvent
 */
const gchar *  ibus_x_event_get_string     (IBusXEvent         *event);

/**
 * ibus_x_event_get_hardware_keycode:
 * @event: An #IBusXEvent.
 *
 * Returns: hardware keycode of #IBusXEvent
 */
guint16        ibus_x_event_get_hardware_keycode
                                           (IBusXEvent         *event);

/**
 * ibus_x_event_get_group:
 * @event: An #IBusXEvent.
 *
 * Returns: group of #IBusXEvent
 */
guint8         ibus_x_event_get_group      (IBusXEvent         *event);

/**
 * ibus_x_event_get_is_modifier:
 * @event: An #IBusXEvent.
 *
 * Returns: is_modifier of #IBusXEvent
 */
gboolean       ibus_x_event_get_is_modifier
                                           (IBusXEvent         *event);

/**
 * ibus_x_event_get_subwindow:
 * @event: An #IBusXEvent.
 *
 * Returns: subwindow of #IBusXEvent
 */
guint32        ibus_x_event_get_subwindow  (IBusXEvent         *event);

/**
 * ibus_x_event_get_root:
 * @event: An #IBusXEvent.
 *
 * Returns: root window of #IBusXEvent
 */
guint32        ibus_x_event_get_root       (IBusXEvent         *event);

/**
 * ibus_x_event_get_x:
 * @event: An #IBusXEvent.
 *
 * Returns: x of #IBusXEvent
 */
gint           ibus_x_event_get_x          (IBusXEvent         *event);

/**
 * ibus_x_event_get_y:
 * @event: An #IBusXEvent.
 *
 * Returns: y of #IBusXEvent
 */
gint           ibus_x_event_get_y          (IBusXEvent         *event);

/**
 * ibus_x_event_get_x_root:
 * @event: An #IBusXEvent.
 *
 * Returns: x-root of #IBusXEvent
 */
gint           ibus_x_event_get_x_root     (IBusXEvent         *event);

/**
 * ibus_x_event_get_y_root:
 * @event: An #IBusXEvent.
 *
 * Returns: y-root of #IBusXEvent
 */
gint           ibus_x_event_get_y_root     (IBusXEvent         *event);

/**
 * ibus_x_event_get_same_screen:
 * @event: An #IBusXEvent.
 *
 * Returns: same_screen of #IBusXEvent
 */
gboolean       ibus_x_event_get_same_screen
                                           (IBusXEvent         *event);

/**
 * ibus_x_event_get_purpose:
 * @event: An #IBusXEvent.
 *
 * Returns: purpose of #IBusXEvent
 */
const gchar *  ibus_x_event_get_purpose    (IBusXEvent         *event);

G_END_DECLS
#endif