IME Window functions

Data Structures
struct	_IME_TARGET_INFO

Typedefs
typedef struct _IME_TARGET_INFO	IME_TARGET_INFO

Functions
MG_EXPORT int GUIAPI	RegisterIMEWindow (HWND hWnd)
	Registers an IME window. More...
MG_EXPORT int GUIAPI	UnregisterIMEWindow (HWND hWnd)
	Unregisters an IME window. More...
MG_EXPORT int GUIAPI	GetIMEStatus (int StatusCode)
	Retrieve status of the current IME window. More...
MG_EXPORT int GUIAPI	SetIMEStatus (int StatusCode, int Value)
	Set the status of the current IME window. More...
MG_EXPORT int GUIAPI	GetIMETargetInfo (IME_TARGET_INFO *info)
	Retrieve the target info of the current IME window. More...
MG_EXPORT int GUIAPI	SetIMETargetInfo (const IME_TARGET_INFO *info)
	Set the target info of the current IME window. More...
MG_EXPORT int GUIAPI	GetIMEPos (POINT *pt)
	Retrieve the position of the current IME window. More...

Detailed Description

Typedef Documentation

IME_TARGET_INFO

typedef struct _IME_TARGET_INFO IME_TARGET_INFO

\ struct defines a ime target info

Function Documentation

GetIMEPos()

int GUIAPI GetIMEPos

(

POINT *

pt

)

Retrieve the position of the current IME window.

NOTE that this function is deprecated.

This function retrieves the position of the current IME window.

Parameters

pt	The item to be retrived. The positon is return by the current IME Window.

Returns

The current IME window positon. ERR_IME_NOIMEWND if error occurred.

See also

GetIMEPos

GetIMEStatus()

int GUIAPI GetIMEStatus

(

int

StatusCode

)

Retrieve status of the current IME window.

This function retrieves status of the current IME window.

Parameters

StatusCode

The item to be retrived, can be one of the following values: IME_STATUS_REGISTERED Is there any registered IME window? IME_STATUS_ENABLED Is the IME window enabled? IME_STATUS_AUTOTRACK Does the IME window autotrack the input focus? IME_STATUS_LANGUAGE Retrieve the selected input method. The return value can be one of the following values: IME_LANGUAGE_UNKNOWN Unknown IME_LANGUAGE_LATIN Latin IME_LANGUAGE_ZHCN Chinese simplified IME_LANGUAGE_ZHTW Chinese traditional IME_STATUS_ENCODING Retrieve the output encoding. The return value can be one of the following values: IME_ENCODING_LOCAL The local encoding IME_ENCODING_UTF8 UTF-8 IME_STATUS_VERSION Retrieve the version of the IME IME_STATUS_USER_MIN, IME_STATUS_USER_MAX Reserved for user. The return value and its meaning is determined by the specific IME implementation.

Returns

The status of the item specified by StatusCode, ERR_IME_NOIMEWND if error occurred.

See also

SetIMEStatus

GetIMETargetInfo()

int GUIAPI GetIMETargetInfo

(

IME_TARGET_INFO *

info

)

Retrieve the target info of the current IME window.

This function retrieves the target info of the current IME window.

Parameters

info	The item to be retrived. The target info is return by the current IME Window.

Returns

ERR_OK on success, otherwise less than zero.

See also

GetIMETargetInfo

RegisterIMEWindow()

int GUIAPI RegisterIMEWindow

(

HWND

hWnd

)

Registers an IME window.

This function registers the specified window hWnd as the IME window of the MiniGUI. After that, the keyboard input will be sent to IME window first. Note that only one IME window can be registered.

Parameters

hWnd	The handle to your IME window.

Returns

ERR_OK on success, otherwise less than zero.

Return values

ERR_OK	Success.
ERR_IME_TOOMUCHIMEWND	Already have an IME window registered.
ERR_INV_HWND	Invalid main window handle.

See also

UnregisterIMEWindow

SetIMEStatus()

int GUIAPI SetIMEStatus	(	int	StatusCode,
		int	Value
	)

Set the status of the current IME window.

This function sets the status of the current IME window.

Parameters

StatusCode	The item to be set. Please see GetIMEStatus for more information.
Value	The status value of the item.

Return values

ERR_OK	Success.
ERR_IME_NOIMEWND	There is no any IME window registered.

See also

GetIMEStatus

SetIMETargetInfo()

int GUIAPI SetIMETargetInfo

(

const IME_TARGET_INFO *

info

)

Set the target info of the current IME window.

This function sets the target info of the current IME window.

Parameters

info	The set target info.

Returns

ERR_OK on success, otherwise less than zero.

Return values

ERR_OK	Success.
ERR_IME_NOIMEWND	There is no any IME window registered.

See also

SetIMETargetInfo

UnregisterIMEWindow()

int GUIAPI UnregisterIMEWindow

(

HWND

hWnd

)

Unregisters an IME window.

This function undoes the effect of RegisterIMEWindow.

Parameters

hWnd	The handle to the current IME window.

Returns

ERR_OK on success, otherwise less than zero.

Return values

ERR_OK	Success.
ERR_IME_NOSUCHIMEWND	The window is not the current IME window.

See also

RegisterIMEWindow