目录

common_type.h

概述

定义ArkUI Native API的公共类型。

引用文件: <arkui/common_type.h>

库: libace_ndk.z.so

系统能力: SystemCapability.ArkUI.ArkUI.Full

起始版本: 12

相关模块: ArkUI_NativeModule

汇总

[h2]结构体

名称 typedef关键字 描述
ArkUI_ContextCallback ArkUI_ContextCallback 事件回调类型,用于定义回调函数及其用户自定义数据。使用该类型的接口触发回调时,会调用callback,并将userData作为参数传入。
ArkUI_NumberValue ArkUI_NumberValue ArkUI在Native侧使用的数字类型,用于通过统一类型承载浮点、有符号整型和无符号整型数值。
ArkUI_AttributeItem ArkUI_AttributeItem 定义setAttribute函数的通用入参结构。各个属性设置接口可选择使用其中的成员变量来存储特定类型的参数数据。
ArkUI_Rect ArkUI_Rect 定义遮罩屏蔽区域的范围结构体。
ArkUI_IntSize ArkUI_IntSize 尺寸类型,用于描述组件的宽高。
ArkUI_IntOffset ArkUI_IntOffset 偏移量,用于描述当前组件相对于父组件的位置。
ArkUI_Node* ArkUI_NodeHandle 定义ArkUI Native组件实例对象指针,用于在ArkUI Native接口中标识和传递组件实例,例如创建、挂载、移除或销毁组件节点。
ArkUI_NodeContent* ArkUI_NodeContentHandle 定义ArkUI_NodeContent在Native侧的实例对象指针,用于在Native接口中引用和传递NodeContent实例。
ArkUI_LayoutConstraint ArkUI_LayoutConstraint 布局约束,用于组件布局时进行尺寸范围限制。支持设置最小尺寸和最大尺寸约束,约束值为非负浮点数,在组件布局时,系统会根据约束值限定组件的最终尺寸范围,确保布局结果符合约束条件。适用于自定义布局容器时控制子组件的尺寸范围,如瀑布流布局中限制图片卡片的高度、网格布局中限制单元格尺寸,以及需要限制组件尺寸上下限的场景,如图片展示组件限制最大宽度防止拉伸、响应式布局中限制最小尺寸保证可读性。防止组件尺寸超出预期范围,实现更精确的布局控制,提高布局的可预测性和稳定性,增强界面的可控性。
ArkUI_DrawContext ArkUI_DrawContext 定义组件绘制上下文的结构体类型,用于在自定义组件绘制过程中提供绘制上下文信息,可获取用于绘制的Canvas指针和可绘制区域大小。
ArkUI_Context ArkUI_Context native UI的上下文实例对象。
ArkUI_Context* ArkUI_ContextHandle ArkUI在Native侧的上下文实例对象指针,用于表示组件所在页面的UIContext。开发者可通过OH_ArkUI_GetContextByNode或OH_ArkUI_GetContextFromNapiValue获取该指针,并将其作为UI任务调度、动画、焦点控制等接口的上下文入参。
ArkUI_NodeEvent ArkUI_NodeEvent 定义组件事件的通用结构类型,用于在组件事件处理流程中传递事件信息。