inputmethod_text_config_capi.h

Overview

Provides methods for creating, destroying, reading, and writing the text box configuration information objects.

Library: libohinputmethod.so

System capability: SystemCapability.MiscServices.InputMethodFramework

Since: 12

Related module: InputMethod

Summary

Types

Name Description
InputMethod_TextConfig Text box configuration.

Functions

Name Description
InputMethod_TextConfig * OH_TextConfig_Create () Creates an InputMethod_TextConfig instance.
void OH_TextConfig_Destroy (InputMethod_TextConfig *config) Destroys an InputMethod_TextConfig instance.
InputMethod_ErrorCode OH_TextConfig_SetInputType (InputMethod_TextConfig *config, InputMethod_TextInputType inputType) Sets the text box type for InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_SetEnterKeyType (InputMethod_TextConfig *config, InputMethod_EnterKeyType enterKeyType) Sets the Enter function type for InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_SetPreviewTextSupport (InputMethod_TextConfig *config, bool supported) Sets the text preview feature for InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_SetSelection (InputMethod_TextConfig *config, int32_t start, int32_t end) Sets the selected text area for InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_SetWindowId (InputMethod_TextConfig *config, int32_t windowId) Sets the ID of the window to which InputMethod_TextConfig belongs.
InputMethod_ErrorCode OH_TextConfig_GetInputType (InputMethod_TextConfig *config, InputMethod_TextInputType *inputType) Obtains the text box type of InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_GetEnterKeyType (InputMethod_TextConfig *config, InputMethod_EnterKeyType *enterKeyType) Obtains the Enter function type of InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_IsPreviewTextSupported (InputMethod_TextConfig *config, bool *supported) Obtains the text preview settings of InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_GetCursorInfo (InputMethod_TextConfig *config, InputMethod_CursorInfo **cursorInfo) Obtains the cursor information of InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_GetTextAvoidInfo (InputMethod_TextConfig *config, InputMethod_TextAvoidInfo **avoidInfo) Obtains the avoidance information of InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_GetSelection (InputMethod_TextConfig *config, int32_t *start, int32_t *end) Obtains the selected text area of InputMethod_TextConfig.
InputMethod_ErrorCode OH_TextConfig_GetWindowId (InputMethod_TextConfig *config, int32_t *windowId) Obtains the ID of the window to which InputMethod_TextConfig belongs.