Tizen 2.1 base
[platform/core/uifw/ise-engine-sunpinyin.git] / wrapper / xim / xim.h
1 /*
2  * Copyright (c) 2010 Mike Qin <mikeandmore@gmail.com>
3  *
4  * The contents of this file are subject to the terms of either the GNU Lesser
5  * General Public License Version 2.1 only ("LGPL") or the Common Development and
6  * Distribution License ("CDDL")(collectively, the "License"). You may not use this
7  * file except in compliance with the License. You can obtain a copy of the CDDL at
8  * http://www.opensource.org/licenses/cddl1.php and a copy of the LGPLv2.1 at
9  * http://www.opensource.org/licenses/lgpl-license.php. See the License for the
10  * specific language governing permissions and limitations under the License. When
11  * distributing the software, include this License Header Notice in each file and
12  * include the full text of the License in the License file as well as the
13  * following notice:
14  *
15  * NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE
16  * (CDDL)
17  * For Covered Software in this distribution, this License shall be governed by the
18  * laws of the State of California (excluding conflict-of-law provisions).
19  * Any litigation relating to this License shall be subject to the jurisdiction of
20  * the Federal Courts of the Northern District of California and the state courts
21  * of the State of California, with venue lying in Santa Clara County, California.
22  *
23  * Contributor(s):
24  *
25  * If you wish your version of this file to be governed by only the CDDL or only
26  * the LGPL Version 2.1, indicate your decision by adding "[Contributor]" elects to
27  * include this software in this distribution under the [CDDL or LGPL Version 2.1]
28  * license." If you don't indicate a single choice of license, a recipient has the
29  * option to distribute your version of this file under either the CDDL or the LGPL
30  * Version 2.1, or to extend the choice of license to its licensees as provided
31  * above. However, if you add LGPL Version 2.1 code and therefore, elected the LGPL
32  * Version 2 license, then the option applies only if the new code is made subject
33  * to such option by the copyright holder.
34  */
35
36 #ifndef _XIM_H_
37 #define _XIM_H_
38
39 #include <X11/X.h>
40 #include <X11/Xproto.h>
41 #include <X11/Xlib.h>
42 #include <X11/keysym.h>
43 #include <X11/Xutil.h>
44 #include <XimProto.h>
45 #include <IMdkit.h>
46 #include <Xi18n.h>
47
48 #include "common.h"
49
50 __BEGIN_DECLS
51
52 #define STATE_MASK 0x0D
53
54 typedef struct _XIMS XIMHandle;
55
56 XIMHandle* create_xim_server(const char* server_name, const char* locale);
57
58 void      xim_start_preedit (XIMHandle* handle);
59 void      xim_cancel_preedit(XIMHandle* handle);
60 void      xim_commit_preedit(XIMHandle* handle, const char* result_str);
61
62 /* provided by preedit backend */
63 void      preedit_init(void);
64 void      preedit_finalize(void);
65
66 void      preedit_set_handle(XIMHandle* handle);
67 void      preedit_reload(void);
68
69 void      preedit_move(int x, int y);
70 void      preedit_on_key(XIMHandle* handle, unsigned int keycode,
71                          unsigned int state);
72 bool      preedit_status(void);
73 void      preedit_pause(void);
74 void      preedit_go_on(void);
75 void      preedit_set_full(bool full);
76 void      preedit_set_chinese_punc(bool chn_punc);
77 void      preedit_omit_next_punct();
78
79 __END_DECLS
80
81 #endif /* _XIM_H_ */