Module native_node

Available on crate feature api-12 only.

Structs

• ArkUI_AttributeItem
  Defines the general input parameter structure of the [setAttribute] function.
• ArkUI_NativeNodeAPI_1
  Declares a collection of native node APIs provided by ArkUI.
• ArkUI_NodeAdapter
• ArkUI_NodeAdapterEvent
• ArkUI_NodeAdapterEventType
  Enumerates component adapter events.
• ArkUI_NodeAttributeType
  Defines the ArkUI style attributes that can be set on the native side.
• ArkUI_NodeComponentEvent
  Defines the parameter type of the component callback event.
• ArkUI_NodeContentEvent
• ArkUI_NodeContentEventType
  Defines the node content event type.
• ArkUI_NodeCustomEvent
• ArkUI_NodeCustomEventType
  Defines the custom component event type.
• ArkUI_NodeDirtyFlag
  Defines the dirty area flag passed in the ::markDirty API.
• ArkUI_NodeEvent
• ArkUI_NodeEventType
  Enumerates the event types supported by the NativeNode component.
• ArkUI_NodeType
  Enumerates ArkUI component types that can be created on the native side.
• ArkUI_StringAsyncEvent
  Defines the string type parameter used by the component callback event.

Functions

• OH_ArkUI_GetContextByNode^⚠
  Obtain the UIContext pointer to the page where the node is located.
• OH_ArkUI_List_CloseAllSwipeActions^⚠
  Collapse the ListItem in its expanded state.
• OH_ArkUI_NodeAdapterEvent_GetHostNode^⚠
  Obtains the scrollable container node that uses the specified adapter.
• OH_ArkUI_NodeAdapterEvent_GetItemIndex^⚠
  Obtains the index of the element to be operated for the specified adapter event.
• OH_ArkUI_NodeAdapterEvent_GetRemovedNode^⚠
  Obtains the element to be removed for the event to be destroyed.
• OH_ArkUI_NodeAdapterEvent_GetType^⚠
  Obtains the event type.
• OH_ArkUI_NodeAdapterEvent_GetUserData^⚠
  Obtains the custom data passed in during registration of the specified event.
• OH_ArkUI_NodeAdapterEvent_SetItem^⚠
  Sets the component to be added to the specified adapter.
• OH_ArkUI_NodeAdapterEvent_SetNodeId^⚠
  Sets the component ID to be generated.
• OH_ArkUI_NodeAdapter_Create^⚠
  Creates a component adapter.
• OH_ArkUI_NodeAdapter_Dispose^⚠
  Destroys a component adapter.
• OH_ArkUI_NodeAdapter_GetAllItems^⚠
  Obtains all elements stored in the specified adapter.
• OH_ArkUI_NodeAdapter_GetTotalNodeCount^⚠
  Obtains the total number of elements in the specified adapter.
• OH_ArkUI_NodeAdapter_InsertItem^⚠
  Instructs the specified adapter to insert certain elements.
• OH_ArkUI_NodeAdapter_MoveItem^⚠
  Instructs the specified adapter to move certain elements.
• OH_ArkUI_NodeAdapter_RegisterEventReceiver^⚠
  Registers an event callback for the adapter.
• OH_ArkUI_NodeAdapter_ReloadAllItems^⚠
  Instructs the specified adapter to reload all elements.
• OH_ArkUI_NodeAdapter_ReloadItem^⚠
  Instructs the specified adapter to reload certain elements.
• OH_ArkUI_NodeAdapter_RemoveItem^⚠
  Instructs the specified adapter to remove certain elements.
• OH_ArkUI_NodeAdapter_SetTotalNodeCount^⚠
  Sets the total number of elements in the specified adapter.
• OH_ArkUI_NodeAdapter_UnregisterEventReceiver^⚠
  Deregisters an event callback for the adapter.
• OH_ArkUI_NodeContentEvent_GetEventType^⚠
  Obtains the type of a node content event.
• OH_ArkUI_NodeContentEvent_GetNodeContentHandle^⚠
  Obtains the node content object that triggers a node content event.
• OH_ArkUI_NodeContent_AddNode^⚠
  Add a node to a node content.
• OH_ArkUI_NodeContent_GetUserData^⚠
  Obtains the custom data saved on the specified node content.
• OH_ArkUI_NodeContent_InsertNode^⚠
  insert a node into a node content at a given position.
• OH_ArkUI_NodeContent_RegisterCallback^⚠
  register a callback functoin to a node content.
• OH_ArkUI_NodeContent_RemoveNode^⚠
  remove a node from a node content.
• OH_ArkUI_NodeContent_SetUserData^⚠
  Saves custom data on the specified node content.
• OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo^⚠
  Obtains the drawing information of a custom span through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo^⚠
  Obtains the measurement information of a custom span through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw^⚠
  Obtains the drawing context through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetEventTargetId^⚠
  Obtains the ID of a custom component event.
• OH_ArkUI_NodeCustomEvent_GetEventType^⚠
  Obtains the event type through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure^⚠
  Obtains the size constraint for measurement through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetNodeHandle^⚠
  Obtains a component object through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetPositionInLayout^⚠
  Obtains the expected position of a component relative to its parent component in the layout phase through a custom component event.
• OH_ArkUI_NodeCustomEvent_GetUserData^⚠
  Obtains custom event parameters through a custom component event.
• OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics^⚠
  Sets the measurement metrics of a custom span through a custom component event.
• OH_ArkUI_NodeEvent_GetEventType^⚠
  Obtains the type of a component event.
• OH_ArkUI_NodeEvent_GetInputEvent^⚠
  Obtains input event (for example, touch event) data for a component event.
• OH_ArkUI_NodeEvent_GetNodeComponentEvent^⚠
  Obtains the numerical data in a component event.
• OH_ArkUI_NodeEvent_GetNodeHandle^⚠
  Obtains the component object that triggers a component event.
• OH_ArkUI_NodeEvent_GetNumberValue^⚠
  Obtains the numeric-type parameter of a component event.
• OH_ArkUI_NodeEvent_GetStringAsyncEvent^⚠
  Obtains the string data in a component event.
• OH_ArkUI_NodeEvent_GetStringValue^⚠
  Obtains the string-type parameter of a component event. The string data is valid only during an event callback. To use it outside an event callback, you are advised to copy the string data.
• OH_ArkUI_NodeEvent_GetTargetId^⚠
  Obtains the custom ID of a component event.
• OH_ArkUI_NodeEvent_GetUserData^⚠
  Obtains the custom data in a component event.
• OH_ArkUI_NodeEvent_SetReturnNumberValue^⚠
  Sets the return value for a component event.
• OH_ArkUI_NodeUtils_AddCustomProperty^⚠api-13
  Add the custom property of the component. This interface only works on the main thread.
• OH_ArkUI_NodeUtils_GetLayoutPosition^⚠
  Obtain the position of the component layout area relative to the parent component. The relative position of the layout area does not include graphic variation attributes, such as translation.
• OH_ArkUI_NodeUtils_GetLayoutPositionInScreen^⚠
  Obtain the position of the component layout area relative to the screen. The relative position of the layout area does not include graphic variation attributes, such as translation.
• OH_ArkUI_NodeUtils_GetLayoutPositionInWindow^⚠
  Obtain the position of the component layout area relative to the window. The relative position of the layout area does not include graphic variation attributes, such as translation.
• OH_ArkUI_NodeUtils_GetLayoutSize^⚠
  Get the size of the component layout area. The layout area size does not include graphic variation attributes such as scaling.
• OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen^⚠
  Obtain the position of the component on the screen, including the attributes of graphic translation changes.
• OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow^⚠
  Obtain the position of the component in the window, including the properties of graphic translation changes.
• OH_ArkUI_NodeUtils_RemoveCustomProperty^⚠api-13
  Remove the custom property of the component.
• OH_ArkUI_RegisterSystemColorModeChangeEvent^⚠
  The event called when the system color mode changes. Only one system color change callback can be registered for the same component.
• OH_ArkUI_RegisterSystemFontStyleChangeEvent^⚠
  The event called when the system font style changes. Only one system font change callback can be registered for the same component.
• OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale^⚠
  Retrieve the font size value for system font change events.
• OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale^⚠
  Retrieve the font thickness values for system font change events.
• OH_ArkUI_UnregisterSystemColorModeChangeEvent^⚠
  Unregister the event callback when the system color mode changes.
• OH_ArkUI_UnregisterSystemFontStyleChangeEvent^⚠
  Unregister the event callback when the system font style changes.

Type Aliases

• ArkUI_NodeAdapterHandle
  Defines the component adapter, which is used for lazy loading of elements of scrollable components.
• ArkUI_NodeContentCallback
  Defines the callback function of a node content event.