Crate xcomponent_sys

Source:

English Documentation Chinese Documentation

Feature flags

• keyboard-types — Provides optional conversion from the OH keyboard enum to the keyboard-types enum.
• document-features — Document available features when building the documentation

Modules

• keyboard_types_compatkeyboard-types

Structs

• OH_NativeXComponent
• OH_NativeXComponent_Callback
  @brief Registers the surface lifecycle and touch event callbacks.
• OH_NativeXComponent_EventSourceType
  @brief Represents the touch event source type.
• OH_NativeXComponent_ExpectedRateRangeapi-11
  @brief Defines the expected frame rate range struct.
• OH_NativeXComponent_HistoricalPoint
• OH_NativeXComponent_KeyAction
  @brief Represents the key event action.
• OH_NativeXComponent_KeyCode
  @brief Represents the key event code.
• OH_NativeXComponent_KeyEvent
• OH_NativeXComponent_MouseEvent
  @brief Represents the mouse event information.
• OH_NativeXComponent_MouseEventAction
  @brief Represents the mouse event action.
• OH_NativeXComponent_MouseEventButton
  @brief Represents the mouse event button.
• OH_NativeXComponent_MouseEvent_Callback
  @brief Registers the mouse event callbacks.
• OH_NativeXComponent_TouchEvent
• OH_NativeXComponent_TouchEventType
• OH_NativeXComponent_TouchEvent_SourceTool
  @brief Represents the source tool type of TouchEvent
• OH_NativeXComponent_TouchPoint
• OH_NativeXComponent_TouchPointToolType
  @brief Represents the touch point tool type.
• _bindgen_ty_1
  @brief Enumerates the API access states.

Constants

• OH_MAX_TOUCH_POINTS_NUMBER
• OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER
  Invalid parameters.
• OH_NATIVEXCOMPONENT_RESULT_FAILED
  Failed.
• OH_NATIVEXCOMPONENT_RESULT_SUCCESS
  Successful.
• OH_NATIVE_XCOMPONENT_OBJ
• OH_XCOMPONENT_ID_LEN_MAX

Functions

• OH_NativeXComponent_GetHistoricalPoints^⚠
  @brief Obtains the touch event dispatched by the ArkUI XComponent.
• OH_NativeXComponent_GetKeyEvent^⚠
  @brief Obtains the key event dispatched by the ArkUI XComponent.
• OH_NativeXComponent_GetKeyEventAction^⚠
  @brief Obtains the action of the key event.
• OH_NativeXComponent_GetKeyEventCode^⚠
  @brief Obtains the keyCode of the key event.
• OH_NativeXComponent_GetKeyEventDeviceId^⚠
  @brief Obtains the deviceId of the key event.
• OH_NativeXComponent_GetKeyEventSourceType^⚠
  @brief Obtains the sourceType of the key event.
• OH_NativeXComponent_GetKeyEventTimestamp^⚠
  @brief Obtains the timestamp of the key event.
• OH_NativeXComponent_GetMouseEvent^⚠
  @brief Obtains the mouse event dispatched by the ArkUI XComponent.
• OH_NativeXComponent_GetTouchEvent^⚠
  @brief Obtains the touch event dispatched by the ArkUI XComponent.
• OH_NativeXComponent_GetTouchPointTiltX^⚠
  @brief Obtains the touch pointer tiltX by the ArkUI XComponent.
• OH_NativeXComponent_GetTouchPointTiltY^⚠
  @brief Obtains the touch pointer tiltX by the ArkUI XComponent.
• OH_NativeXComponent_GetTouchPointToolType^⚠
  @brief Obtains the touch pointer tool type by the ArkUI XComponent.
• OH_NativeXComponent_GetXComponentId^⚠
  @brief Obtains the ID of the ArkUI XComponent.
• OH_NativeXComponent_GetXComponentOffset^⚠
  @brief Obtains the offset of the surface held by the ArkUI XComponent.
• OH_NativeXComponent_GetXComponentSize^⚠
  @brief Obtains the size of the surface held by the ArkUI XComponent.
• OH_NativeXComponent_RegisterBlurEventCallback^⚠
  @brief Registers a callback for this OH_NativeXComponent instance.
• OH_NativeXComponent_RegisterCallback^⚠
  @brief Registers a callback for this OH_NativeXComponent instance.
• OH_NativeXComponent_RegisterFocusEventCallback^⚠
  @brief Registers a callback for this OH_NativeXComponent instance.
• OH_NativeXComponent_RegisterKeyEventCallback^⚠
  @brief Registers a callback for this OH_NativeXComponent instance.
• OH_NativeXComponent_RegisterMouseEventCallback^⚠
  @brief Registers a callback for this OH_NativeXComponent instance.
• OH_NativeXComponent_RegisterOnFrameCallback^⚠api-11
  @brief Registers a callback for this OH_NativeXComponent instance.
• OH_NativeXComponent_SetExpectedFrameRateRange^⚠api-11
  @brief Set the Expected FrameRateRange.
• OH_NativeXComponent_UnregisterOnFrameCallback^⚠api-11
  @brief UnRegister a callback for this OH_NativeXComponent instance.