xref: /reactos/sdk/include/psdk/imm.h (revision 7244e0c5)
1 /*
2  * Declarations for IMM32
3  *
4  * Copyright (C) the Wine project
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20 
21 #ifndef __WINE_IMM_H
22 #define __WINE_IMM_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 #ifdef __REACTOS__
29 DECLARE_HANDLE(HIMC);
30 DECLARE_HANDLE(HIMCC);
31 typedef HKL *LPHKL;
32 #else
33 typedef HANDLE HIMC;
34 typedef HANDLE HIMCC;
35 #endif
36 
37 typedef struct tagREGISTERWORDA {
38     LPSTR lpReading;
39     LPSTR lpWord;
40 } REGISTERWORDA, *PREGISTERWORDA, *NPREGISTERWORDA, *LPREGISTERWORDA;
41 
42 typedef struct tagREGISTERWORDW {
43     LPWSTR lpReading;
44     LPWSTR lpWord;
45 } REGISTERWORDW, *PREGISTERWORDW, *NPREGISTERWORDW, *LPREGISTERWORDW;
46 
47 typedef int
48 (CALLBACK *REGISTERWORDENUMPROCA)(
49   _In_ LPCSTR,
50   _In_ DWORD,
51   _In_ LPCSTR,
52   _In_ LPVOID);
53 
54 typedef int
55 (CALLBACK *REGISTERWORDENUMPROCW)(
56   _In_ LPCWSTR,
57   _In_ DWORD,
58   _In_ LPCWSTR,
59   _In_ LPVOID);
60 
61 typedef struct tagCANDIDATEFORM
62 {
63 				DWORD   dwIndex;
64 				DWORD   dwStyle;
65 				POINT ptCurrentPos;
66 				RECT  rcArea;
67 } CANDIDATEFORM, *LPCANDIDATEFORM;
68 
69 typedef struct tagCANDIDATELIST
70 {
71 				DWORD dwSize;
72 				DWORD dwStyle;
73 				DWORD dwCount;
74 				DWORD dwSelection;
75 				DWORD dwPageStart;
76 				DWORD dwPageSize;
77 				DWORD dwOffset[1];
78 } CANDIDATELIST, *LPCANDIDATELIST;
79 
80 typedef struct tagSTYLEBUFA
81 {
82 				DWORD dwStyle;
83 				CHAR  szDescription[32];
84 } STYLEBUFA, *LPSTYLEBUFA;
85 
86 typedef struct tagSTYLEBUFW
87 {
88 				DWORD dwStyle;
89 				WCHAR  szDescription[32];
90 } STYLEBUFW, *LPSTYLEBUFW;
91 
92 DECL_WINELIB_TYPE_AW(STYLEBUF)
93 DECL_WINELIB_TYPE_AW(LPSTYLEBUF)
94 
95 typedef struct tagRECONVERTSTRING
96 {
97 	DWORD	dwSize;
98 	DWORD	dwVersion;
99 	DWORD	dwStrLen;
100 	DWORD	dwStrOffset;
101 	DWORD	dwCompStrLen;
102 	DWORD	dwCompStrOffset;
103 	DWORD	dwTargetStrLen;
104 	DWORD	dwTargetStrOffset;
105 } RECONVERTSTRING, *LPRECONVERTSTRING;
106 
107 
108 #define IMEMENUITEM_STRING_SIZE 80
109 
110 typedef struct tagIMEMENUITEMINFOA
111 {
112 	UINT		cbSize;
113 	UINT		fType;
114 	UINT		fState;
115 	UINT		wID;
116 	HBITMAP		hbmpChecked;
117 	HBITMAP		hbmpUnchecked;
118 	DWORD		dwItemData;
119 	CHAR		szString[IMEMENUITEM_STRING_SIZE];
120 	HBITMAP		hbmpItem;
121 } IMEMENUITEMINFOA, *LPIMEMENUITEMINFOA;
122 
123 typedef struct tagIMEMENUITEMINFOW
124 {
125 	UINT		cbSize;
126 	UINT		fType;
127 	UINT		fState;
128 	UINT		wID;
129 	HBITMAP		hbmpChecked;
130 	HBITMAP		hbmpUnchecked;
131 	DWORD		dwItemData;
132 	WCHAR		szString[IMEMENUITEM_STRING_SIZE];
133 	HBITMAP		hbmpItem;
134 } IMEMENUITEMINFOW, *LPIMEMENUITEMINFOW;
135 
136 DECL_WINELIB_TYPE_AW(IMEMENUITEMINFO)
137 DECL_WINELIB_TYPE_AW(LPIMEMENUITEMINFO)
138 
139 typedef struct tagIMECHARPOSITION {
140     DWORD       dwSize;
141     DWORD       dwCharPos;
142     POINT       pt;
143     UINT        cLineHeight;
144     RECT        rcDocument;
145 } IMECHARPOSITION, *PIMECHARPOSITION, *NPIMECHARPOSITION, *LPIMECHARPOSITION;
146 
147 typedef BOOL    (CALLBACK* IMCENUMPROC)(HIMC, LPARAM);
148 
149 typedef struct _tagCOMPOSITIONFORM
150 {
151 				DWORD   dwStyle;
152 				POINT ptCurrentPos;
153 				RECT  rcArea;
154 } COMPOSITIONFORM, *LPCOMPOSITIONFORM;
155 
156 typedef struct _tagIMEINFO {
157     DWORD       dwPrivateDataSize;
158     DWORD       fdwProperty;
159     DWORD       fdwConversionCaps;
160     DWORD       fdwSentenceCaps;
161     DWORD       fdwUICaps;
162     DWORD       fdwSCSCaps;
163     DWORD       fdwSelectCaps;
164 } IMEINFO, *LPIMEINFO;
165 
166 typedef struct tagCOMPOSITIONSTRING {
167     DWORD dwSize;
168     DWORD dwCompReadAttrLen;
169     DWORD dwCompReadAttrOffset;
170     DWORD dwCompReadClauseLen;
171     DWORD dwCompReadClauseOffset;
172     DWORD dwCompReadStrLen;
173     DWORD dwCompReadStrOffset;
174     DWORD dwCompAttrLen;
175     DWORD dwCompAttrOffset;
176     DWORD dwCompClauseLen;
177     DWORD dwCompClauseOffset;
178     DWORD dwCompStrLen;
179     DWORD dwCompStrOffset;
180     DWORD dwCursorPos;
181     DWORD dwDeltaStart;
182     DWORD dwResultReadClauseLen;
183     DWORD dwResultReadClauseOffset;
184     DWORD dwResultReadStrLen;
185     DWORD dwResultReadStrOffset;
186     DWORD dwResultClauseLen;
187     DWORD dwResultClauseOffset;
188     DWORD dwResultStrLen;
189     DWORD dwResultStrOffset;
190     DWORD dwPrivateSize;
191     DWORD dwPrivateOffset;
192 } COMPOSITIONSTRING, *LPCOMPOSITIONSTRING;
193 
194 typedef struct tagGUIDELINE {
195     DWORD dwSize;
196     DWORD dwLevel;
197     DWORD dwIndex;
198     DWORD dwStrLen;
199     DWORD dwStrOffset;
200     DWORD dwPrivateSize;
201     DWORD dwPrivateOffset;
202 } GUIDELINE, *LPGUIDELINE;
203 
204 typedef struct tagCANDIDATEINFO {
205     DWORD               dwSize;
206     DWORD               dwCount;
207     DWORD               dwOffset[32];
208     DWORD               dwPrivateSize;
209     DWORD               dwPrivateOffset;
210 } CANDIDATEINFO, *LPCANDIDATEINFO;
211 
212 /* IME Property bits */
213 #define IME_PROP_END_UNLOAD             0x0001
214 #define IME_PROP_KBD_CHAR_FIRST         0x0002
215 #define IME_PROP_IGNORE_UPKEYS          0x0004
216 #define IME_PROP_NEED_ALTKEY            0x0008
217 #define IME_PROP_NO_KEYS_ON_CLOSE       0x0010
218 #define IME_PROP_ACCEPT_WIDE_VKEY       0x0020
219 
220 /* for NI_CONTEXTUPDATED */
221 #define IMC_SETCONVERSIONMODE           0x0002
222 #define IMC_SETSENTENCEMODE             0x0004
223 #define IMC_SETOPENSTATUS               0x0006
224 
225 /* dwAction for ImmNotifyIME */
226 #define NI_CONTEXTUPDATED               0x0003
227 #define NI_OPENCANDIDATE                0x0010
228 #define NI_CLOSECANDIDATE               0x0011
229 #define NI_SELECTCANDIDATESTR           0x0012
230 #define NI_CHANGECANDIDATELIST          0x0013
231 #define NI_FINALIZECONVERSIONRESULT     0x0014
232 #define NI_COMPOSITIONSTR               0x0015
233 #define NI_SETCANDIDATE_PAGESTART       0x0016
234 #define NI_SETCANDIDATE_PAGESIZE        0x0017
235 #define NI_IMEMENUSELECTED              0x0018
236 
237 /* dwSystemInfoFlags bits */
238 #define IME_SYSINFO_WINLOGON            0x0001
239 #define IME_SYSINFO_WOW16               0x0002
240 
241 BOOL  WINAPI ImmUnlockIMC(HIMC);
242 DWORD WINAPI ImmGetIMCLockCount(HIMC);
243 HIMCC  WINAPI ImmCreateIMCC(DWORD);
244 HIMCC  WINAPI ImmDestroyIMCC(HIMCC);
245 LPVOID WINAPI ImmLockIMCC(HIMCC);
246 BOOL   WINAPI ImmUnlockIMCC(HIMCC);
247 DWORD  WINAPI ImmGetIMCCLockCount(HIMCC);
248 HIMCC  WINAPI ImmReSizeIMCC(HIMCC, DWORD);
249 DWORD  WINAPI ImmGetIMCCSize(HIMCC);
250 
251 BOOL WINAPI ImmGenerateMessage(HIMC);
252 LRESULT WINAPI ImmRequestMessageA(HIMC, WPARAM, LPARAM);
253 LRESULT WINAPI ImmRequestMessageW(HIMC, WPARAM, LPARAM);
254 #define ImmRequestMessage WINELIB_NAME_AW(ImmRequestMessage);
255 BOOL WINAPI ImmTranslateMessage(HWND, UINT, WPARAM, LPARAM);
256 HWND WINAPI ImmCreateSoftKeyboard(UINT, UINT, int, int);
257 BOOL WINAPI ImmDestroySoftKeyboard(HWND);
258 BOOL WINAPI ImmShowSoftKeyboard(HWND, int);
259 
260 BOOL WINAPI ImeInquire(LPIMEINFO, LPWSTR, LPCWSTR lpszOptions);
261 BOOL WINAPI ImeConfigure (HKL, HWND, DWORD, LPVOID);
262 DWORD WINAPI ImeConversionList(HIMC, LPCWSTR, LPCANDIDATELIST,DWORD,UINT);
263 BOOL WINAPI ImeDestroy(UINT);
264 LRESULT WINAPI ImeEscape(HIMC, UINT, LPVOID);
265 BOOL WINAPI ImeProcessKey(HIMC, UINT, LPARAM, CONST LPBYTE);
266 BOOL WINAPI ImeSelect(HIMC, BOOL);
267 BOOL WINAPI ImeSetActiveContext(HIMC, BOOL);
268 UINT WINAPI ImeToAsciiEx(UINT, UINT, CONST LPBYTE, LPDWORD, UINT, HIMC);
269 BOOL WINAPI NotifyIME(HIMC, DWORD, DWORD, DWORD);
270 BOOL WINAPI ImeRegisterWord(LPCWSTR, DWORD, LPCWSTR);
271 BOOL WINAPI ImeUnregisterWord(LPCWSTR, DWORD, LPCWSTR);
272 UINT WINAPI ImeGetRegisterWordStyle(UINT, LPSTYLEBUFW);
273 UINT WINAPI ImeEnumRegisterWord(REGISTERWORDENUMPROCW, LPCWSTR, DWORD, LPCWSTR, LPVOID);
274 BOOL WINAPI ImeSetCompositionString(HIMC, DWORD, LPCVOID, DWORD, LPCVOID, DWORD);
275 DWORD WINAPI ImeGetImeMenuItems(HIMC, DWORD, DWORD, LPIMEMENUITEMINFOW, LPIMEMENUITEMINFOW, DWORD);
276 
277 /* wParam for WM_IME_CONTROL */
278 #define IMC_GETCANDIDATEPOS             0x0007
279 #define IMC_SETCANDIDATEPOS             0x0008
280 #define IMC_GETCOMPOSITIONFONT          0x0009
281 #define IMC_SETCOMPOSITIONFONT          0x000A
282 #define IMC_GETCOMPOSITIONWINDOW        0x000B
283 #define IMC_SETCOMPOSITIONWINDOW        0x000C
284 #define IMC_GETSTATUSWINDOWPOS          0x000F
285 #define IMC_SETSTATUSWINDOWPOS          0x0010
286 #define IMC_CLOSESTATUSWINDOW           0x0021
287 #define IMC_OPENSTATUSWINDOW            0x0022
288 
289 /*
290  * wParam for WM_IME_CONTROL to the soft keyboard
291  * dwAction for ImmNotifyIME
292  */
293 #define NI_OPENCANDIDATE                0x0010
294 #define NI_CLOSECANDIDATE               0x0011
295 #define NI_SELECTCANDIDATESTR           0x0012
296 #define NI_CHANGECANDIDATELIST          0x0013
297 #define NI_FINALIZECONVERSIONRESULT     0x0014
298 #define NI_COMPOSITIONSTR               0x0015
299 #define NI_SETCANDIDATE_PAGESTART       0x0016
300 #define NI_SETCANDIDATE_PAGESIZE        0x0017
301 #define NI_IMEMENUSELECTED		0x0018
302 
303 /* lParam for WM_IME_SETCONTEXT */
304 #define ISC_SHOWUICANDIDATEWINDOW       0x00000001
305 #define ISC_SHOWUICOMPOSITIONWINDOW     0x80000000
306 #define ISC_SHOWUIGUIDELINE             0x40000000
307 #define ISC_SHOWUIALLCANDIDATEWINDOW    0x0000000F
308 #define ISC_SHOWUIALL                   0xC000000F
309 
310 
311 /* dwIndex for ImmNotifyIME/NI_COMPOSITIONSTR */
312 #define CPS_COMPLETE                    0x0001
313 #define CPS_CONVERT                     0x0002
314 #define CPS_REVERT                      0x0003
315 #define CPS_CANCEL                      0x0004
316 
317 
318 /* the modifiers of hot key */
319 #define MOD_ALT                         0x0001
320 #define MOD_CONTROL                     0x0002
321 #define MOD_SHIFT                       0x0004
322 
323 #define MOD_LEFT                        0x8000
324 #define MOD_RIGHT                       0x4000
325 
326 #define MOD_ON_KEYUP                    0x0800
327 #define MOD_IGNORE_ALL_MODIFIER         0x0400
328 
329 
330 /* Windows for Simplified Chinese Edition hot key ID from 0x10 - 0x2F */
331 #define IME_CHOTKEY_IME_NONIME_TOGGLE           0x10
332 #define IME_CHOTKEY_SHAPE_TOGGLE                0x11
333 #define IME_CHOTKEY_SYMBOL_TOGGLE               0x12
334 
335 /* Windows for Japanese Edition hot key ID from 0x30 - 0x4F */
336 #define IME_JHOTKEY_CLOSE_OPEN                  0x30
337 
338 /* Windows for Korean Edition hot key ID from 0x50 - 0x6F */
339 #define IME_KHOTKEY_SHAPE_TOGGLE                0x50
340 #define IME_KHOTKEY_HANJACONVERT                0x51
341 #define IME_KHOTKEY_ENGLISH                     0x52
342 /* Windows for Tranditional Chinese Edition hot key ID from 0x70 - 0x8F */
343 #define IME_THOTKEY_IME_NONIME_TOGGLE           0x70
344 #define IME_THOTKEY_SHAPE_TOGGLE                0x71
345 #define IME_THOTKEY_SYMBOL_TOGGLE               0x72
346 
347 /* direct switch hot key ID from 0x100 - 0x11F */
348 #define IME_HOTKEY_DSWITCH_FIRST                0x100
349 #define IME_HOTKEY_DSWITCH_LAST                 0x11F
350 
351 /* IME private hot key from 0x200 - 0x21F */
352 #define IME_HOTKEY_PRIVATE_FIRST                0x200
353 #define IME_ITHOTKEY_RESEND_RESULTSTR           0x200
354 #define IME_ITHOTKEY_PREVIOUS_COMPOSITION       0x201
355 #define IME_ITHOTKEY_UISTYLE_TOGGLE             0x202
356 #define IME_ITHOTKEY_RECONVERTSTRING		0x203
357 #define IME_HOTKEY_PRIVATE_LAST                 0x21F
358 
359 
360 /*
361  * dwSystemInfoFlags bits
362  * parameter of ImmGetCompositionString
363  */
364 #define GCS_COMPREADSTR                 0x0001
365 #define GCS_COMPREADATTR                0x0002
366 #define GCS_COMPREADCLAUSE              0x0004
367 #define GCS_COMPSTR                     0x0008
368 #define GCS_COMPATTR                    0x0010
369 #define GCS_COMPCLAUSE                  0x0020
370 #define GCS_CURSORPOS                   0x0080
371 #define GCS_DELTASTART                  0x0100
372 #define GCS_RESULTREADSTR               0x0200
373 #define GCS_RESULTREADCLAUSE            0x0400
374 #define GCS_RESULTSTR                   0x0800
375 #define GCS_RESULTCLAUSE                0x1000
376 
377 /* style bit flags for WM_IME_COMPOSITION */
378 #define CS_INSERTCHAR                   0x2000
379 #define CS_NOMOVECARET                  0x4000
380 
381 
382 /*
383  * bits of fdwInit of INPUTCONTEXT
384  * IME version constants
385  */
386 #define IMEVER_0310                     0x0003000A
387 #define IMEVER_0400                     0x00040000
388 
389 /* IME property bits */
390 #define IME_PROP_AT_CARET               0x00010000
391 #define IME_PROP_SPECIAL_UI             0x00020000
392 #define IME_PROP_CANDLIST_START_FROM_1  0x00040000
393 #define IME_PROP_UNICODE                0x00080000
394 #define IME_PROP_COMPLETE_ON_UNSELECT	0x00100000
395 
396 /* IME UICapability bits */
397 #define UI_CAP_2700                     0x00000001
398 #define UI_CAP_ROT90                    0x00000002
399 #define UI_CAP_ROTANY                   0x00000004
400 #define UI_CAP_SOFTKBD                  0x00010000
401 
402 /* ImmSetCompositionString Capability bits */
403 #define SCS_CAP_COMPSTR                 0x00000001
404 #define SCS_CAP_MAKEREAD                0x00000002
405 #define SCS_CAP_SETRECONVERTSTRING	0x00000004
406 
407 /* IME WM_IME_SELECT inheritance Capability bits */
408 #define SELECT_CAP_CONVERSION           0x00000001
409 #define SELECT_CAP_SENTENCE             0x00000002
410 
411 
412 /* ID for deIndex of ImmGetGuideLine */
413 #define GGL_LEVEL                       0x00000001
414 #define GGL_INDEX                       0x00000002
415 #define GGL_STRING                      0x00000003
416 #define GGL_PRIVATE                     0x00000004
417 
418 /* ID for dwLevel of GUIDELINE Structure */
419 #define GL_LEVEL_NOGUIDELINE            0x00000000
420 #define GL_LEVEL_FATAL                  0x00000001
421 #define GL_LEVEL_ERROR                  0x00000002
422 #define GL_LEVEL_WARNING                0x00000003
423 #define GL_LEVEL_INFORMATION            0x00000004
424 
425 /* ID for dwIndex of GUIDELINE Structure */
426 #define GL_ID_UNKNOWN                   0x00000000
427 #define GL_ID_NOMODULE                  0x00000001
428 #define GL_ID_NODICTIONARY              0x00000010
429 #define GL_ID_CANNOTSAVE                0x00000011
430 #define GL_ID_NOCONVERT                 0x00000020
431 #define GL_ID_TYPINGERROR               0x00000021
432 #define GL_ID_TOOMANYSTROKE             0x00000022
433 #define GL_ID_READINGCONFLICT           0x00000023
434 #define GL_ID_INPUTREADING              0x00000024
435 #define GL_ID_INPUTRADICAL              0x00000025
436 #define GL_ID_INPUTCODE                 0x00000026
437 #define GL_ID_INPUTSYMBOL               0x00000027
438 #define GL_ID_CHOOSECANDIDATE           0x00000028
439 #define GL_ID_REVERSECONVERSION         0x00000029
440 #define GL_ID_PRIVATE_FIRST             0x00008000
441 #define GL_ID_PRIVATE_LAST              0x0000FFFF
442 
443 /* ID for dwIndex of ImmGetProperty */
444 #define IGP_GETIMEVERSION               (DWORD)(-4)
445 #define IGP_PROPERTY                    0x00000004
446 #define IGP_CONVERSION                  0x00000008
447 #define IGP_SENTENCE                    0x0000000c
448 #define IGP_UI                          0x00000010
449 #define IGP_SETCOMPSTR                  0x00000014
450 #define IGP_SELECT                      0x00000018
451 
452 
453 /* dwIndex for ImmSetCompositionString API */
454 #define SCS_SETSTR          (GCS_COMPREADSTR|GCS_COMPSTR)
455 #define SCS_CHANGEATTR      (GCS_COMPREADATTR|GCS_COMPATTR)
456 #define SCS_CHANGECLAUSE    (GCS_COMPREADCLAUSE|GCS_COMPCLAUSE)
457 #define SCS_SETRECONVERTSTRING		0x00010000
458 #define SCS_QUERYRECONVERTSTRING	0x00020000
459 
460 /* attribute for COMPOSITIONSTRING Structure */
461 #define ATTR_INPUT                      0x00
462 #define ATTR_TARGET_CONVERTED           0x01
463 #define ATTR_CONVERTED                  0x02
464 #define ATTR_TARGET_NOTCONVERTED        0x03
465 #define ATTR_INPUT_ERROR                0x04
466 #define ATTR_FIXEDCONVERTED		0x05
467 
468 
469 /* bit field for IMC_SETCOMPOSITIONWINDOW, IMC_SETCANDIDATEWINDOW */
470 #define CFS_DEFAULT                     0x0000
471 #define CFS_RECT                        0x0001
472 #define CFS_POINT                       0x0002
473 #define CFS_FORCE_POSITION              0x0020
474 #define CFS_CANDIDATEPOS                0x0040
475 #define CFS_EXCLUDE                     0x0080
476 
477 /* conversion direction for ImmGetConversionList */
478 #define GCL_CONVERSION                  0x0001
479 #define GCL_REVERSECONVERSION           0x0002
480 #define GCL_REVERSE_LENGTH              0x0003
481 
482 
483 /* bit field for conversion mode */
484 #define IME_CMODE_ALPHANUMERIC          0x0000
485 #define IME_CMODE_NATIVE                0x0001
486 #define IME_CMODE_CHINESE               IME_CMODE_NATIVE
487 /* IME_CMODE_HANGEUL is old name of IME_CMODE_HANGUL. It will be gone eventually. */
488 #define IME_CMODE_HANGEUL               IME_CMODE_NATIVE
489 #define IME_CMODE_HANGUL                IME_CMODE_NATIVE
490 #define IME_CMODE_JAPANESE              IME_CMODE_NATIVE
491 #define IME_CMODE_KATAKANA              0x0002  /* only effect under IME_CMODE_NATIVE */
492 #define IME_CMODE_LANGUAGE              0x0003
493 #define IME_CMODE_FULLSHAPE             0x0008
494 #define IME_CMODE_ROMAN                 0x0010
495 #define IME_CMODE_CHARCODE              0x0020
496 #define IME_CMODE_HANJACONVERT          0x0040
497 #define IME_CMODE_SOFTKBD               0x0080
498 #define IME_CMODE_NOCONVERSION          0x0100
499 #define IME_CMODE_EUDC                  0x0200
500 #define IME_CMODE_SYMBOL                0x0400
501 #define IME_CMODE_FIXED			0x0800
502 
503 
504 #define IME_SMODE_NONE                  0x0000
505 #define IME_SMODE_PLAURALCLAUSE         0x0001
506 #define IME_SMODE_SINGLECONVERT         0x0002
507 #define IME_SMODE_AUTOMATIC             0x0004
508 #define IME_SMODE_PHRASEPREDICT         0x0008
509 #define IME_SMODE_CONVERSATION		0x0010
510 
511 /* style of candidate */
512 #define IME_CAND_UNKNOWN                0x0000
513 #define IME_CAND_READ                   0x0001
514 #define IME_CAND_CODE                   0x0002
515 #define IME_CAND_MEANING                0x0003
516 #define IME_CAND_RADICAL                0x0004
517 #define IME_CAND_STROKE                 0x0005
518 
519 
520 /* wParam of report message WM_IME_NOTIFY */
521 #define IMN_CLOSESTATUSWINDOW           0x0001
522 #define IMN_OPENSTATUSWINDOW            0x0002
523 #define IMN_CHANGECANDIDATE             0x0003
524 #define IMN_CLOSECANDIDATE              0x0004
525 #define IMN_OPENCANDIDATE               0x0005
526 #define IMN_SETCONVERSIONMODE           0x0006
527 #define IMN_SETSENTENCEMODE             0x0007
528 #define IMN_SETOPENSTATUS               0x0008
529 #define IMN_SETCANDIDATEPOS             0x0009
530 #define IMN_SETCOMPOSITIONFONT          0x000A
531 #define IMN_SETCOMPOSITIONWINDOW        0x000B
532 #define IMN_SETSTATUSWINDOWPOS          0x000C
533 #define IMN_GUIDELINE                   0x000D
534 #define IMN_PRIVATE                     0x000E
535 
536 
537 /* wParam of report message WM_IME_REQUEST */
538 #define IMR_COMPOSITIONWINDOW		0x0001
539 #define IMR_CANDIDATEWINDOW		0x0002
540 #define IMR_COMPOSITIONFONT		0x0003
541 #define IMR_RECONVERTSTRING		0x0004
542 #define IMR_CONFIRMRECONVERTSTRING	0x0005
543 #define IMR_QUERYCHARPOSITION		0x0006
544 #define IMR_DOCUMENTFEED		0x0007
545 
546 
547 /* error code of ImmGetCompositionString */
548 #define IMM_ERROR_NODATA                (-1)
549 #define IMM_ERROR_GENERAL               (-2)
550 
551 
552 /* dialog mode of ImmConfigureIME */
553 #define IME_CONFIG_GENERAL              1
554 #define IME_CONFIG_REGISTERWORD         2
555 #define IME_CONFIG_SELECTDICTIONARY     3
556 
557 /* dialog mode of ImmEscape */
558 #define IME_ESC_QUERY_SUPPORT           0x0003
559 #define IME_ESC_RESERVED_FIRST          0x0004
560 #define IME_ESC_RESERVED_LAST           0x07FF
561 #define IME_ESC_PRIVATE_FIRST           0x0800
562 #define IME_ESC_PRIVATE_LAST            0x0FFF
563 #define IME_ESC_SEQUENCE_TO_INTERNAL    0x1001
564 #define IME_ESC_GET_EUDC_DICTIONARY     0x1003
565 #define IME_ESC_SET_EUDC_DICTIONARY     0x1004
566 #define IME_ESC_MAX_KEY                 0x1005
567 #define IME_ESC_IME_NAME                0x1006
568 #define IME_ESC_SYNC_HOTKEY             0x1007
569 #define IME_ESC_HANJA_MODE              0x1008
570 #define IME_ESC_AUTOMATA                0x1009
571 #define IME_ESC_PRIVATE_HOTKEY          0x100a
572 #define IME_ESC_GETHELPFILENAME		0x100b
573 
574 
575 /* style of word registration */
576 #define IME_REGWORD_STYLE_EUDC          0x00000001
577 #define IME_REGWORD_STYLE_USER_FIRST    0x80000000
578 #define IME_REGWORD_STYLE_USER_LAST     0xFFFFFFFF
579 
580 /* dwFlags for ImmAssociateContextEx */
581 #define IACE_CHILDREN           0x0001
582 #define IACE_DEFAULT            0x0010
583 #define IACE_IGNORENOCONTEXT    0x0020
584 
585 /* dwFlags for ImmGetImeMenuItems */
586 #define IGIMIF_RIGHTMENU		0x0001
587 
588 /* dwType for ImmGetImeMenuItems */
589 #define IGIMII_CMODE			0x0001
590 #define IGIMII_SMODE			0x0002
591 #define IGIMII_CONFIGURE		0x0004
592 #define IGIMII_TOOLS			0x0008
593 #define IGIMII_HELP			0x0010
594 #define IGIMII_OTHER			0x0020
595 #define IGIMII_INPUTTOOLS		0x0040
596 
597 /* fType of IMEMENUITEMINFO structure */
598 #define IMFT_RADIOCHECK			0x00001
599 #define IMFT_SEPARATOR			0x00002
600 #define IMFT_SUBMENU			0x00004
601 
602 /* fState of IMEMENUITEMINFO structure */
603 #define IMFS_GRAYED			MFS_GRAYED
604 #define IMFS_DISABLED			MFS_DISABLED
605 #define IMFS_CHECKED			MFS_CHECKED
606 #define IMFS_HILITE			MFS_HILITE
607 #define IMFS_ENABLED			MFS_ENABLED
608 #define IMFS_UNCHECKED			MFS_UNCHECKED
609 #define IMFS_UNHILITE			MFS_UNHILITE
610 #define IMFS_DEFAULT			MFS_DEFAULT
611 
612 
613 /*
614  * type of soft keyboard
615  * for Windows Tranditional Chinese Edition
616  */
617 #define SOFTKEYBOARD_TYPE_T1            0x0001
618 /* for Windows Simplified Chinese Edition */
619 #define SOFTKEYBOARD_TYPE_C1            0x0002
620 
621 
622 HIMC WINAPI ImmAssociateContext(_In_ HWND, _In_ HIMC);
623 BOOL WINAPI ImmAssociateContextEx(_In_ HWND, _In_ HIMC, _In_ DWORD);
624 
625 BOOL WINAPI ImmConfigureIMEA(_In_ HKL, _In_ HWND, _In_ DWORD, _In_ LPVOID);
626 BOOL WINAPI ImmConfigureIMEW(_In_ HKL, _In_ HWND, _In_ DWORD, _In_ LPVOID);
627 #define ImmConfigureIME WINELIB_NAME_AW(ImmConfigureIME)
628 
629 HIMC WINAPI ImmCreateContext(void);
630 BOOL WINAPI ImmSetActiveContext(HWND hwnd, HIMC hIMC, BOOL fFlag);
631 BOOL WINAPI ImmDestroyContext(_In_ HIMC hIMC);
632 BOOL WINAPI ImmDisableIME(_In_ DWORD idThread);
633 BOOL WINAPI ImmEnumInputContext(_In_ DWORD, _In_ IMCENUMPROC, _In_ LPARAM);
634 BOOL WINAPI ImmLoadIME(HKL hKL);
635 BOOL WINAPI CtfImmIsTextFrameServiceDisabled(VOID);
636 
637 UINT
638 WINAPI
639 ImmEnumRegisterWordA(
640   _In_ HKL,
641   _In_ REGISTERWORDENUMPROCA,
642   _In_opt_ LPCSTR lpszReading,
643   _In_ DWORD,
644   _In_opt_ LPCSTR lpszRegister,
645   _In_ LPVOID);
646 
647 UINT
648 WINAPI
649 ImmEnumRegisterWordW(
650   _In_ HKL,
651   _In_ REGISTERWORDENUMPROCW,
652   _In_opt_ LPCWSTR lpszReading,
653   _In_ DWORD,
654   _In_opt_ LPCWSTR lpszRegister,
655   _In_ LPVOID);
656 
657 #define ImmEnumRegisterWord WINELIB_NAME_AW(ImmEnumRegisterWord)
658 
659 LRESULT WINAPI ImmEscapeA(_In_ HKL, _In_ HIMC, _In_ UINT, _In_ LPVOID);
660 LRESULT WINAPI ImmEscapeW(_In_ HKL, _In_ HIMC, _In_ UINT, _In_ LPVOID);
661 #define ImmEscape WINELIB_NAME_AW(ImmEscape)
662 
663 DWORD
664 WINAPI
665 ImmGetCandidateListA(
666   _In_ HIMC,
667   _In_ DWORD deIndex,
668   _Out_writes_bytes_opt_(dwBufLen) LPCANDIDATELIST lpCandList,
669   _In_ DWORD dwBufLen);
670 
671 DWORD
672 WINAPI
673 ImmGetCandidateListW(
674   _In_ HIMC,
675   _In_ DWORD deIndex,
676   _Out_writes_bytes_opt_(dwBufLen) LPCANDIDATELIST lpCandList,
677   _In_ DWORD dwBufLen);
678 
679 #define ImmGetCandidateList WINELIB_NAME_AW(ImmGetCandidateList)
680 
681 DWORD WINAPI ImmGetCandidateListCountA(_In_ HIMC, _Out_ LPDWORD);
682 DWORD WINAPI ImmGetCandidateListCountW(_In_ HIMC, _Out_ LPDWORD);
683 #define ImmGetCandidateListCount WINELIB_NAME_AW(ImmGetCandidateListCount)
684 
685 BOOL
686 WINAPI
687 ImmGetCandidateWindow(
688   _In_ HIMC,
689   _In_ DWORD,
690   _Out_ LPCANDIDATEFORM lpCandidate);
691 
692 #if defined(_WINGDI_) && !defined(NOGDI)
693 
694 BOOL WINAPI ImmGetCompositionFontA(_In_ HIMC, _Out_ LPLOGFONTA);
695 BOOL WINAPI ImmGetCompositionFontW(_In_ HIMC, _Out_ LPLOGFONTW);
696 #define ImmGetCompositionFont WINELIB_NAME_AW(ImmGetCompositionFont)
697 
698 BOOL WINAPI ImmSetCompositionFontA(_In_ HIMC, _In_ LPLOGFONTA);
699 BOOL WINAPI ImmSetCompositionFontW(_In_ HIMC, _In_ LPLOGFONTW);
700 #define ImmSetCompositionFont WINELIB_NAME_AW(ImmSetCompositionFont)
701 
702 #endif
703 
704 LONG
705 WINAPI
706 ImmGetCompositionStringA(
707   _In_ HIMC,
708   _In_ DWORD,
709   _Out_writes_bytes_opt_(dwBufLen) LPVOID lpBuf,
710   _In_ DWORD dwBufLen);
711 
712 LONG
713 WINAPI
714 ImmGetCompositionStringW(
715   _In_ HIMC,
716   _In_ DWORD,
717   _Out_writes_bytes_opt_(dwBufLen) LPVOID lpBuf,
718   _In_ DWORD dwBufLen);
719 
720 #define ImmGetCompositionString WINELIB_NAME_AW(ImmGetCompositionString)
721 
722 BOOL WINAPI ImmGetCompositionWindow(_In_ HIMC, _Out_ LPCOMPOSITIONFORM);
723 HIMC WINAPI ImmGetContext(_In_ HWND);
724 
725 DWORD
726 WINAPI
727 ImmGetConversionListA(
728   _In_ HKL,
729   _In_ HIMC,
730   _In_ LPCSTR lpSrc,
731   _Out_writes_bytes_(dwBufLen) LPCANDIDATELIST lpDst,
732   _In_ DWORD dwBufLen,
733   _In_ UINT uFlag);
734 
735 DWORD
736 WINAPI
737 ImmGetConversionListW(
738   _In_ HKL,
739   _In_ HIMC,
740   _In_ LPCWSTR lpSrc,
741   _Out_writes_bytes_(dwBufLen) LPCANDIDATELIST lpDst,
742   _In_ DWORD dwBufLen,
743   _In_ UINT uFlag);
744 
745 #define ImmGetConversionList WINELIB_NAME_AW(ImmGetConversionList)
746 
747 BOOL
748 WINAPI
749 ImmGetConversionStatus(
750   _In_ HIMC,
751   _Out_opt_ LPDWORD lpfdwConversion,
752   _Out_opt_ LPDWORD lpfdwSentence);
753 
754 HWND WINAPI ImmGetDefaultIMEWnd(_In_ HWND);
755 
756 UINT
757 WINAPI
758 ImmGetDescriptionA(
759   _In_ HKL,
760   _Out_writes_opt_(uBufLen) LPSTR lpszDescription,
761   _In_ UINT uBufLen);
762 
763 UINT
764 WINAPI
765 ImmGetDescriptionW(
766   _In_ HKL,
767   _Out_writes_opt_(uBufLen) LPWSTR lpszDescription,
768   _In_ UINT uBufLen);
769 
770 #define ImmGetDescription WINELIB_NAME_AW(ImmGetDescription)
771 
772 DWORD
773 WINAPI
774 ImmGetGuideLineA(
775   _In_ HIMC,
776   _In_ DWORD dwIndex,
777   _Out_writes_bytes_opt_(dwBufLen) LPSTR lpBuf,
778   _In_ DWORD dwBufLen);
779 
780 DWORD
781 WINAPI
782 ImmGetGuideLineW(
783   _In_ HIMC,
784   _In_ DWORD dwIndex,
785   _Out_writes_bytes_opt_(dwBufLen) LPWSTR lpBuf,
786   _In_ DWORD dwBufLen);
787 
788 #define ImmGetGuideLine WINELIB_NAME_AW(ImmGetGuideLine)
789 
790 UINT
791 WINAPI
792 ImmGetIMEFileNameA(
793   _In_ HKL,
794   _Out_writes_opt_(uBufLen) LPSTR lpszFileName,
795   _In_ UINT uBufLen);
796 
797 UINT
798 WINAPI
799 ImmGetIMEFileNameW(
800   _In_ HKL,
801   _Out_writes_opt_(uBufLen) LPWSTR lpszFileName,
802   _In_ UINT uBufLen);
803 
804 #define ImmGetIMEFileName WINELIB_NAME_AW(ImmGetIMEFileName)
805 
806 DWORD
807 WINAPI
808 ImmGetImeMenuItemsA(
809   _In_ HIMC,
810   _In_ DWORD,
811   _In_ DWORD,
812   _Out_opt_ LPIMEMENUITEMINFOA lpImeParentMenu,
813   _Out_writes_bytes_opt_(dwSize) LPIMEMENUITEMINFOA lpImeMenu,
814   _In_ DWORD dwSize);
815 
816 DWORD
817 WINAPI
818 ImmGetImeMenuItemsW(
819   _In_ HIMC,
820   _In_ DWORD,
821   _In_ DWORD,
822   _Out_opt_ LPIMEMENUITEMINFOW lpImeParentMenu,
823   _Out_writes_bytes_opt_(dwSize) LPIMEMENUITEMINFOW lpImeMenu,
824   _In_ DWORD dwSize);
825 
826 #define ImmGetImeMenuItems WINELIB_NAME_AW(ImmGetImeMenuItems)
827 
828 BOOL WINAPI ImmGetOpenStatus(_In_ HIMC);
829 DWORD WINAPI ImmGetProperty(_In_ HKL, _In_ DWORD);
830 
831 UINT
832 WINAPI
833 ImmGetRegisterWordStyleA(
834   _In_ HKL,
835   _In_ UINT nItem,
836   _Out_writes_(nItem) LPSTYLEBUFA lpStyleBuf);
837 
838 UINT
839 WINAPI
840 ImmGetRegisterWordStyleW(
841   _In_ HKL,
842   _In_ UINT nItem,
843   _Out_writes_(nItem) LPSTYLEBUFW lpStyleBuf);
844 
845 #define ImmGetRegisterWordStyle WINELIB_NAME_AW(ImmGetRegisterWordStyle)
846 
847 BOOL WINAPI ImmGetStatusWindowPos(_In_ HIMC, _Out_ LPPOINT);
848 UINT WINAPI ImmGetVirtualKey(_In_ HWND);
849 
850 HKL WINAPI ImmInstallIMEA(_In_ LPCSTR, _In_ LPCSTR);
851 HKL WINAPI ImmInstallIMEW(_In_ LPCWSTR, _In_ LPCWSTR);
852 #define ImmInstallIME WINELIB_NAME_AW(ImmInstallIME)
853 
854 BOOL WINAPI ImmIsIME(_In_ HKL);
855 
856 BOOL WINAPI ImmIsUIMessageA(_In_ HWND, _In_ UINT, _In_ WPARAM, _In_ LPARAM);
857 BOOL WINAPI ImmIsUIMessageW(_In_ HWND, _In_ UINT, _In_ WPARAM, _In_ LPARAM);
858 #define ImmIsUIMessage WINELIB_NAME_AW(ImmIsUIMessage)
859 
860 BOOL WINAPI ImmNotifyIME(_In_ HIMC, _In_ DWORD, _In_ DWORD, _In_ DWORD);
861 
862 DWORD WINAPI ImmProcessKey(HWND, HKL, UINT, LPARAM, DWORD);
863 
864 BOOL
865 WINAPI
866 ImmRegisterWordA(
867   _In_ HKL,
868   _In_ LPCSTR lpszReading,
869   _In_ DWORD,
870   _In_ LPCSTR lpszRegister);
871 
872 BOOL
873 WINAPI
874 ImmRegisterWordW(
875   _In_ HKL,
876   _In_ LPCWSTR lpszReading,
877   _In_ DWORD,
878   _In_ LPCWSTR lpszRegister);
879 
880 #define ImmRegisterWord WINELIB_NAME_AW(ImmRegisterWord)
881 
882 BOOL WINAPI ImmReleaseContext(_In_ HWND, _In_ HIMC);
883 BOOL WINAPI ImmSetCandidateWindow(_In_ HIMC, _In_ LPCANDIDATEFORM);
884 
885 BOOL
886 WINAPI
887 ImmSetCompositionStringA(
888   _In_ HIMC,
889   _In_ DWORD dwIndex,
890   _Inout_updates_bytes_opt_(dwCompLen) LPVOID lpComp,
891   _In_ DWORD dwCompLen,
892   _Inout_updates_bytes_opt_(dwReadLen) LPVOID lpRead,
893   _In_ DWORD dwReadLen);
894 
895 BOOL
896 WINAPI
897 ImmSetCompositionStringW(
898   _In_ HIMC,
899   _In_ DWORD dwIndex,
900   _Inout_updates_bytes_opt_(dwCompLen) LPVOID lpComp,
901   _In_ DWORD dwCompLen,
902   _Inout_updates_bytes_opt_(dwReadLen) LPVOID lpRead,
903   _In_ DWORD dwReadLen);
904 
905 #define ImmSetCompositionString WINELIB_NAME_AW(ImmSetCompositionString)
906 
907 BOOL WINAPI ImmSetCompositionWindow(_In_ HIMC, _In_ LPCOMPOSITIONFORM);
908 BOOL WINAPI ImmSetConversionStatus(_In_ HIMC, _In_ DWORD, _In_ DWORD);
909 BOOL WINAPI ImmSetOpenStatus(_In_ HIMC, _In_ BOOL);
910 BOOL WINAPI ImmSetStatusWindowPos(_In_ HIMC, _In_ LPPOINT);
911 BOOL WINAPI ImmSimulateHotKey(_In_ HWND, _In_ DWORD);
912 
913 BOOL
914 WINAPI
915 ImmUnregisterWordA(
916   _In_ HKL,
917   _In_ LPCSTR lpszReading,
918   _In_ DWORD,
919   _In_ LPCSTR lpszUnregister);
920 
921 BOOL
922 WINAPI
923 ImmUnregisterWordW(
924   _In_ HKL,
925   _In_ LPCWSTR lpszReading,
926   _In_ DWORD,
927   _In_ LPCWSTR lpszUnregister);
928 
929 #define ImmUnregisterWord WINELIB_NAME_AW(ImmUnregisterWord)
930 
931 
932 #ifdef __cplusplus
933 }
934 #endif
935 
936 #endif  /* __WINE_IMM_H */
937