SCIMBridge  0.4.x
scim-bridge-client.h
1 /*
2  * SCIM Bridge
3  *
4  * Copyright (c) 2006 Ryo Dairiki <ryo-dairiki@users.sourceforge.net>
5  *
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation and
10  * appearing in the file LICENSE.LGPL included in the package of this file.
11  * You can also redistribute it and/or modify it under the terms of
12  * the GNU General Public License as published by the Free Software Foundation and
13  * appearing in the file LICENSE.GPL included in the package of this file.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18  */
19 
20 #ifndef SCIMBRIDGECLIENT_H_
21 #define SCIMBRIDGECLIENT_H_
22 
23 #include "scim-bridge.h"
24 #include "scim-bridge-key-event.h"
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
37  retval_t scim_bridge_client_initialize ();
38 
44  retval_t scim_bridge_client_finalize ();
45 
51  boolean scim_bridge_client_is_initialized ();
52 
58  retval_t scim_bridge_client_open_messenger ();
59 
65  retval_t scim_bridge_client_close_messenger ();
66 
72  boolean scim_bridge_client_is_messenger_opened ();
73 
79  int scim_bridge_client_get_messenger_fd ();
80 
81 
88  boolean scim_bridge_client_is_reconnection_enabled ();
89 
90 
97  retval_t scim_bridge_client_read_and_dispatch ();
98 
99 
106  retval_t scim_bridge_client_register_imcontext (ScimBridgeClientIMContext *imcontext);
107 
114  retval_t scim_bridge_client_deregister_imcontext (ScimBridgeClientIMContext *imcontext);
115 
122  ScimBridgeClientIMContext *scim_bridge_client_find_imcontext (scim_bridge_imcontext_id_t id);
123 
130  retval_t scim_bridge_client_reset_imcontext (const ScimBridgeClientIMContext *imcontext);
131 
139  retval_t scim_bridge_client_change_focus (const ScimBridgeClientIMContext *imcontext, boolean focus_in);
140 
149  retval_t scim_bridge_client_handle_key_event (const ScimBridgeClientIMContext *imcontext, const ScimBridgeKeyEvent *key_event, boolean *consumed);
150 
159  retval_t scim_bridge_client_set_cursor_location (const ScimBridgeClientIMContext *imcontext, int x, int y);
160 
167  retval_t scim_bridge_client_set_preedit_mode (const ScimBridgeClientIMContext *imcontext, scim_bridge_preedit_mode_t mode);
168 
169 #ifdef __cplusplus
170 }
171 #endif
172 #endif /*SCIMBRIDGECLIENT_H_*/
enum _scim_bridge_preedit_mode_t scim_bridge_preedit_mode_t
Definition: scim-bridge-imcontext.h:41
int retval_t
Definition: scim-bridge.h:59
Definition: scim-bridge-key-event.c:38
int scim_bridge_imcontext_id_t
Definition: scim-bridge-imcontext.h:47
This header describes about fundamental definitions of scim-bridge.
This is the common header of IMContext over the all clients.
Definition: scim-bridge-client-imcontext-gtk.c:41
This header describes about key events.