Module native_gesture 

Available on crate feature api-12 only.

Structs

ArkUI_GestureDirection

Enumerates gesture directions.

ArkUI_GestureEvent

Defines the gesture event.

ArkUI_GestureEventActionType

Enumerates gesture event types.

ArkUI_GestureEventTargetInfo

Defines a GestureEventTargetInfo object that provides information about a gesture event target.

ArkUI_GestureInterruptInfo

Defines the gesture interruption information.

ArkUI_GestureInterruptResult

Enumerates gesture interruption results.

ArkUI_GestureMask

Enumerates gesture masking modes.

ArkUI_GesturePriority

Enumerates gesture event modes.

ArkUI_GestureRecognizer

Defines a gesture recognizer.

ArkUI_GestureRecognizerState

Enumerates the gesture recognizer states.

ArkUI_GestureRecognizerType

Enumerates gesture types.

ArkUI_GroupGestureMode

Enumerates gesture group modes.

ArkUI_NativeGestureAPI_1

Defines the gesture APIs.

ArkUI_NativeGestureAPI_2api-18

Defines the gesture APIs.

ArkUI_ParallelInnerGestureEvent

Defines a parallel internal gesture event.

ArkUI_TouchRecognizerapi-15

Defines a touch recognizer.

Functions

OH_ArkUI_GestureEventTargetInfo_IsScrollBegin^⚠

Obtains whether this scroll container is scrolled to the top.

OH_ArkUI_GestureEventTargetInfo_IsScrollEnd^⚠

Obtains whether this scroll container is scrolled to the bottom.

OH_ArkUI_GestureEvent_GetActionType^⚠

Obtains the gesture event type.

OH_ArkUI_GestureEvent_GetRawInputEvent^⚠

Obtains gesture input.

OH_ArkUI_GestureInterruptInfo_GetGestureEvent^⚠

Obtains the pointer to the interrupted gesture event.

OH_ArkUI_GestureInterruptInfo_GetRecognizer^⚠

Obtains the pointer to interrupted gesture recognizer.

OH_ArkUI_GestureInterruptInfo_GetSystemFlag^⚠

Checks whether a gesture is a built-in gesture of the component.

OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType^⚠

Obtains the type of the system gesture to trigger.

OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers^⚠api-15

Get the touch recognizer handles from the gesture interrupt info.

OH_ArkUI_GestureInterrupter_GetUserData^⚠api-18

Obtains the custom data from a gesture interruption event.

OH_ArkUI_GetGestureBindNodeId^⚠

Obtains the ID of the component linked to a gesture recognizer.

OH_ArkUI_GetGestureEventTargetInfo^⚠

Obtains the information about a gesture event target.

OH_ArkUI_GetGestureParam_DirectMask^⚠api-18

Obtains the swipe direction of a gesture recognizer.

OH_ArkUI_GetGestureParam_FingerCount^⚠api-18

Obtains the number of fingers used by a gesture recognizer.

OH_ArkUI_GetGestureParam_angle^⚠api-18

Obtains the minimum angle change required for a rotation gesture to be recognized by a gesture recognizer.

OH_ArkUI_GetGestureParam_distance^⚠api-18

Obtains the allowed movement distance range for a gesture recognizer.

OH_ArkUI_GetGestureParam_distanceThreshold^⚠api-18

Obtains the movement threshold for gestures to be recognized by a gesture recognizer.

OH_ArkUI_GetGestureParam_duration^⚠api-18

Obtains the minimum duration required to trigger a long press by a gesture recognizer.

OH_ArkUI_GetGestureParam_limitFingerCount^⚠api-18

Checks whether a gesture recognizer has a finger count limit.

OH_ArkUI_GetGestureParam_repeat^⚠api-18

Checks whether a gesture recognizer supports repeated event callbacks.

OH_ArkUI_GetGestureParam_speed^⚠api-18

Obtains the minimum swipe speed recognized by a gesture recognizer.

OH_ArkUI_GetGestureRecognizerEnabled^⚠

Obtains the enabled state of a gesture recognizer.

OH_ArkUI_GetGestureRecognizerState^⚠

Obtains the state of a gesture recognizer.

OH_ArkUI_GetGestureTag^⚠

Obtains the tag of a gesture recognizer.

OH_ArkUI_GetPanGestureDirectionMask^⚠

Obtains the direction of a pan gesture.

OH_ArkUI_GetResponseRecognizersFromInterruptInfo^⚠

Obtains information about a gesture response chain.

OH_ArkUI_IsBuiltInGesture^⚠

Obtains whether a gesture is a built-in gesture.

OH_ArkUI_IsGestureRecognizerValid^⚠

Obtains whether a gesture recognizer is valid.

OH_ArkUI_LongPress_GetRepeatCount^⚠

Obtains the number of times that a long press gesture is triggered periodically.

OH_ArkUI_PanGesture_GetDistanceByToolType^⚠api-19

Obtains the movement threshold for gestures to be recognized by a gesture recognizer for a specific tool type.

OH_ArkUI_PanGesture_GetOffsetX^⚠

Obtains the relative offset of a pan gesture along the x-axis.

OH_ArkUI_PanGesture_GetOffsetY^⚠

Obtains the relative offset of a pan gesture along the y-axis.

OH_ArkUI_PanGesture_GetVelocity^⚠

Obtains the velocity of a pan gesture along the main axis.

OH_ArkUI_PanGesture_GetVelocityX^⚠

Obtains the velocity of a pan gesture along the x-axis.

OH_ArkUI_PanGesture_GetVelocityY^⚠

Obtains the velocity of a pan gesture along the y-axis.

OH_ArkUI_PanGesture_SetDistanceMap^⚠api-19

Sets the minimum movement distance thresholds for gestures to be recognized by a gesture recognizer.

OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers^⚠

Obtains the conflicting gesture recognizers in a parallel internal gesture event.

OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer^⚠

Obtains the current gesture recognizer in a parallel internal gesture event.

OH_ArkUI_ParallelInnerGestureEvent_GetUserData^⚠

Obtains custom data in the parallel internal gesture event.

OH_ArkUI_PinchGesture_GetCenterX^⚠

Obtains the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component.

OH_ArkUI_PinchGesture_GetCenterY^⚠

Obtains the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component.

OH_ArkUI_PinchGesture_GetScale^⚠

Obtains the scale ratio of a pinch gesture.

OH_ArkUI_PreventGestureRecognizerBegin^⚠api-20

Prevents a gesture recognizer from participating in the current gesture recognition before all fingers are lifted. If the system has already determined the result of the gesture recognizer (regardless of success or failure), calling this API will be ineffective.

OH_ArkUI_RotationGesture_GetAngle^⚠

Obtains the angle information of a rotation gesture.

OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify^⚠

Sets a callback function for notifying gesture recognizer destruction.

OH_ArkUI_SetGestureRecognizerEnabled^⚠

Sets the enabled state of a gesture recognizer.

OH_ArkUI_SetGestureRecognizerLimitFingerCount^⚠api-15

Sets whether to enable strict finger count checking. If this feature is enabled and the actual number of touch fingers does not match the set number, the gesture recognition fails.

OH_ArkUI_SetTouchTestDoneCallback^⚠api-20

Registers a callback that is executed after all gesture recognizers are collected. When the user begins touching the screen, the system performs hit testing and collects gesture recognizers based on the touch location. Subsequently, before processing any move events, the component can use this API to determine the gesture recognizers that will participate in and compete for recognition.

OH_ArkUI_SwipeGesture_GetAngle^⚠

Obtains the angle information of the swipe gesture.

OH_ArkUI_SwipeGesture_GetVelocity^⚠

Obtains the average velocity of all fingers used in the swipe gesture.

OH_ArkUI_TouchRecognizer_CancelTouch^⚠api-15

Send touch-cancel event to the touch recognizer in a gesture interruption callback.

OH_ArkUI_TouchRecognizer_GetNodeHandle^⚠api-15

Get component object of the specific touch recognizer.

Type Aliases

ArkUI_GestureDirectionMask

Defines a set of gesture directions.

ArkUI_GestureEventActionTypeMask

Defines a set of gesture event types.

ArkUI_GestureRecognizerDisposeNotifyCallback

Defines a callback function for notifying gesture recognizer destruction.

ArkUI_GestureRecognizerHandle

Defines the gesture recognizer handle.

ArkUI_GestureRecognizerHandleArray

Defines the gesture recognizer handle array.

ArkUI_TouchRecognizerHandleapi-15

Defines a touch recognizer handle.

ArkUI_TouchRecognizerHandleArrayapi-15

Defines an array of touch recognizer handle.