Cosmetics.
[wine.git] / include / imm.h
blob5dba721da6d3ef5a86b0a7d4b59ca342629f6d3e
1 /*
2 * imm.h - Declarations for IMM32
3 */
5 #ifndef __WINE_IMM_H
6 #define __WINE_IMM_H
8 #include "windef.h"
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
14 typedef HANDLE HIMC;
15 typedef HANDLE HIMCC;
17 typedef HKL *LPHKL;
19 typedef int (CALLBACK *REGISTERWORDENUMPROCA)(LPCSTR, DWORD, LPCSTR, LPVOID);
20 typedef int (CALLBACK *REGISTERWORDENUMPROCW)(LPCWSTR, DWORD, LPCWSTR, LPVOID);
22 typedef struct tagCANDIDATEFORM
24 DWORD dwIndex;
25 DWORD dwStyle;
26 POINT ptCurrentPos;
27 RECT rcArea;
28 } CANDIDATEFORM, *LPCANDIDATEFORM;
30 typedef struct tagCANDIDATELIST
32 DWORD dwSize;
33 DWORD dwStyle;
34 DWORD dwCount;
35 DWORD dwSelection;
36 DWORD dwPageStart;
37 DWORD dwPageSize;
38 DWORD dwOffset[1];
39 } CANDIDATELIST, *LPCANDIDATELIST;
41 typedef struct tagSTYLEBUFA
43 DWORD dwStyle;
44 CHAR szDescription[32];
45 } STYLEBUFA, *LPSTYLEBUFA;
47 typedef struct tagSTYLEBUFW
49 DWORD dwStyle;
50 WCHAR szDescription[32];
51 } STYLEBUFW, *LPSTYLEBUFW;
53 DECL_WINELIB_TYPE_AW(STYLEBUF)
54 DECL_WINELIB_TYPE_AW(LPSTYLEBUF)
56 typedef struct _tagCOMPOSITIONFORM
58 DWORD dwStyle;
59 POINT ptCurrentPos;
60 RECT rcArea;
61 } COMPOSITIONFORM, *LPCOMPOSITIONFORM;
63 // wParam for WM_IME_CONTROL
64 #define IMC_GETCANDIDATEPOS 0x0007
65 #define IMC_SETCANDIDATEPOS 0x0008
66 #define IMC_GETCOMPOSITIONFONT 0x0009
67 #define IMC_SETCOMPOSITIONFONT 0x000A
68 #define IMC_GETCOMPOSITIONWINDOW 0x000B
69 #define IMC_SETCOMPOSITIONWINDOW 0x000C
70 #define IMC_GETSTATUSWINDOWPOS 0x000F
71 #define IMC_SETSTATUSWINDOWPOS 0x0010
72 #define IMC_CLOSESTATUSWINDOW 0x0021
73 #define IMC_OPENSTATUSWINDOW 0x0022
75 // wParam for WM_IME_CONTROL to the soft keyboard
76 // dwAction for ImmNotifyIME
77 #define NI_OPENCANDIDATE 0x0010
78 #define NI_CLOSECANDIDATE 0x0011
79 #define NI_SELECTCANDIDATESTR 0x0012
80 #define NI_CHANGECANDIDATELIST 0x0013
81 #define NI_FINALIZECONVERSIONRESULT 0x0014
82 #define NI_COMPOSITIONSTR 0x0015
83 #define NI_SETCANDIDATE_PAGESTART 0x0016
84 #define NI_SETCANDIDATE_PAGESIZE 0x0017
86 // lParam for WM_IME_SETCONTEXT
87 #define ISC_SHOWUICANDIDATEWINDOW 0x00000001
88 #define ISC_SHOWUICOMPOSITIONWINDOW 0x80000000
89 #define ISC_SHOWUIGUIDELINE 0x40000000
90 #define ISC_SHOWUIALLCANDIDATEWINDOW 0x0000000F
91 #define ISC_SHOWUIALL 0xC000000F
94 // dwIndex for ImmNotifyIME/NI_COMPOSITIONSTR
95 #define CPS_COMPLETE 0x0001
96 #define CPS_CONVERT 0x0002
97 #define CPS_REVERT 0x0003
98 #define CPS_CANCEL 0x0004
101 // the modifiers of hot key
102 #define MOD_ALT 0x0001
103 #define MOD_CONTROL 0x0002
104 #define MOD_SHIFT 0x0004
106 #define MOD_LEFT 0x8000
107 #define MOD_RIGHT 0x4000
109 #define MOD_ON_KEYUP 0x0800
110 #define MOD_IGNORE_ALL_MODIFIER 0x0400
113 // Windows for Simplified Chinese Edition hot key ID from 0x10 - 0x2F
114 #define IME_CHOTKEY_IME_NONIME_TOGGLE 0x10
115 #define IME_CHOTKEY_SHAPE_TOGGLE 0x11
116 #define IME_CHOTKEY_SYMBOL_TOGGLE 0x12
118 // Windows for Japanese Edition hot key ID from 0x30 - 0x4F
119 #define IME_JHOTKEY_CLOSE_OPEN 0x30
121 // Windows for Korean Edition hot key ID from 0x50 - 0x6F
122 #define IME_KHOTKEY_SHAPE_TOGGLE 0x50
123 #define IME_KHOTKEY_HANJACONVERT 0x51
124 #define IME_KHOTKEY_ENGLISH 0x52
125 // Windows for Tranditional Chinese Edition hot key ID from 0x70 - 0x8F
126 #define IME_THOTKEY_IME_NONIME_TOGGLE 0x70
127 #define IME_THOTKEY_SHAPE_TOGGLE 0x71
128 #define IME_THOTKEY_SYMBOL_TOGGLE 0x72
130 // direct switch hot key ID from 0x100 - 0x11F
131 #define IME_HOTKEY_DSWITCH_FIRST 0x100
132 #define IME_HOTKEY_DSWITCH_LAST 0x11F
134 // IME private hot key from 0x200 - 0x21F
135 #define IME_HOTKEY_PRIVATE_FIRST 0x200
136 #define IME_ITHOTKEY_RESEND_RESULTSTR 0x200
137 #define IME_ITHOTKEY_PREVIOUS_COMPOSITION 0x201
138 #define IME_ITHOTKEY_UISTYLE_TOGGLE 0x202
139 #define IME_HOTKEY_PRIVATE_LAST 0x21F
142 // dwSystemInfoFlags bits
143 // parameter of ImmGetCompositionString
144 #define GCS_COMPREADSTR 0x0001
145 #define GCS_COMPREADATTR 0x0002
146 #define GCS_COMPREADCLAUSE 0x0004
147 #define GCS_COMPSTR 0x0008
148 #define GCS_COMPATTR 0x0010
149 #define GCS_COMPCLAUSE 0x0020
150 #define GCS_CURSORPOS 0x0080
151 #define GCS_DELTASTART 0x0100
152 #define GCS_RESULTREADSTR 0x0200
153 #define GCS_RESULTREADCLAUSE 0x0400
154 #define GCS_RESULTSTR 0x0800
155 #define GCS_RESULTCLAUSE 0x1000
157 // style bit flags for WM_IME_COMPOSITION
158 #define CS_INSERTCHAR 0x2000
159 #define CS_NOMOVECARET 0x4000
162 // bits of fdwInit of INPUTCONTEXT
163 // IME version constants
164 #define IMEVER_0310 0x0003000A
165 #define IMEVER_0400 0x00040000
168 // IME property bits
169 #define IME_PROP_AT_CARET 0x00010000
170 #define IME_PROP_SPECIAL_UI 0x00020000
171 #define IME_PROP_CANDLIST_START_FROM_1 0x00040000
172 #define IME_PROP_UNICODE 0x00080000
175 // IME UICapability bits
176 #define UI_CAP_2700 0x00000001
177 #define UI_CAP_ROT90 0x00000002
178 #define UI_CAP_ROTANY 0x00000004
179 // ImmSetCompositionString Capability bits
180 #define SCS_CAP_COMPSTR 0x00000001
181 #define SCS_CAP_MAKEREAD 0x00000002
184 // IME WM_IME_SELECT inheritance Capability bits
185 #define SELECT_CAP_CONVERSION 0x00000001
186 #define SELECT_CAP_SENTENCE 0x00000002
189 // ID for deIndex of ImmGetGuideLine
190 #define GGL_LEVEL 0x00000001
191 #define GGL_INDEX 0x00000002
192 #define GGL_STRING 0x00000003
193 #define GGL_PRIVATE 0x00000004
195 // ID for dwLevel of GUIDELINE Structure
196 #define GL_LEVEL_NOGUIDELINE 0x00000000
197 #define GL_LEVEL_FATAL 0x00000001
198 #define GL_LEVEL_ERROR 0x00000002
199 #define GL_LEVEL_WARNING 0x00000003
200 #define GL_LEVEL_INFORMATION 0x00000004
202 // ID for dwIndex of GUIDELINE Structure
203 #define GL_ID_UNKNOWN 0x00000000
204 #define GL_ID_NOMODULE 0x00000001
205 #define GL_ID_NODICTIONARY 0x00000010
206 #define GL_ID_CANNOTSAVE 0x00000011
207 #define GL_ID_NOCONVERT 0x00000020
208 #define GL_ID_TYPINGERROR 0x00000021
209 #define GL_ID_TOOMANYSTROKE 0x00000022
210 #define GL_ID_READINGCONFLICT 0x00000023
211 #define GL_ID_INPUTREADING 0x00000024
212 #define GL_ID_INPUTRADICAL 0x00000025
213 #define GL_ID_INPUTCODE 0x00000026
214 #define GL_ID_INPUTSYMBOL 0x00000027
215 #define GL_ID_CHOOSECANDIDATE 0x00000028
216 #define GL_ID_REVERSECONVERSION 0x00000029
217 #define GL_ID_PRIVATE_FIRST 0x00008000
218 #define GL_ID_PRIVATE_LAST 0x0000FFFF
220 // ID for dwIndex of ImmGetProperty
221 #define IGP_GETIMEVERSION (DWORD)(-4)
222 #define IGP_PROPERTY 0x00000004
223 #define IGP_CONVERSION 0x00000008
224 #define IGP_SENTENCE 0x0000000c
225 #define IGP_UI 0x00000010
226 #define IGP_SETCOMPSTR 0x00000014
227 #define IGP_SELECT 0x00000018
230 // dwIndex for ImmSetCompositionString API
231 #define SCS_SETSTR (GCS_COMPREADSTR|GCS_COMPSTR)
232 #define SCS_CHANGEATTR (GCS_COMPREADATTR|GCS_COMPATTR)
233 #define SCS_CHANGECLAUSE (GCS_COMPREADCLAUSE|GCS_COMPCLAUSE)
234 // attribute for COMPOSITIONSTRING Structure
235 #define ATTR_INPUT 0x00
236 #define ATTR_TARGET_CONVERTED 0x01
237 #define ATTR_CONVERTED 0x02
238 #define ATTR_TARGET_NOTCONVERTED 0x03
239 #define ATTR_INPUT_ERROR 0x04
242 // bit field for IMC_SETCOMPOSITIONWINDOW, IMC_SETCANDIDATEWINDOW
243 #define CFS_DEFAULT 0x0000
244 #define CFS_RECT 0x0001
245 #define CFS_POINT 0x0002
246 #define CFS_FORCE_POSITION 0x0020
247 #define CFS_CANDIDATEPOS 0x0040
248 #define CFS_EXCLUDE 0x0080
250 // conversion direction for ImmGetConversionList
251 #define GCL_CONVERSION 0x0001
252 #define GCL_REVERSECONVERSION 0x0002
253 #define GCL_REVERSE_LENGTH 0x0003
256 // bit field for conversion mode
257 #define IME_CMODE_ALPHANUMERIC 0x0000
258 #define IME_CMODE_NATIVE 0x0001
259 #define IME_CMODE_CHINESE IME_CMODE_NATIVE
260 // IME_CMODE_HANGEUL is old name of IME_CMODE_HANGUL. It will be gone eventually.
261 #define IME_CMODE_HANGEUL IME_CMODE_NATIVE
262 #define IME_CMODE_HANGUL IME_CMODE_NATIVE
263 #define IME_CMODE_JAPANESE IME_CMODE_NATIVE
264 #define IME_CMODE_KATAKANA 0x0002 // only effect under IME_CMODE_NATIVE
265 #define IME_CMODE_LANGUAGE 0x0003
266 #define IME_CMODE_FULLSHAPE 0x0008
267 #define IME_CMODE_ROMAN 0x0010
268 #define IME_CMODE_CHARCODE 0x0020
269 #define IME_CMODE_HANJACONVERT 0x0040
270 #define IME_CMODE_SOFTKBD 0x0080
271 #define IME_CMODE_NOCONVERSION 0x0100
272 #define IME_CMODE_EUDC 0x0200
273 #define IME_CMODE_SYMBOL 0x0400
276 #define IME_SMODE_NONE 0x0000
277 #define IME_SMODE_PLAURALCLAUSE 0x0001
278 #define IME_SMODE_SINGLECONVERT 0x0002
279 #define IME_SMODE_AUTOMATIC 0x0004
280 #define IME_SMODE_PHRASEPREDICT 0x0008
282 // style of candidate
283 #define IME_CAND_UNKNOWN 0x0000
284 #define IME_CAND_READ 0x0001
285 #define IME_CAND_CODE 0x0002
286 #define IME_CAND_MEANING 0x0003
287 #define IME_CAND_RADICAL 0x0004
288 #define IME_CAND_STROKE 0x0005
291 // wParam of report message WM_IME_NOTIFY
292 #define IMN_CLOSESTATUSWINDOW 0x0001
293 #define IMN_OPENSTATUSWINDOW 0x0002
294 #define IMN_CHANGECANDIDATE 0x0003
295 #define IMN_CLOSECANDIDATE 0x0004
296 #define IMN_OPENCANDIDATE 0x0005
297 #define IMN_SETCONVERSIONMODE 0x0006
298 #define IMN_SETSENTENCEMODE 0x0007
299 #define IMN_SETOPENSTATUS 0x0008
300 #define IMN_SETCANDIDATEPOS 0x0009
301 #define IMN_SETCOMPOSITIONFONT 0x000A
302 #define IMN_SETCOMPOSITIONWINDOW 0x000B
303 #define IMN_SETSTATUSWINDOWPOS 0x000C
304 #define IMN_GUIDELINE 0x000D
305 #define IMN_PRIVATE 0x000E
308 // error code of ImmGetCompositionString
309 #define IMM_ERROR_NODATA (-1)
310 #define IMM_ERROR_GENERAL (-2)
313 // dialog mode of ImmConfigureIME
314 #define IME_CONFIG_GENERAL 1
315 #define IME_CONFIG_REGISTERWORD 2
316 #define IME_CONFIG_SELECTDICTIONARY 3
318 // dialog mode of ImmEscape
319 #define IME_ESC_QUERY_SUPPORT 0x0003
320 #define IME_ESC_RESERVED_FIRST 0x0004
321 #define IME_ESC_RESERVED_LAST 0x07FF
322 #define IME_ESC_PRIVATE_FIRST 0x0800
323 #define IME_ESC_PRIVATE_LAST 0x0FFF
324 #define IME_ESC_SEQUENCE_TO_INTERNAL 0x1001
325 #define IME_ESC_GET_EUDC_DICTIONARY 0x1003
326 #define IME_ESC_SET_EUDC_DICTIONARY 0x1004
327 #define IME_ESC_MAX_KEY 0x1005
328 #define IME_ESC_IME_NAME 0x1006
329 #define IME_ESC_SYNC_HOTKEY 0x1007
330 #define IME_ESC_HANJA_MODE 0x1008
331 #define IME_ESC_AUTOMATA 0x1009
332 #define IME_ESC_PRIVATE_HOTKEY 0x100a
335 // style of word registration
336 #define IME_REGWORD_STYLE_EUDC 0x00000001
337 #define IME_REGWORD_STYLE_USER_FIRST 0x80000000
338 #define IME_REGWORD_STYLE_USER_LAST 0xFFFFFFFF
340 // type of soft keyboard
341 // for Windows Tranditional Chinese Edition
342 #define SOFTKEYBOARD_TYPE_T1 0x0001
343 // for Windows Simplified Chinese Edition
344 #define SOFTKEYBOARD_TYPE_C1 0x0002
347 HIMC WINAPI ImmAssociateContext(HWND, HIMC);
348 BOOL WINAPI ImmConfigureIMEA(HKL, HWND, DWORD, LPVOID);
349 BOOL WINAPI ImmConfigureIMEW(HKL, HWND, DWORD, LPVOID);
350 #define ImmConfigureIME WINELIB_NAME_AW(ImmConfigureIME)
351 HIMC WINAPI ImmCreateContext();
352 BOOL WINAPI ImmDestroyContext(HIMC hIMC);
353 UINT WINAPI ImmEnumRegisterWordA(HKL, REGISTERWORDENUMPROCA, LPCSTR, DWORD, LPCSTR, LPVOID);
354 UINT WINAPI ImmEnumRegisterWordW(HKL, REGISTERWORDENUMPROCW, LPCWSTR, DWORD, LPCWSTR, LPVOID);
355 #define ImmEnumRegisterWord WINELIB_NAME_AW(ImmEnumRegisterWord)
356 LRESULT WINAPI ImmEscapeA(HKL, HIMC, UINT, LPVOID);
357 LRESULT WINAPI ImmEscapeW(HKL, HIMC, UINT, LPVOID);
358 #define ImmEscape WINELIB_NAME_AW(ImmEscape)
359 DWORD WINAPI ImmGetCandidateListA(HIMC, DWORD, LPCANDIDATELIST, DWORD);
360 DWORD WINAPI ImmGetCandidateListW(HIMC, DWORD, LPCANDIDATELIST, DWORD);
361 #define ImmGetCandidateList WINELIB_NAME_AW(ImmGetCandidateList)
362 DWORD WINAPI ImmGetCandidateListCountA(HIMC, LPDWORD);
363 DWORD WINAPI ImmGetCandidateListCountW(HIMC, LPDWORD);
364 #define ImmGetCandidateListCount WINELIB_NAME_AW(ImmGetCandidateListCount)
365 BOOL WINAPI ImmGetCandidateWindow(HIMC, DWORD, LPCANDIDATEFORM);
366 BOOL WINAPI ImmGetCompositionFontA(HIMC, LPLOGFONTA);
367 BOOL WINAPI ImmGetCompositionFontW(HIMC, LPLOGFONTW);
368 #define ImmGetCompositionFont WINELIB_NAME_AW(ImmGetCompositionFont)
369 LONG WINAPI ImmGetCompositionStringA(HIMC, DWORD, LPVOID, DWORD);
370 LONG WINAPI ImmGetCompositionStringW(HIMC, DWORD, LPVOID, DWORD);
371 #define ImmGetCompositionString WINELIB_NAME_AW(ImmGetCompositionString)
372 BOOL WINAPI ImmGetCompositionWindow(HIMC, LPCOMPOSITIONFORM);
373 HIMC WINAPI ImmGetContext(HWND);
374 DWORD WINAPI ImmGetConversionListA(HKL, HIMC, LPCSTR, LPCANDIDATELIST, DWORD, UINT);
375 DWORD WINAPI ImmGetConversionListW(HKL, HIMC, LPCWSTR, LPCANDIDATELIST, DWORD, UINT);
376 #define ImmGetConversionList WINELIB_NAME_AW(ImmGetConversionList)
377 BOOL WINAPI ImmGetConversionStatus(HIMC, LPDWORD, LPDWORD);
378 HWND WINAPI ImmGetDefaultIMEWnd(HWND);
379 UINT WINAPI ImmGetDescriptionA(HKL, LPSTR, UINT);
380 UINT WINAPI ImmGetDescriptionW(HKL, LPWSTR, UINT);
381 #define ImmGetDescription WINELIB_NAME_AW(ImmGetDescription)
382 DWORD WINAPI ImmGetGuideLineA(HIMC, DWORD, LPSTR, DWORD);
383 DWORD WINAPI ImmGetGuideLineW(HIMC, DWORD, LPWSTR, DWORD);
384 #define ImmGetGuideLine WINELIB_NAME_AW(ImmGetGuideLine)
385 UINT WINAPI ImmGetIMEFileNameA(HKL, LPSTR, UINT);
386 UINT WINAPI ImmGetIMEFileNameW(HKL, LPWSTR, UINT);
387 #define ImmGetIMEFileName WINELIB_NAME_AW(ImmGetIMEFileName)
388 BOOL WINAPI ImmGetOpenStatus(HIMC);
389 DWORD WINAPI ImmGetProperty(HKL, DWORD);
390 UINT WINAPI ImmGetRegisterWordStyleA(HKL, UINT, LPSTYLEBUFA);
391 UINT WINAPI ImmGetRegisterWordStyleW(HKL, UINT, LPSTYLEBUFW);
392 #define ImmGetRegisterWordStyle WINELIB_NAME_AW(ImmGetRegisterWordStyle)
393 BOOL WINAPI ImmGetStatusWindowPos(HIMC, LPPOINT);
394 UINT WINAPI ImmGetVirtualKey(HWND);
395 HKL WINAPI ImmInstallIMEA(LPCSTR, LPCSTR);
396 HKL WINAPI ImmInstallIMEW(LPCWSTR, LPCWSTR);
397 #define ImmInstallIME WINELIB_NAME_AW(ImmInstallIME)
398 BOOL WINAPI ImmIsIME(HKL);
399 BOOL WINAPI ImmIsUIMessageA(HWND, UINT, WPARAM, LPARAM);
400 BOOL WINAPI ImmIsUIMessageW(HWND, UINT, WPARAM, LPARAM);
401 #define ImmIsUIMessage WINELIB_NAME_AW(ImmIsUIMessage)
402 BOOL WINAPI ImmNotifyIME(HIMC, DWORD, DWORD, DWORD);
403 BOOL WINAPI ImmRegisterWordA(HKL, LPCSTR, DWORD, LPCSTR);
404 BOOL WINAPI ImmRegisterWordW(HKL, LPCWSTR, DWORD, LPCWSTR);
405 #define ImmRegisterWord WINELIB_NAME_AW(ImmRegisterWord)
406 BOOL WINAPI ImmReleaseContext(HWND, HIMC);
407 BOOL WINAPI ImmSetCandidateWindow(HIMC, LPCANDIDATEFORM);
408 BOOL WINAPI ImmSetCompositionFontA(HIMC, LPLOGFONTA);
409 BOOL WINAPI ImmSetCompositionFontW(HIMC, LPLOGFONTW);
410 #define ImmSetCompositionFont WINELIB_NAME_AW(ImmSetCompositionFont)
411 BOOL WINAPI ImmSetCompositionStringA(HIMC, DWORD, LPCVOID, DWORD, LPCVOID, DWORD);
412 BOOL WINAPI ImmSetCompositionStringW(HIMC, DWORD, LPCVOID, DWORD, LPCVOID, DWORD);
413 #define ImmSetCompositionString WINELIB_NAME_AW(ImmSetCompositionString)
414 BOOL WINAPI ImmSetCompositionWindow(HIMC, LPCOMPOSITIONFORM);
415 BOOL WINAPI ImmSetConversionStatus(HIMC, DWORD, DWORD);
416 BOOL WINAPI ImmSetOpenStatus(HIMC, BOOL);
417 BOOL WINAPI ImmSetStatusWindowPos(HIMC, LPPOINT);
418 BOOL WINAPI ImmSimulateHotKey(HWND, DWORD);
419 BOOL WINAPI ImmUnregisterWordA(HKL, LPCSTR, DWORD, LPCSTR);
420 BOOL WINAPI ImmUnregisterWordW(HKL, LPCWSTR, DWORD, LPCWSTR);
421 #define ImmUnregisterWord WINELIB_NAME_AW(ImmUnregisterWord)
423 #ifdef __cplusplus
425 #endif
427 #endif /* __WINE_IMM_H */