2.2.2.10.2 Compartment Status Information PDU (TS_RAIL_ORDER_COMPARTMENTINFO_BODY)

The Compartment Status Information PDU is used to send the current input method editor (IME) status information. It is sent from a client to the server, or from a server to the client, but only when client and server both support this capability (TS_RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED). This PDU is used to send the current compartment values of the client or server and is sent only if the current language profile type is TF_PROFILETYPE_INPUTPROCESSOR (0x0001).


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Hdr

ImeState

ImeConvMode

ImeSentenceMode

KANAMode

Hdr (4 bytes): A TS_RAIL_PDU_HEADER header. The orderType field of the header MUST be set to TS_RAIL_ORDER_COMPARTMENTINFO (0x0012).

ImeState (4 bytes): A 32-bit, unsigned integer. Indicates the open or closed state of the IME.

Value

Meaning

IME_STATE_CLOSED

0x00000000

The IME state is closed.

IME_STATE_OPEN

0x00000001

The IME state is open.

ImeConvMode (4 bytes): A 32-bit, unsigned integer. Indicates the IME conversion mode.

Value

Meaning

IME_CMODE_NATIVE

0x00000001

The input mode is native. If not set, the input mode is alphanumeric.

IME_CMODE_KATAKANA

0x00000002

The input mode is Katakana. If not set, the input mode is Hiragana.

IME_CMODE_FULLSHAPE

0x00000008

The input mode is full-width. If not set, the input mode is half-width.

IME_CMODE_ROMAN

0x00000010

The input mode is Roman.

IME_CMODE_CHARCODE

0x00000020

Character-code input is in effect.

IME_CMODE_HANJACONVERT

0x00000040

Hanja conversion mode is in effect.

IME_CMODE_SOFTKBD

0x00000080

A soft (on-screen) keyboard is being used.

IME_CMODE_NOCONVERSION

0x00000100

IME conversion is inactive (that is, the IME is closed).

IME_CMODE_EUDC

0x00000200

End-User Defined Character (EUDC) conversion mode is in effect.

IME_CMODE_SYMBOL

0x00000400

Symbol conversion mode is in effect.

IME_CMODE_FIXED

0x00000800

Fixed conversion mode is in effect.

ImeSentenceMode (4 bytes): An unsigned 4-byte integer that identifies the sentence mode of the IME.

Flag

Meaning

IME_SMODE_NONE

0x00000000

Indicates that the IME uses no information for sentence.

IME_SMODE_PLURALCLAUSE

0x00000001

Indicates that the IME uses plural clause information to carry out conversion processing.

IME_SMODE_SINGLECONVERT

0x00000002

Indicates that the IME carries out conversion processing in single-character mode.

IME_SMODE_AUTOMATIC

0x00000004

Indicates that the IME carries conversion processing in automatic mode.

IME_SMODE_PHRASEPREDICT

0x00000008

Indicates that the IME uses phrase information to predict the next character.

IME_SMODE_CONVERSATION

0x00000010

Indicates that the IME uses conversation mode. This is useful for chat applications.

KANAMode (4 bytes): An unsigned 4-byte integer that identifies whether the input mode is Romaji or KANA for Japanese text processors. The value is 0x0000 for all non-Japanese text processors.

Value

Meaning

KANA_MODE_OFF

0x00000000

Indicates that the KANA input mode is off.

KANA_MODE_ON

0x00000001

Indicates that the KANA input mode is activated.