mirror of
https://gitee.com/openharmony/interface_sdk_c
synced 2024-11-23 14:50:20 +00:00
228 lines
9.2 KiB
C
228 lines
9.2 KiB
C
/*
|
|
* Copyright (c) 2024 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#ifndef OHOS_INPUTMETHOD_TEXT_CONFIG_CAPI_H
|
|
#define OHOS_INPUTMETHOD_TEXT_CONFIG_CAPI_H
|
|
/**
|
|
* @addtogroup InputMethod
|
|
* @{
|
|
*
|
|
* @brief InputMethod provides functions to use input methods and develop input methods.
|
|
*
|
|
* @since 12
|
|
*/
|
|
|
|
/**
|
|
* @file inputmethod_text_config_capi.h
|
|
*
|
|
* @brief Provides functions to manage the text configuration.
|
|
*
|
|
* @library libohinputmethod.so
|
|
* @kit IMEKit
|
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
|
* @since 12
|
|
* @version 1.0
|
|
*/
|
|
#include <stdint.h>
|
|
|
|
#include "inputmethod_cursor_info_capi.h"
|
|
#include "inputmethod_text_avoid_info_capi.h"
|
|
#include "inputmethod_types_capi.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
/**
|
|
* @brief Define the InputMethod_TextConfig structure type.
|
|
*
|
|
* The configuration of the text editor.
|
|
*
|
|
* @since 12
|
|
*/
|
|
typedef struct InputMethod_TextConfig InputMethod_TextConfig;
|
|
|
|
/**
|
|
* @brief Create a new {@link InputMethod_TextConfig} instance.
|
|
*
|
|
* @return If the creation succeeds, a pointer to the newly created {@link InputMethod_TextConfig}
|
|
* instance is returned. If the creation fails, NULL is returned, possible cause is insufficient memory.
|
|
* @since 12
|
|
*/
|
|
InputMethod_TextConfig *OH_TextConfig_Create();
|
|
/**
|
|
* @brief Destroy a {@link InputMethod_TextConfig} instance.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be destroyed.
|
|
* @since 12
|
|
*/
|
|
void OH_TextConfig_Destroy(InputMethod_TextConfig *config);
|
|
|
|
/**
|
|
* @brief Set input type into TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be set.
|
|
* @param inputType The text input type of text Editor, which is defined in {@link InputMethod_TextInputType}.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_SetInputType(InputMethod_TextConfig *config, InputMethod_TextInputType inputType);
|
|
/**
|
|
* @brief Set enter key type into TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be set.
|
|
* @param enterKeyType The enter key type of text Editor, which is defined in {@link InputMethod_EnterKeyType}.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_SetEnterKeyType(
|
|
InputMethod_TextConfig *config, InputMethod_EnterKeyType enterKeyType);
|
|
/**
|
|
* @brief Set is preview text supported into TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be set.
|
|
* @param supported Indicates whether the preview text is supported.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_SetIsPreviewTextSupported(InputMethod_TextConfig *config, bool supported);
|
|
/**
|
|
* @brief Set selection into TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be set.
|
|
* @param start The start position of selection.
|
|
* @param end The end position of selection.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_SetSelection(InputMethod_TextConfig *config, int32_t start, int32_t end);
|
|
/**
|
|
* @brief Set window id into TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be set.
|
|
* @param windowId The window ID of the application currently bound to the input method.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_SetWindowId(InputMethod_TextConfig *config, int32_t windowId);
|
|
|
|
/**
|
|
* @brief Get input type from TextConfig
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be get from.
|
|
* @param inputType Represents a pointer to an {@link InputMethod_TextInputType} instance.
|
|
* The text input type of text Editor
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_GetInputType(InputMethod_TextConfig *config, InputMethod_TextInputType *inputType);
|
|
/**
|
|
* @brief Get enter key type from TextConfig
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be get from.
|
|
* @param enterKeyType Represents a pointer to an {@link InputMethod_EnterKeyType} instance.
|
|
* Indicates the enter key type of text Editor
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_GetEnterKeyType(
|
|
InputMethod_TextConfig *config, InputMethod_EnterKeyType *enterKeyType);
|
|
/**
|
|
* @brief Get is preview text supported from TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be get from.
|
|
* @param supported Indicates whether the preview text is supported.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_IsPreviewTextSupported(InputMethod_TextConfig *config, bool *supported);
|
|
/**
|
|
* @brief Get cursor info from TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be get from.
|
|
* @param cursorInfo Represents a pointer to an {@link InputMethod_CursorInfo} instance.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_GetCursorInfo(InputMethod_TextConfig *config, InputMethod_CursorInfo **cursorInfo);
|
|
|
|
/**
|
|
* @brief Get text avoid information from text configuration.
|
|
*
|
|
* @param config Indicates the text configuration.
|
|
* @param avoidInfo Indicates the text avoid information.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
*@since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_GetTextAvoidInfo(
|
|
InputMethod_TextConfig *config, InputMethod_TextAvoidInfo **avoidInfo);
|
|
|
|
/**
|
|
* @brief Get selection from TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be get from.
|
|
* @param start Represents selection start position.
|
|
* @param end Represents selection end position.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_GetSelection(InputMethod_TextConfig *config, int32_t *start, int32_t *end);
|
|
/**
|
|
* @brief Get window id from TextConfig.
|
|
*
|
|
* @param config Represents a pointer to an {@link InputMethod_TextConfig} instance which will be get from.
|
|
* @param windowId The window ID of the application currently bound to the input method.
|
|
* @return Returns a specific error code.
|
|
* {@link IME_ERR_OK} - success.
|
|
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
|
|
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
|
|
* @since 12
|
|
*/
|
|
InputMethod_ErrorCode OH_TextConfig_GetWindowId(InputMethod_TextConfig *config, int32_t *windowId);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif // OHOS_INPUTMETHOD_TEXT_CONFIG_CAPI_H
|