diff --git a/arkui/ace_engine/native/ui_input_event.h b/arkui/ace_engine/native/ui_input_event.h index a13728fe50da5166a9e103e72b83ea0ff757db7d..b024f4bdf93f0550ff93b5eb8f6262566dbf703c 100644 --- a/arkui/ace_engine/native/ui_input_event.h +++ b/arkui/ace_engine/native/ui_input_event.h @@ -36,9 +36,9 @@ #ifndef _ARKUI_UI_INPUT_EVENT_H_ #define _ARKUI_UI_INPUT_EVENT_H_ -#include "native_type.h" #include +#include "native_type.h" #ifdef __cplusplus extern "C" { #endif @@ -429,7 +429,7 @@ float OH_ArkUI_PointerEvent_GetXByIndex(const ArkUI_UIInputEvent* event, uint32_ * * @param event Indicates the pointer to the UI input event. * @return Returns the Y coordinate relative to the upper left corner of the current component; - * returns 0 if any parameter error occurs. + * returns 0.0 if any parameter error occurs. * @since 12 */ float OH_ArkUI_PointerEvent_GetY(const ArkUI_UIInputEvent* event); @@ -453,7 +453,7 @@ float OH_ArkUI_PointerEvent_GetYByIndex(const ArkUI_UIInputEvent* event, uint32_ * * @param event Indicates the pointer to the UI input event. * @return Returns the X coordinate relative to the upper left corner of the current application window; - * returns 0 if any parameter error occurs. + * returns 0.0 if any parameter error occurs. * @since 12 */ float OH_ArkUI_PointerEvent_GetWindowX(const ArkUI_UIInputEvent* event); @@ -477,7 +477,7 @@ float OH_ArkUI_PointerEvent_GetWindowXByIndex(const ArkUI_UIInputEvent* event, u * * @param event Indicates the pointer to the UI input event. * @return Returns the Y coordinate relative to the upper left corner of the current application window; - * returns 0 if any parameter error occurs. + * returns 0.0 if any parameter error occurs. * @since 12 */ float OH_ArkUI_PointerEvent_GetWindowY(const ArkUI_UIInputEvent* event); @@ -501,7 +501,7 @@ float OH_ArkUI_PointerEvent_GetWindowYByIndex(const ArkUI_UIInputEvent* event, u * * @param event Indicates the pointer to the UI input event. * @return Returns the X coordinate relative to the upper left corner of the current screen; - * returns 0 if any parameter error occurs. + * returns 0.0 if any parameter error occurs. * @since 12 */ float OH_ArkUI_PointerEvent_GetDisplayX(const ArkUI_UIInputEvent* event); @@ -525,7 +525,7 @@ float OH_ArkUI_PointerEvent_GetDisplayXByIndex(const ArkUI_UIInputEvent* event, * * @param event Indicates the pointer to the UI input event. * @return Returns the Y coordinate relative to the upper left corner of the current screen; - * returns 0 if any parameter error occurs. + * returns 0.0 if any parameter error occurs. * @since 12 */ float OH_ArkUI_PointerEvent_GetDisplayY(const ArkUI_UIInputEvent* event); @@ -666,8 +666,9 @@ float OH_ArkUI_PointerEvent_GetTouchAreaHeight(const ArkUI_UIInputEvent* event, * @brief Checks whether an event is triggered by the user's left or right hand. * This API is only effective on some touch devices. * - * @note The value is not available immediately upon press. Until the system infers the result, this API will return - * NONE. Do not rely on the return value for critical functionality. + * @note This value cannot be obtained in real time when pressed. Before the + * system completes result inference, it will return NONE by default. Therefore, + * please do not over-rely on the results returned by this interface. * * @param event Pointer to the current UI input event. * @param hand Whether the touch point is from the left or right hand. @@ -682,8 +683,9 @@ int32_t OH_ArkUI_PointerEvent_GetInteractionHand(const ArkUI_UIInputEvent *event * @brief Checks whether an event is triggered by the user's left or right hand. * This API is only effective on some touch devices. * - * @note The value is not available immediately upon press. Until the system infers the result, - * this API will return NONE. Do not rely on the return value for critical functionality. + * @note This value cannot be obtained in real time when pressed. Before the + * system completes result inference, it will return NONE by default. Therefore, + * please do not over-rely on the results returned by this interface. * * @param event Pointer to the current UI input event. * @param pointerIndex Index of the target touch point in the multi-touch data list.