openharmony/interface_sdk_c
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk_c synced 2024-11-27 08:51:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

modify capi

Browse Source 
Signed-off-by: zhaolinglan <zhaolinglan1@huawei.com>
This commit is contained in:
zhaolinglan 2024-08-22 15:10:46 +08:00
parent df6baafd7a
commit be21343d3e
4 changed files with 39 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
inputmethod/include/inputmethod_controller_capi.h
View File

@ -57,7 +57,10 @@ extern "C" {
* Lifecycle is mantianed until the next attach or detach call.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_PARAMCHECK} - The error code for common invalid args.
* {@link IME_ERR_PARAMCHECK} - parameter check failed.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
* @since 12
*/
@ -71,7 +74,9 @@ InputMethod_ErrorCode OH_InputMethodController_Attach(InputMethod_TextEditorProx
* The inputMethodProxy is obtained from {@link OH_InputMethodController_Attach}.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_PARAMCHECK} - The error code for common invalid args.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
* @since 12
*/

15
inputmethod/include/inputmethod_inputmethod_proxy_capi.h
View File

@ -58,6 +58,8 @@ typedef struct InputMethod_InputMethodProxy InputMethod_InputMethodProxy;
* The inputMethodProxy is obtained from {@link OH_InputMethodController_Attach}.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_DETACHED} - input method client is detached.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
@ -72,6 +74,8 @@ InputMethod_ErrorCode OH_InputMethodProxy_ShowKeyboard(InputMethod_InputMethodPr
* The inputMethodProxy is obtained from {@link OH_InputMethodController_Attach}.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_DETACHED} - input method client is detached.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
@ -92,6 +96,9 @@ InputMethod_ErrorCode OH_InputMethodProxy_HideKeyboard(InputMethod_InputMethodPr
* @param end The end position of selected text.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_PARAMCHECK} - parameter check failed.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_DETACHED} - input method client is detached.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
@ -109,6 +116,9 @@ InputMethod_ErrorCode OH_InputMethodProxy_NotifySelectionChange(
* @param textType The text input type.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_PARAMCHECK} - parameter check failed.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_DETACHED} - input method client is detached.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
@ -126,6 +136,9 @@ InputMethod_ErrorCode OH_InputMethodProxy_NotifyConfigurationChange(InputMethod_
* The cursor information.
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_PARAMCHECK} - parameter check failed.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_DETACHED} - input method client is detached.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
@ -144,6 +157,8 @@ InputMethod_ErrorCode OH_InputMethodProxy_NotifyCursorUpdate(
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_PARAMCHECK} - parameter check failed.
* {@link IME_ERR_IMCLIENT} - input method client error.
* {@link IME_ERR_IMMS} - input method manager service error.
* {@link IME_ERR_DETACHED} - input method client is detached.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.

3
inputmethod/include/inputmethod_private_command_capi.h
View File

@ -154,6 +154,7 @@ InputMethod_ErrorCode OH_PrivateCommand_GetValueType(
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* {@link IME_ERR_QUERY_FAILED} - query failed, no bool value in command.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
* @since 12
*/
@ -166,6 +167,7 @@ InputMethod_ErrorCode OH_PrivateCommand_GetBoolValue(InputMethod_PrivateCommand
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* {@link IME_ERR_QUERY_FAILED} - query failed, no integer value in command.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
* @since 12
*/
@ -179,6 +181,7 @@ InputMethod_ErrorCode OH_PrivateCommand_GetIntValue(InputMethod_PrivateCommand *
* @return Returns a specific error code.
* {@link IME_ERR_OK} - success.
* {@link IME_ERR_NULL_POINTER} - unexpected null pointer.
* {@link IME_ERR_QUERY_FAILED} - query failed, no string value in command.
* Specific error codes can be referenced {@link InputMethod_ErrorCode}.
* @since 12
*/

24
inputmethod/include/inputmethod_types_capi.h
View File

@ -42,7 +42,7 @@ extern "C"{
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_KeyboardStatus {
/**
* The keyboard status is none.
*/
@ -62,7 +62,7 @@ typedef enum {
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_EnterKeyType {
/**
* The enter key type is UNSPECIFIED.
*/
@ -106,7 +106,7 @@ typedef enum {
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_Direction {
/**
* The direction is NONE.
*/
@ -134,7 +134,7 @@ typedef enum {
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_ExtendAction {
/**
* Select all text.
*/
@ -158,7 +158,7 @@ typedef enum {
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_TextInputType {
/**
* The text input type is NONE.
*/
@ -222,7 +222,7 @@ typedef enum {
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_CommandValueType {
/**
* Value type is NONE.
*/
@ -246,16 +246,16 @@ typedef enum {
*
* @since 12
*/
typedef enum {
typedef enum InputMethod_ErrorCode {
/**
* The error code in the correct case.
*/
IME_ERR_OK = 0,
/**
* The error code when query failed.
* The error code when error is undefined.
*/
IME_ERR_QUERY_FAILED = 1,
IME_ERR_UNDEFINED = 1,
/**
* The error code when parameter check failed.
*/
@ -295,7 +295,11 @@ typedef enum {
/**
* The error code when unexpected null pointer.
*/
IME_ERR_NULL_POINTER = 12800010,
IME_ERR_NULL_POINTER = 12802000,
/**
* The error code when query failed.
*/
IME_ERR_QUERY_FAILED = 12802001,
} InputMethod_ErrorCode;
#ifdef __cplusplus
}