OH_ArkUI_AxisEvent_GetHorizontalAxisValue

arkui_sys::ui_input_event

Function OH_ArkUI_AxisEvent_GetHorizontalAxisValue 

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

Obtains the value of the horizontal scroll axis for this axis event. This value is generated by two-finger horizontal swiping on a touchpad.

Note: 1. The reported value is in px and represents the incremental scroll amount, not the total scroll amount. 2. The reported value does not include the user’s scroll step configuration. 3. The sign of the value indicates the direction: positive for swiping right and negative for swiping left. 4. The direction is affected by the system settings for natural scrolling.

§Arguments

  • event - Pointer to the current UI input event.

§Returns

  • Returns the value of the horizontal scroll axis of the current axis event; returns 0 if any parameter error occurs.

Available since API-level: 12