IImePad::Request method (imepad.h)
Called by an IImePadApplet to insert text into an app.
Request is the only method that IImePadApplet can call. By calling this method with one of the IMEPADREQ_* request IDs, IImePadApplet can insert text into an app and can control IME's composition string in an app.
HRESULT Request(
[in] IImePadApplet *pIImePadApplet,
[in] INT reqId,
[in, out] WPARAM wParam,
[in, out] LPARAM lParam
);
[in] pIImePadApplet
The interface pointer of the calling applet.
[in] reqId
The type of request (the request ID). This must be set to one of the following values:
Value | Meaning |
---|---|
|
Insert a string into the app as a composition string.
|
|
Controls composition of the string and caret in the app.
|
|
Set a new applet window size.
|
|
Gets the current composition string text.
|
|
Gets information about the current composition string.
|
|
Delete the composition string.
|
|
Replace part of the composition string.
|
|
Gets the application window handle.
|
|
Keeps the ImePad window visible.
|
|
Causes IImePad to call the applet's Notify method asynchronously with a specific notification Id and user-defined data.
|
|
Gets the recommended (default) ImePad applet UI Language.
|
|
Get the current ImePad applet UI Language.
|
|
Gets the applet's UI style (IPAWS_* flags).
|
|
Sets the applet's UI style (IPAWS_* flags).
|
|
Determines if the applet is active.
|
|
Determines if ImePad is visible.
|
|
Set the minimum and maximum applet size.
|
|
Gets the current application IME's conversion status. For a complete list of conversion and sentence modes, see the header file Imm.h.
|
|
Gets IImePad's version information.
|
|
Gets the IME information that invoked ImePad.
|
[in, out] wParam
Additional information specific to reqId.
[in, out] lParam
Additional information specific to reqId.
S_OK if successful, otherwise E_FAIL.
These are the possible values that wParam can take when reqId is set to IMEPADREQ_SENDCONTROL:Name | Value | Description |
---|---|---|
IMEPADCTRL_CONVERTALL | 1 | Convert all composition strings. |
IMEPADCTRL_DETERMINALL | 2 | Determine all composition strings. |
IMEPADCTRL_DETERMINCHAR | 3 | Determine specified count's composition string character. |
IMEPADCTRL_CLEARALL | 4 | Clear all composition strings. |
IMEPADCTRL_CARETLEFT | 6 | Move character caret to the left. |
IMEPADCTRL_CARETRIGHT | 7 | Move character caret to the right. |
IMEPADCTRL_CARETTOP | 8 | Move character caret to the top of the composition string. |
IMEPADCTRL_CARETBOTTOM | 9 | Move character caret to the end of the composition string. |
IMEPADCTRL_CARETBACKSPACE | 10 | Delete composition string's character before the caret (like the BACKSPACE key). |
IMEPADCTRL_CARETDELETE | 11 | Delete composition string's character after the caret (like the DELETE key). |
IMEPADCTRL_PHRASEDELETE | 12 | Delete the composition string's phrase. |
IMEPADCTRL_INSERTSPACE | 13 | Insert a space character—full width or half width depending on the IME configuration. |
IMEPADCTRL_INSERTFULLSPACE | 14 | Insert full width space. |
IMEPADCTRL_INSERTHALFSPACE | 15 | Insert half width space. |
IMEPADCTRL_ONIME | 16 | Set IME ON. |
IMEPADCTRL_OFFIME | 17 | Set IME OFF. |
IMEPADCTRL_ONPRECONVERSION | 18 | Set pre-conversion ON. |
IMEPADCTRL_OFFPRECONVERSION | 19 | Set pre-conversion OFF. |
IMEPADCTRL_PHONETICCANDIDATE | 20 | Open IME's candidate. |
Name | Description |
---|---|
IPAWS_ENABLED | Show the applet as an enabled window. |
IPAWS_SIZINGNOTIFY | Send the IMEPN_SIZECHANGING or IMEPN_SIZECHANGED notify code to the applet. |
IPAWS_VERTICALFIXED | Vertically fixed. |
IPAWS_HORIZONTALFIXED | Horizontally fixed. |
IPAWS_SIZEFIXED | Size is fixed. |
IPAWS_MAXWIDTHFIXED | Max width is fixed. |
IPAWS_MAXHEIGHTFIXED | Max height is fixed. |
IPAWS_MAXSIZEFIXED | Max size is fixed. |
IPAWS_MINWIDTHFIXED | Min width is fixed. |
IPAWS_MINHEIGHTFIXED | Min height is fixed. |
IPAWS_MINSIZEFIXED | Min size is fixed. |
Requirement | Value |
---|---|
Target Platform | Windows |
Header | imepad.h |