Crate ohos_input_method_sys 

Structs

InputMethod_AttachOptions

InputMethod_CursorInfo

InputMethod_InputMethodProxy

InputMethod_PrivateCommand

InputMethod_TextAvoidInfo

InputMethod_TextConfig

InputMethod_TextEditorProxy

Constants

InputMethod_CommandValueType_IME_COMMAND_VALUE_TYPE_BOOL

Value type is BOOL.

InputMethod_CommandValueType_IME_COMMAND_VALUE_TYPE_INT32

Value type is INT32.

InputMethod_CommandValueType_IME_COMMAND_VALUE_TYPE_NONE

Value type is NONE.

InputMethod_CommandValueType_IME_COMMAND_VALUE_TYPE_STRING

Value type is STRING.

InputMethod_Direction_IME_DIRECTION_DOWN

The direction is DOWN.

InputMethod_Direction_IME_DIRECTION_LEFT

The direction is LEFT.

InputMethod_Direction_IME_DIRECTION_NONE

The direction is NONE.

InputMethod_Direction_IME_DIRECTION_RIGHT

The direction is RIGHT.

InputMethod_Direction_IME_DIRECTION_UP

The direction is UP.

InputMethod_EnterKeyType_IME_ENTER_KEY_DONE

The enter key type is DONE.

InputMethod_EnterKeyType_IME_ENTER_KEY_GO

The enter key type is GO.

InputMethod_EnterKeyType_IME_ENTER_KEY_NEWLINE

The enter key type is NEWLINE.

InputMethod_EnterKeyType_IME_ENTER_KEY_NEXT

The enter key type is NEXT.

InputMethod_EnterKeyType_IME_ENTER_KEY_NONE

The enter key type is NONE.

InputMethod_EnterKeyType_IME_ENTER_KEY_PREVIOUS

The enter key type is PREVIOUS.

InputMethod_EnterKeyType_IME_ENTER_KEY_SEARCH

The enter key type is SEARCH.

InputMethod_EnterKeyType_IME_ENTER_KEY_SEND

The enter key type is SEND.

InputMethod_EnterKeyType_IME_ENTER_KEY_UNSPECIFIED

The enter key type is UNSPECIFIED.

InputMethod_ErrorCode_IME_ERR_CONFIG_PERSIST

@error The error code when configuration persistence error.

InputMethod_ErrorCode_IME_ERR_CONTROLLER

@error The error code when input method controller error.

InputMethod_ErrorCode_IME_ERR_DETACHED

@error The error code when input method client detached.

InputMethod_ErrorCode_IME_ERR_IMCLIENT

@error The error code when input method client error.

InputMethod_ErrorCode_IME_ERR_IMENGINE

@error The error code when input method engine error.

InputMethod_ErrorCode_IME_ERR_IMMS

@error The error code when input method manager service error.

InputMethod_ErrorCode_IME_ERR_NULL_POINTER

@error The error code when unexpected null pointer.

InputMethod_ErrorCode_IME_ERR_OK

@error The error code in the correct case.

InputMethod_ErrorCode_IME_ERR_PACKAGEMANAGER

@error The error code when the bundle manager error.

InputMethod_ErrorCode_IME_ERR_PARAMCHECK

@error The error code when parameter check failed.

InputMethod_ErrorCode_IME_ERR_QUERY_FAILED

@error The error code when query failed.

InputMethod_ErrorCode_IME_ERR_SETTINGS

@error The error code when input method setting error.

InputMethod_ErrorCode_IME_ERR_UNDEFINED

@error The error code when error is undefined.

InputMethod_ExtendAction_IME_EXTEND_ACTION_COPY

Copy selected text.

InputMethod_ExtendAction_IME_EXTEND_ACTION_CUT

Cut selected text.

InputMethod_ExtendAction_IME_EXTEND_ACTION_PASTE

Paste from paste board.

InputMethod_ExtendAction_IME_EXTEND_ACTION_SELECT_ALL

Select all text.

InputMethod_KeyboardStatus_IME_KEYBOARD_STATUS_HIDE

The keyboard status is hide.

InputMethod_KeyboardStatus_IME_KEYBOARD_STATUS_NONE

The keyboard status is none.

InputMethod_KeyboardStatus_IME_KEYBOARD_STATUS_SHOW

The keyboard status is show.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_DATETIME

The text input type is DATETIME.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_EMAIL_ADDRESS

The text input type is EMAIL ADDRESS.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_MULTILINE

The text input type is MULTILINE.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_NEW_PASSWORD

The text input type is NEW PASSWORD.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_NONE

The text input type is NONE.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_NUMBER

The text input type is NUMBER.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_NUMBER_DECIMAL

The text input type is NUMBER DECIMAL.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_NUMBER_PASSWORD

The text input type is NUMBER PASSWORD.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_PHONE

The text input type is PHONE.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_SCREEN_LOCK_PASSWORD

The text input type is SCREEN LOCK PASSWORD.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_TEXT

The text input type is TEXT.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_URL

The text input type is URL.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_USER_NAME

The text input type is USER NAME.

InputMethod_TextInputType_IME_TEXT_INPUT_TYPE_VISIBLE_PASSWORD

The text input type is VISIBLE PASSWORD.

Functions

OH_AttachOptions_Create^⚠

@brief Create a new {@link InputMethod_AttachOptions} instance.

OH_AttachOptions_Destroy^⚠

@brief Delete a {@link InputMethod_AttachOptions} instance.

OH_AttachOptions_IsShowKeyboard^⚠

@brief Get showKeyboard value from {@link InputMethod_AttachOptions}.

OH_CursorInfo_Create^⚠

@brief Create a new {@link InputMethod_CursorInfo} instance.

OH_CursorInfo_Destroy^⚠

@brief Destroy a {@link InputMethod_CursorInfo} instance.

OH_CursorInfo_GetRect^⚠

@brief Get cursor info.

OH_CursorInfo_SetRect^⚠

@brief Set cursor info.

OH_InputMethodController_Attach^⚠

@brief Attach application to the input method service.

OH_InputMethodController_Detach^⚠

@brief Detach application from the input method service.

OH_InputMethodProxy_HideKeyboard^⚠

@brief Hide keyboard.

OH_InputMethodProxy_NotifyConfigurationChange^⚠

@brief Notify text editor configuration change.

OH_InputMethodProxy_NotifyCursorUpdate^⚠

@brief Notify cursor update.

OH_InputMethodProxy_NotifySelectionChange^⚠

@brief Notify selection change.

OH_InputMethodProxy_SendPrivateCommand^⚠

@brief Send private command.

OH_InputMethodProxy_ShowKeyboard^⚠

@brief Show keyboard.

OH_PrivateCommand_Create^⚠

@brief Create a new {@link InputMethod_PrivateCommand} instance.

OH_PrivateCommand_Destroy^⚠

@brief Destroy a {@link InputMethod_PrivateCommand} instance.

OH_PrivateCommand_GetBoolValue^⚠

@brief Get bool data value from {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_GetIntValue^⚠

@brief Get integer data value from {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_GetKey^⚠

@brief Get key value from {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_GetStrValue^⚠

@brief Get string data value from {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_GetValueType^⚠

@brief Get value type from {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_SetBoolValue^⚠

@brief Set bool data value into {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_SetIntValue^⚠

@brief Set integer data value into {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_SetKey^⚠

@brief Set key value into {@link InputMethod_PrivateCommand}.

OH_PrivateCommand_SetStrValue^⚠

@brief Set string data value into {@link InputMethod_PrivateCommand}.

OH_TextAvoidInfo_Create^⚠

@brief Create a new {@link InputMethod_TextAvoidInfo} instance.

OH_TextAvoidInfo_Destroy^⚠

@brief Destroy a {@link InputMethod_TextAvoidInfo} instance.

OH_TextAvoidInfo_GetHeight^⚠

@brief Get height value into {@link InputMethod_TextAvoidInfo}.

OH_TextAvoidInfo_GetPositionY^⚠

@brief Get positionY value from {@link InputMethod_TextAvoidInfo}.

OH_TextAvoidInfo_SetHeight^⚠

@brief Set height value into {@link InputMethod_TextAvoidInfo}.

OH_TextAvoidInfo_SetPositionY^⚠

@brief Set positionY value into {@link InputMethod_TextAvoidInfo}.

OH_TextConfig_Create^⚠

@brief Create a new {@link InputMethod_TextConfig} instance.

OH_TextConfig_Destroy^⚠

@brief Destroy a {@link InputMethod_TextConfig} instance.

OH_TextConfig_GetCursorInfo^⚠

@brief Get cursor info from TextConfig.

OH_TextConfig_GetEnterKeyType^⚠

@brief Get enter key type from TextConfig

OH_TextConfig_GetInputType^⚠

@brief Get input type from TextConfig

OH_TextConfig_GetSelection^⚠

@brief Get selection from TextConfig.

OH_TextConfig_GetTextAvoidInfo^⚠

@brief Get text avoid information from text configuration.

OH_TextConfig_GetWindowId^⚠

@brief Get window id from TextConfig.

OH_TextConfig_IsPreviewTextSupported^⚠

@brief Get is preview text supported from TextConfig.

OH_TextConfig_SetEnterKeyType^⚠

@brief Set enter key type into TextConfig.

OH_TextConfig_SetInputType^⚠

@brief Set input type into TextConfig.

OH_TextConfig_SetPreviewTextSupport^⚠

@brief Set preview text support into TextConfig.

OH_TextConfig_SetSelection^⚠

@brief Set selection into TextConfig.

OH_TextConfig_SetWindowId^⚠

@brief Set window id into TextConfig.

OH_TextEditorProxy_Create^⚠

@brief Create a new {@link InputMethod_TextEditorProxy} instance.

OH_TextEditorProxy_Destroy^⚠

@brief Destroy a {@link InputMethod_TextEditorProxy} instance.

OH_TextEditorProxy_GetDeleteBackwardFunc^⚠

@brief Get function {@link OH_TextEditorProxy_DeleteBackwardFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetDeleteForwardFunc^⚠

@brief Get function {@link OH_TextEditorProxy_DeleteForwardFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetFinishTextPreviewFunc^⚠

@brief Get function {@link OH_TextEditorProxy_FinishTextPreviewFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetGetLeftTextOfCursorFunc^⚠

@brief Get function {@link OH_TextEditorProxy_GetLeftTextOfCursorFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetGetRightTextOfCursorFunc^⚠

@brief Get function {@link OH_TextEditorProxy_GetRightTextOfCursorFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetGetTextConfigFunc^⚠

@brief Get function {@link OH_TextEditorProxy_GetTextConfigFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetGetTextIndexAtCursorFunc^⚠

@brief Get function {@link OH_TextEditorProxy_GetTextIndexAtCursorFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetHandleExtendActionFunc^⚠

@brief Get function {@link OH_TextEditorProxy_HandleExtendActionFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetHandleSetSelectionFunc^⚠

@brief Get function {@link OH_TextEditorProxy_HandleSetSelectionFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetInsertTextFunc^⚠

@brief Get function {@link OH_TextEditorProxy_InsertTextFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetMoveCursorFunc^⚠

@brief Get function {@link OH_TextEditorProxy_MoveCursorFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetReceivePrivateCommandFunc^⚠

@brief Get function {@link OH_TextEditorProxy_ReceivePrivateCommandFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetSendEnterKeyFunc^⚠

@brief Get function {@link OH_TextEditorProxy_SendEnterKeyFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetSendKeyboardStatusFunc^⚠

@brief Get function {@link OH_TextEditorProxy_SendKeyboardStatusFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_GetSetPreviewTextFunc^⚠

@brief Get function {@link OH_TextEditorProxy_SetPreviewTextFunc} from {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetDeleteBackwardFunc^⚠

@brief Set function {@link OH_TextEditorProxy_DeleteBackwardFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetDeleteForwardFunc^⚠

@brief Set function {@link OH_TextEditorProxy_SetDeleteForwardFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetFinishTextPreviewFunc^⚠

@brief Set function {@link OH_TextEditorProxy_FinishTextPreviewFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetGetLeftTextOfCursorFunc^⚠

@brief Set function {@link OH_TextEditorProxy_GetLeftTextOfCursorFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetGetRightTextOfCursorFunc^⚠

@brief Set function {@link OH_TextEditorProxy_GetRightTextOfCursorFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetGetTextConfigFunc^⚠

@brief Set function {@link OH_TextEditorProxy_GetTextConfigFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetGetTextIndexAtCursorFunc^⚠

@brief Set function {@link OH_TextEditorProxy_GetTextIndexAtCursorFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetHandleExtendActionFunc^⚠

@brief Set function {@link OH_TextEditorProxy_HandleExtendActionFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetHandleSetSelectionFunc^⚠

@brief Set function {@link OH_TextEditorProxy_HandleSetSelectionFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetInsertTextFunc^⚠

@brief Set function {@link OH_TextEditorProxy_InsertTextFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetMoveCursorFunc^⚠

@brief Set function {@link OH_TextEditorProxy_MoveCursorFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetReceivePrivateCommandFunc^⚠

@brief Set function {@link OH_TextEditorProxy_ReceivePrivateCommandFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetSendEnterKeyFunc^⚠

@brief Set function {@link OH_TextEditorProxy_SendEnterKeyFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetSendKeyboardStatusFunc^⚠

@brief Set function {@link OH_TextEditorProxy_SendKeyboardStatusFunc} into {@link InputMethod_TextEditorProxy}.

OH_TextEditorProxy_SetSetPreviewTextFunc^⚠

@brief Set function {@link OH_TextEditorProxy_SetPreviewTextFunc} into {@link InputMethod_TextEditorProxy}.

Type Aliases

InputMethod_CommandValueType

@brief The value type of command data.

InputMethod_Direction

@brief Direction.

InputMethod_EnterKeyType

@brief Enter key type.

InputMethod_ErrorCode

@brief The value type of command data.

InputMethod_ExtendAction

@brief The extend action.

InputMethod_KeyboardStatus

@brief Keyboard status.

InputMethod_TextInputType

@brief The text input type.

OH_TextEditorProxy_DeleteBackwardFunc

@brief Defines the function called when input method deleting text backward.

OH_TextEditorProxy_DeleteForwardFunc

@brief Defines the function called when input method deleting text forward.

OH_TextEditorProxy_FinishTextPreviewFunc

@brief Called when input method finishing preview text.

OH_TextEditorProxy_GetLeftTextOfCursorFunc

@brief Called when input method requesting to get left text of cursor.

OH_TextEditorProxy_GetRightTextOfCursorFunc

@brief Called when input method requesting to get right text of cursor.

OH_TextEditorProxy_GetTextConfigFunc

@brief Defines the function called when input method getting text config.

OH_TextEditorProxy_GetTextIndexAtCursorFunc

@brief Called when input method requesting to get text index at cursor.

OH_TextEditorProxy_HandleExtendActionFunc

@brief Called when input method sending extend action.

OH_TextEditorProxy_HandleSetSelectionFunc

@brief Called when input method requesting to set selection.

OH_TextEditorProxy_InsertTextFunc

@brief Defines the function called when input method inserting text.

OH_TextEditorProxy_MoveCursorFunc

@brief Called when input method requesting to move cursor.

OH_TextEditorProxy_ReceivePrivateCommandFunc

@brief Called when input method sending private command.

OH_TextEditorProxy_SendEnterKeyFunc

@brief Called when input method sending enter key.

OH_TextEditorProxy_SendKeyboardStatusFunc

@brief Called when input method notifying keyboard status.

OH_TextEditorProxy_SetPreviewTextFunc

@brief Called when input method setting preview text.