harmony 鸿蒙inputmethod_text_editor_proxy_capi.h

2025-06-12
浏览 (5)

inputmethod_text_editor_proxy_capi.h

Overview

Provides a set of methods for the custom text box developed by the application to obtain notifications and requests from the input method application.

Library: libohinputmethod.so

System capability: SystemCapability.MiscServices.InputMethodFramework

Since: 12

Related module: InputMethod

Summary

Types

Name	Description
InputMethod_TextEditorProxy	Text box proxy.
typedef void(* OH_TextEditorProxy_GetTextConfigFunc) (InputMethod_TextEditorProxy textEditorProxy, InputMethod_TextConfig config)	Function called when the input method obtains the text box configuration.
typedef void(* OH_TextEditorProxy_InsertTextFunc) (InputMethod_TextEditorProxy textEditorProxy, const char16_t text, size_t length)	Function called when the input method application inserts text.
typedef void(* OH_TextEditorProxy_DeleteForwardFunc) (InputMethod_TextEditorProxy *textEditorProxy, int32_t length)	Function called when the input method deletes the text on the right of the cursor.
typedef void(* OH_TextEditorProxy_DeleteBackwardFunc) (InputMethod_TextEditorProxy *textEditorProxy, int32_t length)	Function called when the input method deletes the text on the left of the cursor.
typedef void(* OH_TextEditorProxy_SendKeyboardStatusFunc) (InputMethod_TextEditorProxy *textEditorProxy, InputMethod_KeyboardStatus keyboardStatus)	Function called when the input method notifies the keyboard status.
typedef void(* OH_TextEditorProxy_SendEnterKeyFunc) (InputMethod_TextEditorProxy *textEditorProxy, InputMethod_EnterKeyType enterKeyType)	Function called when the Enter key is pressed in the input method.
typedef void(* OH_TextEditorProxy_MoveCursorFunc) (InputMethod_TextEditorProxy *textEditorProxy, InputMethod_Direction direction)	Function called when the cursor is moved in the input method.
typedef void(* OH_TextEditorProxy_HandleSetSelectionFunc) (InputMethod_TextEditorProxy *textEditorProxy, int32_t start, int32_t end)	Function called when the input method requests to select text.
typedef void(* OH_TextEditorProxy_HandleExtendActionFunc) (InputMethod_TextEditorProxy *textEditorProxy, InputMethod_ExtendAction action)	Function called when the input method sends an extended editing operation.
typedef void(* OH_TextEditorProxy_GetLeftTextOfCursorFunc) (InputMethod_TextEditorProxy textEditorProxy, int32_t number, char16_t text[], size_t length)	Function called when the input method obtains the text on the left of the cursor.
typedef void(* OH_TextEditorProxy_GetRightTextOfCursorFunc) (InputMethod_TextEditorProxy textEditorProxy, int32_t number, char16_t text[], size_t length)	Function called when the input method obtains the text on the right of the cursor.
typedef int32_t(* OH_TextEditorProxy_GetTextIndexAtCursorFunc) (InputMethod_TextEditorProxy *textEditorProxy)	Function called when the input method obtains the index of the text where the cursor is located in the text box.
typedef int32_t(* OH_TextEditorProxy_ReceivePrivateCommandFunc) (InputMethod_TextEditorProxy textEditorProxy, InputMethod_PrivateCommand privateCommand[], size_t size)	Function called when the input method application sends a private data command.
typedef int32_t(* OH_TextEditorProxy_SetPreviewTextFunc) (InputMethod_TextEditorProxy *textEditorProxy, const char16_t text[], size_t length, int32_t start, int32_t end)	Function called when the input method sets the text preview feature.
typedef void(* OH_TextEditorProxy_FinishTextPreviewFunc) (InputMethod_TextEditorProxy *textEditorProxy)	Function called when the input method ends the text preview feature.

Functions

Name	Description
InputMethod_TextEditorProxy * OH_TextEditorProxy_Create ()	Creates an InputMethod_TextEditorProxy instance.
void OH_TextEditorProxy_Destroy (InputMethod_TextEditorProxy *proxy)	Destroys an InputMethod_TextEditorProxy instance.
InputMethod_ErrorCode OH_TextEditorProxy_SetGetTextConfigFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_GetTextConfigFunc getTextConfigFunc)	Sets the OH_TextEditorProxy_GetTextConfigFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetInsertTextFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_InsertTextFunc insertTextFunc)	Sets the OH_TextEditorProxy_InsertTextFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetDeleteForwardFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_DeleteForwardFunc deleteForwardFunc)	Sets the OH_TextEditorProxy_DeleteForwardFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetDeleteBackwardFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_DeleteBackwardFunc deleteBackwardFunc)	Sets the OH_TextEditorProxy_DeleteBackwardFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetSendKeyboardStatusFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_SendKeyboardStatusFunc sendKeyboardStatusFunc)	Sets the OH_TextEditorProxy_SendKeyboardStatusFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetSendEnterKeyFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_SendEnterKeyFunc sendEnterKeyFunc)	Sets the OH_TextEditorProxy_SetSendEnterKeyFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetMoveCursorFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_MoveCursorFunc moveCursorFunc)	Sets the OH_TextEditorProxy_SetMoveCursorFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetHandleSetSelectionFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_HandleSetSelectionFunc handleSetSelectionFunc)	Sets the OH_TextEditorProxy_HandleSetSelectionFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetHandleExtendActionFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_HandleExtendActionFunc handleExtendActionFunc)	Sets the OH_TextEditorProxy_HandleExtendActionFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetGetLeftTextOfCursorFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_GetLeftTextOfCursorFunc getLeftTextOfCursorFunc)	Sets the OH_TextEditorProxy_GetLeftTextOfCursorFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetGetRightTextOfCursorFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_GetRightTextOfCursorFunc getRightTextOfCursorFunc)	Sets the OH_TextEditorProxy_GetRightTextOfCursorFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetGetTextIndexAtCursorFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_GetTextIndexAtCursorFunc getTextIndexAtCursorFunc)	Sets the OH_TextEditorProxy_GetTextIndexAtCursorFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetReceivePrivateCommandFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_ReceivePrivateCommandFunc receivePrivateCommandFunc)	Sets the OH_TextEditorProxy_ReceivePrivateCommandFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetSetPreviewTextFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_SetPreviewTextFunc setPreviewTextFunc)	Sets the OH_TextEditorProxy_SetPreviewTextFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_SetFinishTextPreviewFunc (InputMethod_TextEditorProxy *proxy, OH_TextEditorProxy_FinishTextPreviewFunc finishTextPreviewFunc)	Sets the OH_TextEditorProxy_FinishTextPreviewFunc function to InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetGetTextConfigFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_GetTextConfigFunc getTextConfigFunc)	Obtains the OH_TextEditorProxy_GetTextConfigFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetInsertTextFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_InsertTextFunc insertTextFunc)	Obtains the OH_TextEditorProxy_InsertTextFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetDeleteForwardFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_DeleteForwardFunc deleteForwardFunc)	Obtains the OH_TextEditorProxy_DeleteForwardFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetDeleteBackwardFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_DeleteBackwardFunc deleteBackwardFunc)	Obtains the OH_TextEditorProxy_DeleteBackwardFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetSendKeyboardStatusFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_SendKeyboardStatusFunc sendKeyboardStatusFunc)	Obtains the OH_TextEditorProxy_SendKeyboardStatusFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetSendEnterKeyFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_SendEnterKeyFunc sendEnterKeyFunc)	Obtains the OH_TextEditorProxy_SendEnterKeyFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetMoveCursorFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_MoveCursorFunc moveCursorFunc)	Obtains the OH_TextEditorProxy_MoveCursorFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetHandleSetSelectionFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_HandleSetSelectionFunc handleSetSelectionFunc)	Obtains the OH_TextEditorProxy_HandleSetSelectionFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetHandleExtendActionFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_HandleExtendActionFunc handleExtendActionFunc)	Obtains the OH_TextEditorProxy_HandleExtendActionFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetGetLeftTextOfCursorFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_GetLeftTextOfCursorFunc getLeftTextOfCursorFunc)	Obtains the OH_TextEditorProxy_GetLeftTextOfCursorFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetGetRightTextOfCursorFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_GetRightTextOfCursorFunc getRightTextOfCursorFunc)	Obtains the OH_TextEditorProxy_GetRightTextOfCursorFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetGetTextIndexAtCursorFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_GetTextIndexAtCursorFunc getTextIndexAtCursorFunc)	Obtains the OH_TextEditorProxy_GetTextIndexAtCursorFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetReceivePrivateCommandFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_ReceivePrivateCommandFunc receivePrivateCommandFunc)	Obtains the OH_TextEditorProxy_ReceivePrivateCommandFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetSetPreviewTextFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_SetPreviewTextFunc setPreviewTextFunc)	Obtains the OH_TextEditorProxy_SetPreviewTextFunc function from InputMethod_TextEditorProxy.
InputMethod_ErrorCode OH_TextEditorProxy_GetFinishTextPreviewFunc (InputMethod_TextEditorProxy proxy, OH_TextEditorProxy_FinishTextPreviewFunc finishTextPreviewFunc)	Obtains the OH_TextEditorProxy_FinishTextPreviewFunc function from InputMethod_TextEditorProxy.