Input Method Instance

Input Method Instance

Input Method Instance is a contextual unit which holds the several states related to the user input. It is actually a data block which is allocated by system. The data structure is directly accessible through a long value handle(HIMI) by calling ImRequestIMInstance, which gives IME the memory address of the structure. After IME refers to or change the IMInstance contents, IME should release IMInstance by calling ImReleaseIMInstance call. IMInstance itself has the following structure.

                IMINSTANCE
                {
                        /* Size of this structure */
                        ULONG ulSize;

                        /* Information related to the client application */
                        ULONG ulSessionType;
                        HWND hwnd;
                        ULONG ulSessionID;
                        ULONG ulClientInfo;
                        ULONG ulCodepage;

                        /* Status part */
                        HIMIP himipStatus;
                        ULONG ulInputMode;
                        ULONG ulConversionMode;
                        POINTL ptlStatusPos;
                        SIZEL slStatusSize;

                        /* Conversion part */
                        HIMIP himipConversion;
                        FATTRS faConversionWindow;
                        GRADIENTL gradlConversionWindow;
                        SIZEF sfCharBox;
                        CONVERSIONPOS cpConversionPos;

                        /* Result part */
                        HIMIP himipResult;

                        /* Candidate part */
                        HIMIP himipCandidate;
                        CANDIDATEPOS cpCandidatePos;

                        /* Information message part */
                        HIMIP himipInfoMsg;

                        /* Register word part */
                        HIMIP himipRegWord;

                        /* Private part */
                        HIMIP himipPrivate;

                                        }

where

ulSize

: Size of this structure
ulSessionType
: Session Type of the client. The value in this field is identical to the one which is used inDosGetInfoBlocks( pib_ulType ) (Provider : System, Viewer : IME)
hwnd
:Window handle. This field is valid when the IMI_CI_PMCALLABLE is set in ulClientInfo. (Provider : System, Viewer : IME.)
SessionID
: Session id. This field is valid when the IMI_CI_PMCALLABLE is *NOT* set in ulClientInfo. (Provider : System, Viewer : IME.)
ulClientInfo
: Bit field for the client information as follows. (Provider : System, Viewer : IME.)

IMI_CI_PMCALLABLE(0x00000001)

: IME can call PM APIs for this instance.
ulCodepage :
Codepage of the client application. It is the queue codepage if the client is PM app, or the process codepage if the client is FullScreen app. IME need not care whether the codepage is a member of the IME supported language or not. If epage is not a member of supported IME language, IME is automatically changed(detached) by the system. Provider : System, Viewer : IME.
himipStatus
: IMIPart handle of the Status part. (Provider : IME Viewer : IME.)
ulInputMode
: Contains the current keyboard mode. If the value of this field is altered by system, IME will get notified by ImeNotifyEvent call, also if IME alter this field, IME should call ImRequestEvent with IMR_STATUS_INPUTMODE. The bit defini as follows Provider : System, IME Viewer : IME, System.

Bit 0-4 : NLS Layer mode.



• IMI_IM_NLS_ALPHANUMERIC(0x00000000)
  
• IMI_IM_NLS_HIRAGANA(0x00000001)
  
• IMI_IM_NLS_TAIWAN(0x00000001)
  
• IMI_IM_NLS_PRC(0x00000001)
  
• IMI_IM_NLS_HANGEUL(0x00000001)
  
• IMI_IM_NLS_KATAKANA(0x00000003)
Bit 5 : Character width.
0 : IMI_IM_WIDTH_HALF(0x00000000)

• IMI_IM_WIDTH_FULL(0x000000020)
Bit 6 : Romaji mode
0 : IMI_IM_ROMAJI_OFF(0x00000000)

• IMI_IM_ROMAJI_ON(0x00000040)
Bit 7 : System Romaji Conversion enable/disable flag
0 : IMI_IM_SYSTEMROMAJI_ENABLE(0x00000000)

• IMI_IM_SYSTEMROMAJI_DISABLE(0x00000080)
Bit 8 : IME mode which has one of the following values
0 : IMI_IM_IME_OFF(0x00000000)

• IMI_IM_IME_ON(0x00000100)
Bit 9 : IME enable/disable flag. If IME is disabled, IME is not called from system, but IME is still attached to the instance.
0 : IMI_IM_IME_ENABLE(0x00000000)

• IMI_IM_IME_DISABLE(0x00000200)
Bit 10 : Soft-Keyboard ON/OFF. If this bit is ON, the new filled soft-keyboard part class window will be appear.(PRC Only)
0 : IMI_IM_IME_SOFTKBD_OFF(0x00000000)

• IMI_IM_IME_SOFTKBD_ON(0x00000400)
Bit 11 : IME Chinese Symbol Input ON/OFF. If this bit is ON, some alphanumeric punctuations inputed from keyboard will be converted into DBCS punctuation by IME. It is filled in IME.(PRC Only)
0 : IMI_IM_IME_CSYMBOL_OFF(0x00000000)

• IMI_IM_IME_CSYMBOL_ON(0x00000800)
Bit 12-31 : Reserved zero
ulConversionMode
: Contains the conversion logic method. If the value of this field is altered by system, IME will get notified by ImeNotifyEvent call, also if IME alter this field, IME should call ImRequestEvent with IMR_STATUS_CONVERSIONMODE. The finition is as follows. Provider : System, IME Viewer : IME, System.

IMI_CM_AUTOMATIC

IME is in automatic conversion mode
IMI_CM_PLURALCLAUSE
IME is in plural clause conversion mode
IMI_CM_PREDICT
IME is in phrase predict conversion mode
IMI_CM_SINGLE
IME is in single character conversion mode
ptlStatusPos
: Position of the status window in World Coordinates. If the value of this field is altered by system, IME will get notified by ImeNotifyEvent call, also if IME alter this field, IME should call ImRequestEvent with IMR_STATUS_STATUSPOS ider : System, IME Viewer IME, System.)
slStatusSize
: Status Window width and height. If IME alter this field, IME should call ImRequestEvent with IMR_STATUS_STATUSPOS. (Provider : IME Viewer : System)
himipConversion
: IMIPart handle of the Conversion part. (Provider : IME Viewer : IME.)
faConversionWindow
: Font Attribute which is used for the conversion window. If the value of this field is altered by system, IME will get notified by ImeNotifyEvent call, also if IME alter this field, IME should call ImRequestEvent with IMR_CONV_CONVERSIONFONT. (Provider : System, IME Viewer : IME, System.)
gradlConversionWindow
: conversion window angle.
sfCharBox
: Character box size(in PELs) of the font which is used in the conversion window.
cpConversionPos
: Position and clipping rect definition for the conversion window in Window Coordinates. If the value of this field is altered by system, IME will get notified by ImeNotifyEvent call, also if IME alter this field, IME should call ImRequestEvent with IMR_CONV_CONVERSIONPOS. (Provider : System, IME Viewer : IME, System.)
himipResult
: IMIPart handle of the Result part. (Provider : IME Viewer : IME.)
himipCandidate
: IMIPart handle of the Candidate part. (Provider : IME Viewer : IME.)
cpCandidatePos
: Position and clipping rect definition of the candidate window in Window Coordinates. If the value of this field is altered by system, IME will get notified by ImeNotifyEvent call, also if IME alter this field, IME should call ImRequestEvent with IMR_CONV_CONVERSIONPOS. (Provider : System, IME Viewer : IME, System.)
himipInfoMsg
: IMIPart handle of the Informational Message part. (Provider : IME Viewer : IME.)
himipRegWord
: IMIPart handle of the Register Word part. (Provider : IME Viewer : IME.)
himipPrivate
: IMIPart handle of the Private part. (Provider : IME Viewer : IME.)

Note: IME should check client information such as hwnd and SessionID even if IME does not set IME_CAPS_SCREENSWITCHABLE on each IMInstance request, because application can associate the instance to any client at any time.

---

[Back: Overview]
[Next: Part]