OH_ArkUI_UIInputEvent_GetAction

arkui_sys::ui_input_event

Function OH_ArkUI_UIInputEvent_GetAction 

Source 
pub unsafe extern "C" fn OH_ArkUI_UIInputEvent_GetAction(
    event: *const ArkUI_UIInputEvent,
) -> i32
Available on crate feature api-12 only.
Expand description

Obtains the action type of this UI input event.

The action type defines the phase of a basic event (for example, start or end) and characterizes its behavior, such as touch down or touch up Action types are specific to the event category: UI_TOUCH_EVENT_ACTION_XXX for touch events and UI_MOUSE_EVENT_ACTION_XXX for mouse events.

Note: 1. For axis events, use OH_ArkUI_AxisEvent_GetAxisAction to obtain the action type, which returns UI_AXIS_EVENT_ACTION_XXX. 2. For key events, use [OH_ArkUI_KeyEvent_GetType] instead.

§Arguments

  • event - Pointer to the current UI input event.

§Returns

  • Returns the action type of the current UI input event; returns -1 if any parameter error occurs.

Available since API-level: 12