xref: /reactos/sdk/include/psdk/imm.h (revision f74a2aac)
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 
257 HWND WINAPI
258 ImmCreateSoftKeyboard(
259     _In_ UINT uType,
260     _In_ HWND hwndParent,
261     _In_ INT x,
262     _In_ INT y);
263 
264 BOOL WINAPI
265 ImmShowSoftKeyboard(
266     _In_ HWND hwndSoftKBD,
267     _In_ INT nCmdShow);
268 
269 BOOL WINAPI
270 ImmDestroySoftKeyboard(
271     _In_ HWND hwndSoftKBD);
272 
273 /* wParam for WM_IME_CONTROL */
274 #define IMC_GETCANDIDATEPOS             0x0007
275 #define IMC_SETCANDIDATEPOS             0x0008
276 #define IMC_GETCOMPOSITIONFONT          0x0009
277 #define IMC_SETCOMPOSITIONFONT          0x000A
278 #define IMC_GETCOMPOSITIONWINDOW        0x000B
279 #define IMC_SETCOMPOSITIONWINDOW        0x000C
280 #define IMC_GETSTATUSWINDOWPOS          0x000F
281 #define IMC_SETSTATUSWINDOWPOS          0x0010
282 #define IMC_CLOSESTATUSWINDOW           0x0021
283 #define IMC_OPENSTATUSWINDOW            0x0022
284 
285 /*
286  * wParam for WM_IME_CONTROL to the soft keyboard
287  * dwAction for ImmNotifyIME
288  */
289 #define NI_OPENCANDIDATE                0x0010
290 #define NI_CLOSECANDIDATE               0x0011
291 #define NI_SELECTCANDIDATESTR           0x0012
292 #define NI_CHANGECANDIDATELIST          0x0013
293 #define NI_FINALIZECONVERSIONRESULT     0x0014
294 #define NI_COMPOSITIONSTR               0x0015
295 #define NI_SETCANDIDATE_PAGESTART       0x0016
296 #define NI_SETCANDIDATE_PAGESIZE        0x0017
297 #define NI_IMEMENUSELECTED		0x0018
298 
299 /* lParam for WM_IME_SETCONTEXT */
300 #define ISC_SHOWUICANDIDATEWINDOW       0x00000001
301 #define ISC_SHOWUICOMPOSITIONWINDOW     0x80000000
302 #define ISC_SHOWUIGUIDELINE             0x40000000
303 #define ISC_SHOWUIALLCANDIDATEWINDOW    0x0000000F
304 #define ISC_SHOWUIALL                   0xC000000F
305 
306 
307 /* dwIndex for ImmNotifyIME/NI_COMPOSITIONSTR */
308 #define CPS_COMPLETE                    0x0001
309 #define CPS_CONVERT                     0x0002
310 #define CPS_REVERT                      0x0003
311 #define CPS_CANCEL                      0x0004
312 
313 
314 /* the modifiers of hot key */
315 #define MOD_ALT                         0x0001
316 #define MOD_CONTROL                     0x0002
317 #define MOD_SHIFT                       0x0004
318 
319 #define MOD_LEFT                        0x8000
320 #define MOD_RIGHT                       0x4000
321 
322 #define MOD_ON_KEYUP                    0x0800
323 #define MOD_IGNORE_ALL_MODIFIER         0x0400
324 
325 
326 /* Windows for Simplified Chinese Edition hot key ID from 0x10 - 0x2F */
327 #define IME_CHOTKEY_IME_NONIME_TOGGLE           0x10
328 #define IME_CHOTKEY_SHAPE_TOGGLE                0x11
329 #define IME_CHOTKEY_SYMBOL_TOGGLE               0x12
330 
331 /* Windows for Japanese Edition hot key ID from 0x30 - 0x4F */
332 #define IME_JHOTKEY_CLOSE_OPEN                  0x30
333 
334 /* Windows for Korean Edition hot key ID from 0x50 - 0x6F */
335 #define IME_KHOTKEY_SHAPE_TOGGLE                0x50
336 #define IME_KHOTKEY_HANJACONVERT                0x51
337 #define IME_KHOTKEY_ENGLISH                     0x52
338 /* Windows for Tranditional Chinese Edition hot key ID from 0x70 - 0x8F */
339 #define IME_THOTKEY_IME_NONIME_TOGGLE           0x70
340 #define IME_THOTKEY_SHAPE_TOGGLE                0x71
341 #define IME_THOTKEY_SYMBOL_TOGGLE               0x72
342 
343 /* direct switch hot key ID from 0x100 - 0x11F */
344 #define IME_HOTKEY_DSWITCH_FIRST                0x100
345 #define IME_HOTKEY_DSWITCH_LAST                 0x11F
346 
347 /* IME private hot key from 0x200 - 0x21F */
348 #define IME_HOTKEY_PRIVATE_FIRST                0x200
349 #define IME_ITHOTKEY_RESEND_RESULTSTR           0x200
350 #define IME_ITHOTKEY_PREVIOUS_COMPOSITION       0x201
351 #define IME_ITHOTKEY_UISTYLE_TOGGLE             0x202
352 #define IME_ITHOTKEY_RECONVERTSTRING		0x203
353 #define IME_HOTKEY_PRIVATE_LAST                 0x21F
354 
355 
356 /*
357  * dwSystemInfoFlags bits
358  * parameter of ImmGetCompositionString
359  */
360 #define GCS_COMPREADSTR                 0x0001
361 #define GCS_COMPREADATTR                0x0002
362 #define GCS_COMPREADCLAUSE              0x0004
363 #define GCS_COMPSTR                     0x0008
364 #define GCS_COMPATTR                    0x0010
365 #define GCS_COMPCLAUSE                  0x0020
366 #define GCS_CURSORPOS                   0x0080
367 #define GCS_DELTASTART                  0x0100
368 #define GCS_RESULTREADSTR               0x0200
369 #define GCS_RESULTREADCLAUSE            0x0400
370 #define GCS_RESULTSTR                   0x0800
371 #define GCS_RESULTCLAUSE                0x1000
372 
373 /* style bit flags for WM_IME_COMPOSITION */
374 #define CS_INSERTCHAR                   0x2000
375 #define CS_NOMOVECARET                  0x4000
376 
377 
378 /*
379  * bits of fdwInit of INPUTCONTEXT
380  * IME version constants
381  */
382 #define IMEVER_0310                     0x0003000A
383 #define IMEVER_0400                     0x00040000
384 
385 /* IME property bits */
386 #define IME_PROP_AT_CARET               0x00010000
387 #define IME_PROP_SPECIAL_UI             0x00020000
388 #define IME_PROP_CANDLIST_START_FROM_1  0x00040000
389 #define IME_PROP_UNICODE                0x00080000
390 #define IME_PROP_COMPLETE_ON_UNSELECT	0x00100000
391 
392 /* IME UICapability bits */
393 #define UI_CAP_2700                     0x00000001
394 #define UI_CAP_ROT90                    0x00000002
395 #define UI_CAP_ROTANY                   0x00000004
396 #define UI_CAP_SOFTKBD                  0x00010000
397 
398 /* ImmSetCompositionString Capability bits */
399 #define SCS_CAP_COMPSTR                 0x00000001
400 #define SCS_CAP_MAKEREAD                0x00000002
401 #define SCS_CAP_SETRECONVERTSTRING	0x00000004
402 
403 /* IME WM_IME_SELECT inheritance Capability bits */
404 #define SELECT_CAP_CONVERSION           0x00000001
405 #define SELECT_CAP_SENTENCE             0x00000002
406 
407 
408 /* ID for deIndex of ImmGetGuideLine */
409 #define GGL_LEVEL                       0x00000001
410 #define GGL_INDEX                       0x00000002
411 #define GGL_STRING                      0x00000003
412 #define GGL_PRIVATE                     0x00000004
413 
414 /* ID for dwLevel of GUIDELINE Structure */
415 #define GL_LEVEL_NOGUIDELINE            0x00000000
416 #define GL_LEVEL_FATAL                  0x00000001
417 #define GL_LEVEL_ERROR                  0x00000002
418 #define GL_LEVEL_WARNING                0x00000003
419 #define GL_LEVEL_INFORMATION            0x00000004
420 
421 /* ID for dwIndex of GUIDELINE Structure */
422 #define GL_ID_UNKNOWN                   0x00000000
423 #define GL_ID_NOMODULE                  0x00000001
424 #define GL_ID_NODICTIONARY              0x00000010
425 #define GL_ID_CANNOTSAVE                0x00000011
426 #define GL_ID_NOCONVERT                 0x00000020
427 #define GL_ID_TYPINGERROR               0x00000021
428 #define GL_ID_TOOMANYSTROKE             0x00000022
429 #define GL_ID_READINGCONFLICT           0x00000023
430 #define GL_ID_INPUTREADING              0x00000024
431 #define GL_ID_INPUTRADICAL              0x00000025
432 #define GL_ID_INPUTCODE                 0x00000026
433 #define GL_ID_INPUTSYMBOL               0x00000027
434 #define GL_ID_CHOOSECANDIDATE           0x00000028
435 #define GL_ID_REVERSECONVERSION         0x00000029
436 #define GL_ID_PRIVATE_FIRST             0x00008000
437 #define GL_ID_PRIVATE_LAST              0x0000FFFF
438 
439 /* ID for dwIndex of ImmGetProperty */
440 #define IGP_GETIMEVERSION               (DWORD)(-4)
441 #define IGP_PROPERTY                    0x00000004
442 #define IGP_CONVERSION                  0x00000008
443 #define IGP_SENTENCE                    0x0000000c
444 #define IGP_UI                          0x00000010
445 #define IGP_SETCOMPSTR                  0x00000014
446 #define IGP_SELECT                      0x00000018
447 
448 
449 /* dwIndex for ImmSetCompositionString API */
450 #define SCS_SETSTR          (GCS_COMPREADSTR|GCS_COMPSTR)
451 #define SCS_CHANGEATTR      (GCS_COMPREADATTR|GCS_COMPATTR)
452 #define SCS_CHANGECLAUSE    (GCS_COMPREADCLAUSE|GCS_COMPCLAUSE)
453 #define SCS_SETRECONVERTSTRING		0x00010000
454 #define SCS_QUERYRECONVERTSTRING	0x00020000
455 
456 /* attribute for COMPOSITIONSTRING Structure */
457 #define ATTR_INPUT                      0x00
458 #define ATTR_TARGET_CONVERTED           0x01
459 #define ATTR_CONVERTED                  0x02
460 #define ATTR_TARGET_NOTCONVERTED        0x03
461 #define ATTR_INPUT_ERROR                0x04
462 #define ATTR_FIXEDCONVERTED		0x05
463 
464 
465 /* bit field for IMC_SETCOMPOSITIONWINDOW, IMC_SETCANDIDATEWINDOW */
466 #define CFS_DEFAULT                     0x0000
467 #define CFS_RECT                        0x0001
468 #define CFS_POINT                       0x0002
469 #define CFS_FORCE_POSITION              0x0020
470 #define CFS_CANDIDATEPOS                0x0040
471 #define CFS_EXCLUDE                     0x0080
472 
473 /* conversion direction for ImmGetConversionList */
474 #define GCL_CONVERSION                  0x0001
475 #define GCL_REVERSECONVERSION           0x0002
476 #define GCL_REVERSE_LENGTH              0x0003
477 
478 
479 /* bit field for conversion mode */
480 #define IME_CMODE_ALPHANUMERIC          0x0000
481 #define IME_CMODE_NATIVE                0x0001
482 #define IME_CMODE_CHINESE               IME_CMODE_NATIVE
483 /* IME_CMODE_HANGEUL is old name of IME_CMODE_HANGUL. It will be gone eventually. */
484 #define IME_CMODE_HANGEUL               IME_CMODE_NATIVE
485 #define IME_CMODE_HANGUL                IME_CMODE_NATIVE
486 #define IME_CMODE_JAPANESE              IME_CMODE_NATIVE
487 #define IME_CMODE_KATAKANA              0x0002  /* only effect under IME_CMODE_NATIVE */
488 #define IME_CMODE_LANGUAGE              0x0003
489 #define IME_CMODE_FULLSHAPE             0x0008
490 #define IME_CMODE_ROMAN                 0x0010
491 #define IME_CMODE_CHARCODE              0x0020
492 #define IME_CMODE_HANJACONVERT          0x0040
493 #define IME_CMODE_SOFTKBD               0x0080
494 #define IME_CMODE_NOCONVERSION          0x0100
495 #define IME_CMODE_EUDC                  0x0200
496 #define IME_CMODE_SYMBOL                0x0400
497 #define IME_CMODE_FIXED			0x0800
498 
499 
500 #define IME_SMODE_NONE                  0x0000
501 #define IME_SMODE_PLAURALCLAUSE         0x0001
502 #define IME_SMODE_SINGLECONVERT         0x0002
503 #define IME_SMODE_AUTOMATIC             0x0004
504 #define IME_SMODE_PHRASEPREDICT         0x0008
505 #define IME_SMODE_CONVERSATION		0x0010
506 
507 /* style of candidate */
508 #define IME_CAND_UNKNOWN                0x0000
509 #define IME_CAND_READ                   0x0001
510 #define IME_CAND_CODE                   0x0002
511 #define IME_CAND_MEANING                0x0003
512 #define IME_CAND_RADICAL                0x0004
513 #define IME_CAND_STROKE                 0x0005
514 
515 
516 /* wParam of report message WM_IME_NOTIFY */
517 #define IMN_CLOSESTATUSWINDOW           0x0001
518 #define IMN_OPENSTATUSWINDOW            0x0002
519 #define IMN_CHANGECANDIDATE             0x0003
520 #define IMN_CLOSECANDIDATE              0x0004
521 #define IMN_OPENCANDIDATE               0x0005
522 #define IMN_SETCONVERSIONMODE           0x0006
523 #define IMN_SETSENTENCEMODE             0x0007
524 #define IMN_SETOPENSTATUS               0x0008
525 #define IMN_SETCANDIDATEPOS             0x0009
526 #define IMN_SETCOMPOSITIONFONT          0x000A
527 #define IMN_SETCOMPOSITIONWINDOW        0x000B
528 #define IMN_SETSTATUSWINDOWPOS          0x000C
529 #define IMN_GUIDELINE                   0x000D
530 #define IMN_PRIVATE                     0x000E
531 
532 
533 /* wParam of report message WM_IME_REQUEST */
534 #define IMR_COMPOSITIONWINDOW		0x0001
535 #define IMR_CANDIDATEWINDOW		0x0002
536 #define IMR_COMPOSITIONFONT		0x0003
537 #define IMR_RECONVERTSTRING		0x0004
538 #define IMR_CONFIRMRECONVERTSTRING	0x0005
539 #define IMR_QUERYCHARPOSITION		0x0006
540 #define IMR_DOCUMENTFEED		0x0007
541 
542 
543 /* error code of ImmGetCompositionString */
544 #define IMM_ERROR_NODATA                (-1)
545 #define IMM_ERROR_GENERAL               (-2)
546 
547 
548 /* dialog mode of ImmConfigureIME */
549 #define IME_CONFIG_GENERAL              1
550 #define IME_CONFIG_REGISTERWORD         2
551 #define IME_CONFIG_SELECTDICTIONARY     3
552 
553 /* dialog mode of ImmEscape */
554 #define IME_ESC_QUERY_SUPPORT           0x0003
555 #define IME_ESC_RESERVED_FIRST          0x0004
556 #define IME_ESC_RESERVED_LAST           0x07FF
557 #define IME_ESC_PRIVATE_FIRST           0x0800
558 #define IME_ESC_PRIVATE_LAST            0x0FFF
559 #define IME_ESC_SEQUENCE_TO_INTERNAL    0x1001
560 #define IME_ESC_GET_EUDC_DICTIONARY     0x1003
561 #define IME_ESC_SET_EUDC_DICTIONARY     0x1004
562 #define IME_ESC_MAX_KEY                 0x1005
563 #define IME_ESC_IME_NAME                0x1006
564 #define IME_ESC_SYNC_HOTKEY             0x1007
565 #define IME_ESC_HANJA_MODE              0x1008
566 #define IME_ESC_AUTOMATA                0x1009
567 #define IME_ESC_PRIVATE_HOTKEY          0x100a
568 #define IME_ESC_GETHELPFILENAME		0x100b
569 
570 
571 /* style of word registration */
572 #define IME_REGWORD_STYLE_EUDC          0x00000001
573 #define IME_REGWORD_STYLE_USER_FIRST    0x80000000
574 #define IME_REGWORD_STYLE_USER_LAST     0xFFFFFFFF
575 
576 /* dwFlags for ImmAssociateContextEx */
577 #define IACE_CHILDREN           0x0001
578 #define IACE_DEFAULT            0x0010
579 #define IACE_IGNORENOCONTEXT    0x0020
580 
581 /* dwFlags for ImmGetImeMenuItems */
582 #define IGIMIF_RIGHTMENU		0x0001
583 
584 /* dwType for ImmGetImeMenuItems */
585 #define IGIMII_CMODE			0x0001
586 #define IGIMII_SMODE			0x0002
587 #define IGIMII_CONFIGURE		0x0004
588 #define IGIMII_TOOLS			0x0008
589 #define IGIMII_HELP			0x0010
590 #define IGIMII_OTHER			0x0020
591 #define IGIMII_INPUTTOOLS		0x0040
592 
593 /* fType of IMEMENUITEMINFO structure */
594 #define IMFT_RADIOCHECK			0x00001
595 #define IMFT_SEPARATOR			0x00002
596 #define IMFT_SUBMENU			0x00004
597 
598 /* fState of IMEMENUITEMINFO structure */
599 #define IMFS_GRAYED			MFS_GRAYED
600 #define IMFS_DISABLED			MFS_DISABLED
601 #define IMFS_CHECKED			MFS_CHECKED
602 #define IMFS_HILITE			MFS_HILITE
603 #define IMFS_ENABLED			MFS_ENABLED
604 #define IMFS_UNCHECKED			MFS_UNCHECKED
605 #define IMFS_UNHILITE			MFS_UNHILITE
606 #define IMFS_DEFAULT			MFS_DEFAULT
607 
608 
609 /*
610  * type of soft keyboard
611  * for Windows Tranditional Chinese Edition
612  */
613 #define SOFTKEYBOARD_TYPE_T1            0x0001
614 /* for Windows Simplified Chinese Edition */
615 #define SOFTKEYBOARD_TYPE_C1            0x0002
616 
617 
618 HIMC WINAPI ImmAssociateContext(_In_ HWND, _In_ HIMC);
619 BOOL WINAPI ImmAssociateContextEx(_In_ HWND, _In_ HIMC, _In_ DWORD);
620 
621 BOOL WINAPI ImmConfigureIMEA(_In_ HKL, _In_ HWND, _In_ DWORD, _In_ LPVOID);
622 BOOL WINAPI ImmConfigureIMEW(_In_ HKL, _In_ HWND, _In_ DWORD, _In_ LPVOID);
623 #define ImmConfigureIME WINELIB_NAME_AW(ImmConfigureIME)
624 
625 HIMC WINAPI ImmCreateContext(void);
626 BOOL WINAPI ImmSetActiveContext(HWND hwnd, HIMC hIMC, BOOL fFlag);
627 BOOL WINAPI ImmDestroyContext(_In_ HIMC hIMC);
628 BOOL WINAPI ImmDisableIME(_In_ DWORD idThread);
629 BOOL WINAPI ImmEnumInputContext(_In_ DWORD, _In_ IMCENUMPROC, _In_ LPARAM);
630 BOOL WINAPI ImmLoadIME(HKL hKL);
631 BOOL WINAPI CtfImmIsTextFrameServiceDisabled(VOID);
632 
633 UINT
634 WINAPI
635 ImmEnumRegisterWordA(
636   _In_ HKL,
637   _In_ REGISTERWORDENUMPROCA,
638   _In_opt_ LPCSTR lpszReading,
639   _In_ DWORD,
640   _In_opt_ LPCSTR lpszRegister,
641   _In_ LPVOID);
642 
643 UINT
644 WINAPI
645 ImmEnumRegisterWordW(
646   _In_ HKL,
647   _In_ REGISTERWORDENUMPROCW,
648   _In_opt_ LPCWSTR lpszReading,
649   _In_ DWORD,
650   _In_opt_ LPCWSTR lpszRegister,
651   _In_ LPVOID);
652 
653 #define ImmEnumRegisterWord WINELIB_NAME_AW(ImmEnumRegisterWord)
654 
655 LRESULT WINAPI ImmEscapeA(_In_ HKL, _In_ HIMC, _In_ UINT, _In_ LPVOID);
656 LRESULT WINAPI ImmEscapeW(_In_ HKL, _In_ HIMC, _In_ UINT, _In_ LPVOID);
657 #define ImmEscape WINELIB_NAME_AW(ImmEscape)
658 
659 DWORD
660 WINAPI
661 ImmGetCandidateListA(
662   _In_ HIMC,
663   _In_ DWORD deIndex,
664   _Out_writes_bytes_opt_(dwBufLen) LPCANDIDATELIST lpCandList,
665   _In_ DWORD dwBufLen);
666 
667 DWORD
668 WINAPI
669 ImmGetCandidateListW(
670   _In_ HIMC,
671   _In_ DWORD deIndex,
672   _Out_writes_bytes_opt_(dwBufLen) LPCANDIDATELIST lpCandList,
673   _In_ DWORD dwBufLen);
674 
675 #define ImmGetCandidateList WINELIB_NAME_AW(ImmGetCandidateList)
676 
677 DWORD WINAPI ImmGetCandidateListCountA(_In_ HIMC, _Out_ LPDWORD);
678 DWORD WINAPI ImmGetCandidateListCountW(_In_ HIMC, _Out_ LPDWORD);
679 #define ImmGetCandidateListCount WINELIB_NAME_AW(ImmGetCandidateListCount)
680 
681 BOOL
682 WINAPI
683 ImmGetCandidateWindow(
684   _In_ HIMC,
685   _In_ DWORD,
686   _Out_ LPCANDIDATEFORM lpCandidate);
687 
688 #if defined(_WINGDI_) && !defined(NOGDI)
689 
690 BOOL WINAPI ImmGetCompositionFontA(_In_ HIMC, _Out_ LPLOGFONTA);
691 BOOL WINAPI ImmGetCompositionFontW(_In_ HIMC, _Out_ LPLOGFONTW);
692 #define ImmGetCompositionFont WINELIB_NAME_AW(ImmGetCompositionFont)
693 
694 BOOL WINAPI ImmSetCompositionFontA(_In_ HIMC, _In_ LPLOGFONTA);
695 BOOL WINAPI ImmSetCompositionFontW(_In_ HIMC, _In_ LPLOGFONTW);
696 #define ImmSetCompositionFont WINELIB_NAME_AW(ImmSetCompositionFont)
697 
698 #endif
699 
700 LONG
701 WINAPI
702 ImmGetCompositionStringA(
703   _In_ HIMC,
704   _In_ DWORD,
705   _Out_writes_bytes_opt_(dwBufLen) LPVOID lpBuf,
706   _In_ DWORD dwBufLen);
707 
708 LONG
709 WINAPI
710 ImmGetCompositionStringW(
711   _In_ HIMC,
712   _In_ DWORD,
713   _Out_writes_bytes_opt_(dwBufLen) LPVOID lpBuf,
714   _In_ DWORD dwBufLen);
715 
716 #define ImmGetCompositionString WINELIB_NAME_AW(ImmGetCompositionString)
717 
718 BOOL WINAPI ImmGetCompositionWindow(_In_ HIMC, _Out_ LPCOMPOSITIONFORM);
719 HIMC WINAPI ImmGetContext(_In_ HWND);
720 
721 DWORD
722 WINAPI
723 ImmGetConversionListA(
724   _In_ HKL,
725   _In_ HIMC,
726   _In_ LPCSTR lpSrc,
727   _Out_writes_bytes_(dwBufLen) LPCANDIDATELIST lpDst,
728   _In_ DWORD dwBufLen,
729   _In_ UINT uFlag);
730 
731 DWORD
732 WINAPI
733 ImmGetConversionListW(
734   _In_ HKL,
735   _In_ HIMC,
736   _In_ LPCWSTR lpSrc,
737   _Out_writes_bytes_(dwBufLen) LPCANDIDATELIST lpDst,
738   _In_ DWORD dwBufLen,
739   _In_ UINT uFlag);
740 
741 #define ImmGetConversionList WINELIB_NAME_AW(ImmGetConversionList)
742 
743 BOOL
744 WINAPI
745 ImmGetConversionStatus(
746   _In_ HIMC,
747   _Out_opt_ LPDWORD lpfdwConversion,
748   _Out_opt_ LPDWORD lpfdwSentence);
749 
750 HWND WINAPI ImmGetDefaultIMEWnd(_In_ HWND);
751 
752 UINT
753 WINAPI
754 ImmGetDescriptionA(
755   _In_ HKL,
756   _Out_writes_opt_(uBufLen) LPSTR lpszDescription,
757   _In_ UINT uBufLen);
758 
759 UINT
760 WINAPI
761 ImmGetDescriptionW(
762   _In_ HKL,
763   _Out_writes_opt_(uBufLen) LPWSTR lpszDescription,
764   _In_ UINT uBufLen);
765 
766 #define ImmGetDescription WINELIB_NAME_AW(ImmGetDescription)
767 
768 DWORD
769 WINAPI
770 ImmGetGuideLineA(
771   _In_ HIMC,
772   _In_ DWORD dwIndex,
773   _Out_writes_bytes_opt_(dwBufLen) LPSTR lpBuf,
774   _In_ DWORD dwBufLen);
775 
776 DWORD
777 WINAPI
778 ImmGetGuideLineW(
779   _In_ HIMC,
780   _In_ DWORD dwIndex,
781   _Out_writes_bytes_opt_(dwBufLen) LPWSTR lpBuf,
782   _In_ DWORD dwBufLen);
783 
784 #define ImmGetGuideLine WINELIB_NAME_AW(ImmGetGuideLine)
785 
786 UINT
787 WINAPI
788 ImmGetIMEFileNameA(
789   _In_ HKL,
790   _Out_writes_opt_(uBufLen) LPSTR lpszFileName,
791   _In_ UINT uBufLen);
792 
793 UINT
794 WINAPI
795 ImmGetIMEFileNameW(
796   _In_ HKL,
797   _Out_writes_opt_(uBufLen) LPWSTR lpszFileName,
798   _In_ UINT uBufLen);
799 
800 #define ImmGetIMEFileName WINELIB_NAME_AW(ImmGetIMEFileName)
801 
802 DWORD
803 WINAPI
804 ImmGetImeMenuItemsA(
805   _In_ HIMC,
806   _In_ DWORD,
807   _In_ DWORD,
808   _Out_opt_ LPIMEMENUITEMINFOA lpImeParentMenu,
809   _Out_writes_bytes_opt_(dwSize) LPIMEMENUITEMINFOA lpImeMenu,
810   _In_ DWORD dwSize);
811 
812 DWORD
813 WINAPI
814 ImmGetImeMenuItemsW(
815   _In_ HIMC,
816   _In_ DWORD,
817   _In_ DWORD,
818   _Out_opt_ LPIMEMENUITEMINFOW lpImeParentMenu,
819   _Out_writes_bytes_opt_(dwSize) LPIMEMENUITEMINFOW lpImeMenu,
820   _In_ DWORD dwSize);
821 
822 #define ImmGetImeMenuItems WINELIB_NAME_AW(ImmGetImeMenuItems)
823 
824 BOOL WINAPI ImmGetOpenStatus(_In_ HIMC);
825 DWORD WINAPI ImmGetProperty(_In_ HKL, _In_ DWORD);
826 
827 UINT
828 WINAPI
829 ImmGetRegisterWordStyleA(
830   _In_ HKL,
831   _In_ UINT nItem,
832   _Out_writes_(nItem) LPSTYLEBUFA lpStyleBuf);
833 
834 UINT
835 WINAPI
836 ImmGetRegisterWordStyleW(
837   _In_ HKL,
838   _In_ UINT nItem,
839   _Out_writes_(nItem) LPSTYLEBUFW lpStyleBuf);
840 
841 #define ImmGetRegisterWordStyle WINELIB_NAME_AW(ImmGetRegisterWordStyle)
842 
843 BOOL WINAPI ImmGetStatusWindowPos(_In_ HIMC, _Out_ LPPOINT);
844 UINT WINAPI ImmGetVirtualKey(_In_ HWND);
845 
846 HKL WINAPI ImmInstallIMEA(_In_ LPCSTR, _In_ LPCSTR);
847 HKL WINAPI ImmInstallIMEW(_In_ LPCWSTR, _In_ LPCWSTR);
848 #define ImmInstallIME WINELIB_NAME_AW(ImmInstallIME)
849 
850 BOOL WINAPI ImmIsIME(_In_ HKL);
851 
852 BOOL WINAPI ImmIsUIMessageA(_In_ HWND, _In_ UINT, _In_ WPARAM, _In_ LPARAM);
853 BOOL WINAPI ImmIsUIMessageW(_In_ HWND, _In_ UINT, _In_ WPARAM, _In_ LPARAM);
854 #define ImmIsUIMessage WINELIB_NAME_AW(ImmIsUIMessage)
855 
856 BOOL WINAPI ImmNotifyIME(_In_ HIMC, _In_ DWORD, _In_ DWORD, _In_ DWORD_PTR);
857 
858 DWORD WINAPI ImmProcessKey(HWND, HKL, UINT, LPARAM, DWORD);
859 
860 BOOL
861 WINAPI
862 ImmRegisterWordA(
863   _In_ HKL,
864   _In_ LPCSTR lpszReading,
865   _In_ DWORD,
866   _In_ LPCSTR lpszRegister);
867 
868 BOOL
869 WINAPI
870 ImmRegisterWordW(
871   _In_ HKL,
872   _In_ LPCWSTR lpszReading,
873   _In_ DWORD,
874   _In_ LPCWSTR lpszRegister);
875 
876 #define ImmRegisterWord WINELIB_NAME_AW(ImmRegisterWord)
877 
878 BOOL WINAPI ImmReleaseContext(_In_ HWND, _In_ HIMC);
879 BOOL WINAPI ImmSetCandidateWindow(_In_ HIMC, _In_ LPCANDIDATEFORM);
880 
881 BOOL
882 WINAPI
883 ImmSetCompositionStringA(
884   _In_ HIMC,
885   _In_ DWORD dwIndex,
886   _Inout_updates_bytes_opt_(dwCompLen) LPVOID lpComp,
887   _In_ DWORD dwCompLen,
888   _Inout_updates_bytes_opt_(dwReadLen) LPVOID lpRead,
889   _In_ DWORD dwReadLen);
890 
891 BOOL
892 WINAPI
893 ImmSetCompositionStringW(
894   _In_ HIMC,
895   _In_ DWORD dwIndex,
896   _Inout_updates_bytes_opt_(dwCompLen) LPVOID lpComp,
897   _In_ DWORD dwCompLen,
898   _Inout_updates_bytes_opt_(dwReadLen) LPVOID lpRead,
899   _In_ DWORD dwReadLen);
900 
901 #define ImmSetCompositionString WINELIB_NAME_AW(ImmSetCompositionString)
902 
903 BOOL WINAPI ImmSetCompositionWindow(_In_ HIMC, _In_ LPCOMPOSITIONFORM);
904 BOOL WINAPI ImmSetConversionStatus(_In_ HIMC, _In_ DWORD, _In_ DWORD);
905 BOOL WINAPI ImmSetOpenStatus(_In_ HIMC, _In_ BOOL);
906 BOOL WINAPI ImmSetStatusWindowPos(_In_ HIMC, _In_ LPPOINT);
907 BOOL WINAPI ImmSimulateHotKey(_In_ HWND, _In_ DWORD);
908 
909 BOOL
910 WINAPI
911 ImmUnregisterWordA(
912   _In_ HKL,
913   _In_ LPCSTR lpszReading,
914   _In_ DWORD,
915   _In_ LPCSTR lpszUnregister);
916 
917 BOOL
918 WINAPI
919 ImmUnregisterWordW(
920   _In_ HKL,
921   _In_ LPCWSTR lpszReading,
922   _In_ DWORD,
923   _In_ LPCWSTR lpszUnregister);
924 
925 #define ImmUnregisterWord WINELIB_NAME_AW(ImmUnregisterWord)
926 
927 
928 #ifdef __cplusplus
929 }
930 #endif
931 
932 #endif  /* __WINE_IMM_H */
933