diff --git a/en/native_sdk/ace/native_node.h b/en/native_sdk/ace/native_node.h index 198295ec0710ee34c9f19b4f7d97e13dbf0f37d8..d9f3e10a92b7e19e54981b10578b756bb42a8b2f 100644 --- a/en/native_sdk/ace/native_node.h +++ b/en/native_sdk/ace/native_node.h @@ -1388,6 +1388,95 @@ typedef enum { */ NODE_OUTLINE_WIDTH, + /** + * @brief Defines the width attribute, which can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].f32: width, in percentage. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: width, in percentage. \n + * + */ + NODE_WIDTH_PERCENT, + /** + * @brief Defines the height attribute, which can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].f32: height, in percentage. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: height, in percentage. \n + * + */ + NODE_HEIGHT_PERCENT, + /** + * @brief Defines the padding attribute, which can be set, reset, and obtained as required through APIs. + * + * There are two formats of {@link ArkUI_AttributeItem} for setting the attribute value:\n + * 1: Specify the same padding for the four directions. \n + * .value[0].f32: padding, in percentage. \n + * 2: Specify different paddings for different directions. \n + * .value[0].f32: top padding, in percentage. \n + * .value[1].f32: right padding, in percentage. \n + * .value[2].f32: bottom padding, in percentage. \n + * .value[3].f32: left padding, in percentage. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: top padding, in percentage. \n + * .value[1].f32: right padding, in percentage. \n + * .value[2].f32: bottom padding, in percentage. \n + * .value[3].f32: left padding, in percentage. \n + * + */ + NODE_PADDING_PERCENT, + /** + * @brief Defines the margin attribute, which can be set, reset, and obtained as required through APIs. + * + * There are two formats of {@link ArkUI_AttributeItem} for setting the attribute value:\n + * 1: Specify the same margin for the four directions. \n + * .value[0].f32: margin, in percentage. \n + * 2: Specify different margins for different directions. \n + * .value[0].f32: top margin, in percentage. \n + * .value[1].f32: right margin, in percentage. \n + * .value[2].f32: bottom margin, in percentage. \n + * .value[3].f32: left margin, in percentage. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: top margin, in percentage. \n + * .value[1].f32: right margin, in percentage. \n + * .value[2].f32: bottom margin, in percentage. \n + * .value[3].f32: left margin, in percentage. \n + * + */ + NODE_MARGIN_PERCENT, + + /** + * @brief Implements an implicit shared element transition. + * This attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].i32: two components bound to the shared element. The parameter type is 1 or 0. + * By default, the out component does not continue to participate in the shared element animation when not yet + * deleted, which means that it stays in its original position. \n + * .string: ID used to set up a binding relationship. If it is set to an empty string "", the binding + * relationship is cleared. + * The value can be dynamically changed to refresh the binding relationship. One ID can be bound to only two + * components, which function as in and out components. + * Multiple components cannot be bound to the same ID. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].i32: two components bound to the shared element. The parameter type is 1 or 0. + * By default, the out component does not continue to participate in the shared element animation when not yet + * deleted, which means that it stays in its original position. \n + * .string: ID used to set up a binding relationship. If it is set to an empty string "", the binding + * relationship is cleared. + * The value can be dynamically changed to refresh the binding relationship. One ID can be bound to only two + * components, which function as in and out components. + * Multiple components cannot be bound to the same ID. \n + */ + NODE_GEOMETRY_TRANSITION, + /** * @brief Sets the parameters of the chain in which the component is the head. * This attribute can be set, reset, and obtained as required through APIs. @@ -1408,8 +1497,8 @@ typedef enum { * process. This attribute can be set, reset, and obtained as required through APIs. * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: how the final state of the component's content is rendered. The value is an enum of - * {@link ArkUI_RenderFit}. \n + * .value[0].i32: how the final state of the component's content is rendered. + * The value is an enum of {@link ArkUI_RenderFit}. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n * .value[0].i32: how the final state of the component's content is rendered. @@ -1422,17 +1511,17 @@ typedef enum { * @brief Defines the outline color. This attribute can be set, reset, and obtained as required through APIs. * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * 1: .value[0].u32: color of the four outlines, in 0xARGB format, for example, 0xFFFF11FF. \n - * 2: .value[0].u32: color of the top outline, in 0xARGB format, for example, 0xFFFF11FF. \n - * .value[1].u32: color of the right outline, in 0xARGB format, for example, 0xFFFF11FF. \n - * .value[2].u32: color of the bottom outline, in 0xARGB format, for example, 0xFFFF11FF. \n - * .value[3].u32: color of the left outline, in 0xARGB format, for example, 0xFFFF11FF. \n + * 1: .value[0].u32: color of the four borders, in 0xARGB format, for example, 0xFFFF11FF. \n + * 2: .value[0].u32: color of the top border, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[1].u32: color of the right border, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[2].u32: color of the lower border, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[3].u32: color of the left border, in 0xARGB format, for example, 0xFFFF11FF. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].u32: color of the top outline, in 0xARGB format, for example, 0xFFFF11FF. \n - * .value[1].u32: color of the right outline, in 0xARGB format, for example, 0xFFFF11FF. \n - * .value[2].u32: color of the bottom outline, in 0xARGB format, for example, 0xFFFF11FF. \n - * .value[3].u32: color of the left outline, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[0].u32: color of the top border, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[1].u32: color of the right border, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[2].u32: color of the lower border, in 0xARGB format, for example, 0xFFFF11FF. \n + * .value[3].u32: color of the left border, in 0xARGB format, for example, 0xFFFF11FF. \n * */ NODE_OUTLINE_COLOR, @@ -1483,130 +1572,152 @@ typedef enum { * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n * .value[0].i32: foreground blur style. The value is an enum of {@link ArkUI_BlurStyle}. \n - * .value[1]?.i32: color mode used for the foreground blur. The value is an enum of {@link ArkUI_ThemeColorMode}. \n - * .value[2]?.i32: adaptive color mode used for the foreground blur. - * The value is an enum of {@link ArkUI_AdaptiveColor}. \n - * .value[3]?.i32: grayscale blur parameters. The value range is [0, 127]. \n - * .value[4]?.i32: grayscale blur parameters. The value range is [0, 127]. \n + * .value[1]?.i32: color mode used for the foreground blur. The value is an enum of {@link ArkUI_ColorMode}. \n + * .value[2]?.i32: adaptive color mode used for the foreground blur. The value is an enum of + * {@link ArkUI_AdaptiveColor}. \n + * .value[3]? .f32: blur degree. The value range is [0.0, 1.0]. \n + * .value[4]?.i32: brightness of black in the grayscale blur. The value range is [0, 127]. \n + * .value[5]?.i32: degree of darkening the white color in the grayscale blur. The value range is [0, 127]. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n * .value[0].i32: foreground blur style. The value is an enum of {@link ArkUI_BlurStyle}. \n - * .value[1].i32: color mode used for the foreground blur. The value is an enum of {@link ArkUI_ThemeColorMode}. \n - * .value[2].i32: adaptive color mode used for the foreground blur. - * The value is an enum of {@link ArkUI_AdaptiveColor}. \n - * .value[3].i32: grayscale blur parameters. The value range is [0, 127]. \n - * .value[4].i32: grayscale blur parameters. The value range is [0, 127]. \n + * .value[1].i32: color mode used for the foreground blur. The value is an enum of {@link ArkUI_ColorMode}. \n + * .value[2].i32: adaptive color mode used for the foreground blur. The value is an enum of + * {@link ArkUI_AdaptiveColor}. \n + * .value[3].f32: blur degree. The value range is [0.0, 1.0]. \n + * .value[4].i32: brightness of black in the grayscale blur. The value range is [0, 127]. \n + * .value[5].i32: degree of darkening the white color in the grayscale blur. The value range is [0, 127]. \n * */ NODE_FOREGROUND_BLUR_STYLE, /** - * @brief Implements an implicit shared element transition. + * @brief Defines the component size and position for layout. * This attribute can be set, reset, and obtained as required through APIs. * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: two components bound to the shared element. The parameter type is 1 or 0. - * By default, the out component does not continue to participate in the shared element animation when not yet - * deleted, which means that it stays in its original position. \n - * .string: ID used to set up a binding relationship. If it is set to an empty string "", the binding - * relationship is cleared. - * The value can be dynamically changed to refresh the binding relationship. One ID can be bound to only two - * components, which function as in and out components. - * Multiple components cannot be bound to the same ID. \n + * .value[0].i32: X coordinate of the component, in px. \n + * .value[1].i32: Y coordinate of the component, in px. \n + * .value[2].i32: width of the component, in px. \n + * .value[3].i32: height of the component, in px. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: two components bound to the shared element. The parameter type is 1 or 0. - * By default, the out component does not continue to participate in the shared element animation when not yet - * deleted, which means that it stays in its original position. \n - * .string: ID used to set up a binding relationship. If it is set to an empty string "", the binding - * relationship is cleared. - * The value can be dynamically changed to refresh the binding relationship. One ID can be bound to only two - * components, which function as in and out components. - * Multiple components cannot be bound to the same ID. \n + * .value[0].i32: X coordinate of the component, in px. \n + * .value[1].i32: Y coordinate of the component, in px. \n + * .value[2].i32: width of the component, in px. \n + * .value[3].i32: height of the component, in px. \n + * */ - NODE_GEOMETRY_TRANSITION, + NODE_LAYOUT_RECT, /** - * @brief Defines the width attribute, which can be set, reset, and obtained as required through APIs. + * @brief Sets whether the component is focusable on touch. + * This attribute can be set, reset, and obtained as required through APIs. * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].f32: width, in percentage. \n + * .value[0].i32: The parameter type is 1 or 0. * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].f32: width, in percentage. \n + * .value[0].i32: The parameter type is 1 or 0. * */ - NODE_WIDTH_PERCENT, + NODE_FOCUS_ON_TOUCH, + /** - * @brief Defines the height attribute, which can be set, reset, and obtained as required through APIs. + * @brief Sets the custom accessibility ID. This attribute can be obtained. + * + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].i32: custom accessibility ID. \n + * + */ + NODE_ACCESSIBILITY_ID, + + /** + * @brief Sets the accessibility action type. + * This attribute can be set, reset, and obtained as required through APIs. * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].f32: height, in percentage. \n + * .value[0].u32: accessibility action type. The parameter type is {@link ArkUI_AccessibilityActionType}. * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].f32: height, in percentage. \n + * .value[0].u32: accessibility action type. The parameter type is {@link ArkUI_AccessibilityActionType}. * */ - NODE_HEIGHT_PERCENT, + NODE_ACCESSIBILITY_ACTIONS, + /** - * @brief Defines the padding attribute, which can be set, reset, and obtained as required through APIs. + * @brief Sets the accessibility component type. + * This attribute can be set, reset, and obtained as required through APIs. * - * There are two formats of {@link ArkUI_AttributeItem} for setting the attribute value:\n - * 1: Specify the same padding for the four directions. \n - * .value[0].f32: padding, in percentage. \n - * 2: Specify different paddings for different directions. \n - * .value[0].f32: top padding, in percentage. \n - * .value[1].f32: right padding, in percentage. \n - * .value[2].f32: bottom padding, in percentage. \n - * .value[3].f32: left padding, in percentage. \n + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].u32: accessibility component type. The parameter type is {@link ArkUI_NodeType}. * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].f32: top padding, in percentage. \n - * .value[1].f32: right padding, in percentage. \n - * .value[2].f32: bottom padding, in percentage. \n - * .value[3].f32: left padding, in percentage. \n + * .value[0].u32: accessibility component type. The parameter type is {@link ArkUI_NodeType}. * */ - NODE_PADDING_PERCENT, + NODE_ACCESSIBILITY_ROLE, + /** - * @brief Defines the margin attribute, which can be set, reset, and obtained as required through APIs. + * @brief Sets the accessibility state. This attribute can be set, reset, and obtained as required through APIs. * - * There are two formats of {@link ArkUI_AttributeItem} for setting the attribute value:\n - * 1: Specify the same margin for the four directions. \n - * .value[0].f32: margin, in percentage. \n - * 2: Specify different margins for different directions. \n - * .value[0].f32: top margin, in percentage. \n - * .value[1].f32: right margin, in percentage. \n - * .value[2].f32: bottom margin, in percentage. \n - * .value[3].f32: left margin, in percentage. \n + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .object: accessibility state. The parameter type is {@link ArkUI_AccessibilityState}. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].f32: top margin, in percentage. \n - * .value[1].f32: right margin, in percentage. \n - * .value[2].f32: bottom margin, in percentage. \n - * .value[3].f32: left margin, in percentage. \n + * .object: accessibility state. The parameter type is {@link ArkUI_AccessibilityState}. \n * */ - NODE_MARGIN_PERCENT, + NODE_ACCESSIBILITY_STATE, /** - * @brief Defines the component size and position for layout. - * This attribute can be set, reset, and obtained as required through APIs. + * @brief Sets the accessibility value. This attribute can be set, reset, and obtained as required through APIs. * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: X coordinate of the component, in px. \n - * .value[1].i32: Y coordinate of the component, in px. \n - * .value[2].i32: width of the component, in px. \n - * .value[3].i32: height of the component, in px. \n + * .object: accessibility value. The parameter type is {@link ArkUI_AccessibilityValue}. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: X coordinate of the component, in px. \n - * .value[1].i32: Y coordinate of the component, in px. \n - * .value[2].i32: width of the component, in px. \n - * .value[3].i32: height of the component, in px. \n + * .object: accessibility value. The parameter type is {@link ArkUI_AccessibilityValue}. \n * */ - NODE_LAYOUT_RECT, + NODE_ACCESSIBILITY_VALUE, + + /** + * @brief Defines the border width attribute, which can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * 1: .value[0].f32: width of the four borders, in percentage. \n + * 2: .value[0].f32: width of the top border, in percentage. \n + * .value[1].f32: width of the right border, in percentage. \n + * .value[2].f32: width of the bottom border, in percentage. \n + * .value[3].f32: width of the right border, in percentage. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: width of the top border, in percentage. \n + * .value[1].f32: width of the right border, in percentage. \n + * .value[2].f32: width of the bottom border, in percentage. \n + * .value[3].f32: width of the right border, in percentage. \n + * + */ + NODE_BORDER_WIDTH_PERCENT, + /** + * @brief Defines the border corner radius attribute, which can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * 1: .value[0].f32: radius of the four corners, in percentage. \n + * 2: .value[0].f32: radius of the upper left corner, in percentage. \n + * .value[1].f32: radius of the upper right corner, in percentage. \n + * .value[2].f32: radius of the lower left corner, in percentage. \n + * .value[3].f32: radius of the lower right corner, in percentage. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: radius of the upper left corner, in percentage. \n + * .value[1].f32: radius of the upper right corner, in percentage. \n + * .value[2].f32: radius of the lower left corner, in percentage. \n + * .value[3].f32: radius of the lower right corner, in percentage. \n + * + */ + NODE_BORDER_RADIUS_PERCENT, /** * @brief Defines the text content attribute, which can be set, reset, and obtained as required through APIs. @@ -1894,6 +2005,17 @@ typedef enum { * */ NODE_TEXT_ELLIPSIS_MODE, + /** + * @brief Defines the line spacing attribute, which can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].f32: line spacing, in fp. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: line spacing, in fp. \n + * + */ + NODE_TEXT_LINE_SPACING, /** * @brief Sets the font feature. * NODE_FONT_FEATURE provides advanced typographic features in OpenType fonts. \n @@ -1979,6 +2101,18 @@ typedef enum { * */ NODE_SPAN_TEXT_BACKGROUND_STYLE, + /** + * @brief Defines the text baseline offset attribute. + * This attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].f32: baseline offset, in fp.\n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].f32: baseline offset, in fp. \n + * + */ + NODE_SPAN_BASELINE_OFFSET, /** * @brief Defines the image source of the image span. * This attribute can be set, reset, and obtained as required through APIs. @@ -2008,6 +2142,21 @@ typedef enum { * */ NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT, + /** + * @brief Defines the image source for the image span. + * This attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .string: image source for the image span. \n + * .object: PixelMap object. The parameter type is {@link ArkUI_DrawableDesciptor}. + * Either .object or .string must be set. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .string: image source for the image span. \n + * .object: PixelMap object. The parameter type is {@link ArkUI_DrawableDesciptor}. \n + * + */ + NODE_IMAGE_SPAN_ALT, /** * @brief Defines the image source of the component. * This attribute can be set, reset, and obtained as required through APIs. @@ -2090,9 +2239,12 @@ typedef enum { * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n * .string: placeholder image source. \n + * .object: PixelMap object. The parameter type is {@link ArkUI_DrawableDesciptor}. + * Either .object or .string must be set. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n * .string: placeholder image source. \n + * .object: PixelMap object. The parameter type is {@link ArkUI_DrawableDesciptor}. \n * */ NODE_IMAGE_ALT, @@ -4468,6 +4620,19 @@ typedef enum { */ NODE_SWIPER_SWIPE_TO_INDEX, + /** + * @brief Sets the swipe action item displayed when the list item is swiped out from the screen edge. + * This attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .object: {@link ArkUI_ListItemSwipeActionOption} object. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .object: {@link ArkUI_ListItemSwipeActionOption} object. \n + * + */ + NODE_LIST_ITEM_SWIPE_ACTION = MAX_NODE_SCOPE_NUM * ARKUI_NODE_LIST_ITEM, + /** * @brief Defines the header of the list item group. * This attribute can be set, reset, and obtained as required through APIs. @@ -5055,6 +5220,18 @@ typedef enum { * {@link ArkUI_UIInputEvent}. \n */ NODE_ON_MOUSE, + /** + * @brief Defines the event triggered when an accessibility action of the preconfigured type is performed. + * + * \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n + * {@link ArkUI_NodeComponentEvent} contains one parameter:\n + * ArkUI_NodeComponentEvent.data[0].u32: action type. The parameter type is + * {@link ArkUI_AccessibilityActionType}. \n + * + */ + NODE_ON_ACCESSIBILITY_ACTIONS, /** * @brief Defines the event triggered when text recognition with the configured TextDataDetectorConfig * settings succeeds. @@ -5113,7 +5290,8 @@ typedef enum { * @brief Defines the event triggered when an online image is being downloaded. * * \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains two parameters: \n * ArkUI_NodeComponentEvent.data[0].u32: number of bytes that have been downloaded. \n * ArkUI_NodeComponentEvent.data[1].u32: total number of bytes of the image to be downloaded. \n @@ -5217,7 +5395,8 @@ typedef enum { * @brief Defines the event triggered when the text content is scrolled. * \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains two parameters:\n * ArkUI_NodeComponentEvent.data[0].i32: offset in the X coordinate of the text in the content area. \n * ArkUI_NodeComponentEvent.data[1].i32: offset in the Y coordinate of the text in the content area. \n @@ -5228,7 +5407,8 @@ typedef enum { * @brief Defines the event triggered when the text input content changes. * \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains two parameters:\n * ArkUI_NodeComponentEvent.data[0].f32: width of the text. \n * ArkUI_NodeComponentEvent.data[1].f32: height of the text. \n @@ -5457,6 +5637,31 @@ typedef enum { */ NODE_SWIPER_EVENT_ON_GESTURE_SWIPE, + /** + * @brief Defines the event triggered when content in the swiper component scrolls. + * Instructions: \n + * 1. This API does not work when {@link ArkUI_SwiperDisplayModeType} is set to + * ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR. \n + * 2. This API does not work when prevMargin and nextMargin are set in such a way that the swiper + * frontend and backend display the same page during loop playback. \n + * 3. During page scrolling, the ContentDidScrollCallback callback is invoked for all pages in the viewport + * on a frame-by-frame basis. \n + * For example, when there are two pages whose subscripts are 0 and 1 in the viewport, two callbacks whose indexes + * are 0 and 1 are invoked in each frame. \n + * 4. When the swipeByGroup parameter of the displayCount attribute is set to true, + * the callback is invoked for all pages in a group if any page in the group is within the viewport. \n \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n + * {@link ArkUI_NodeComponentEvent} contains four parameters: \n + * ArkUI_NodeComponentEvent.data[0].i32: index of the swiper component, which is the same as the index in the + * onChange event. \n + * ArkUI_NodeComponentEvent.data[1].i32: index of a page in the viewport. \n + * ArkUI_NodeComponentEvent.data[2].f32: position of the page relative to the start position of the swiper + * main axis (start position of the page corresponding to selectedIndex). \n + * ArkUI_NodeComponentEvent.data[3].f32: length of the page in the main axis direction. \n + */ + NODE_SWIPER_EVENT_ON_CONTENT_DID_SCROLL, + /** * @brief Defines the event triggered when scrolling occurs. * @@ -5571,7 +5776,8 @@ typedef enum { * * Notes for triggering the event:\n * 1. This event is triggered when scrolling hits the end edge. \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} does not contain parameters. \n */ NODE_SCROLL_EVENT_ON_REACH_END, @@ -5580,7 +5786,8 @@ typedef enum { * * Notes for triggering the event:\n This event is triggered when scrolling hits the start edge. \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} does not contain parameters. \n */ NODE_SCROLL_EVENT_ON_REACH_START, @@ -5591,7 +5798,8 @@ typedef enum { * Notes for triggering the event:\n * This event is triggered once when the list is initialized and when the index of the first child component or the * next child component in the list display area changes. \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains three parameters: \n * ArkUI_NodeComponentEvent.data[0].i32: index of the first child component in the list display area. \n * ArkUI_NodeComponentEvent.data[1].i32: index of the last child component in the list display area. \n @@ -5621,7 +5829,8 @@ typedef enum { * settings, such as keyboard and mouse operations. \n * 2. Scrolling can be initiated by calling the controller API. \n * 3. The out-of-bounds bounce effect is supported. \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains two parameters: \n * ArkUI_NodeComponentEvent.data[0].f32: scroll offset of each frame. The offset is positive when the list * is scrolled up and negative when the list is scrolled down. \n @@ -5645,6 +5854,15 @@ typedef enum { * {@link ArkUI_NodeComponentEvent} does not contain parameters:\n */ NODE_REFRESH_ON_REFRESH, + /** + * @brief Defines the event triggered when the pull-down distance of ARKUI_NODE_REFRESH changes. + * + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n + * {@link ArkUI_NodeComponentEvent} contains one parameter:\n + * ArkUI_NodeComponentEvent.data[0].f32: pull-down distance. \n + */ + NODE_REFRESH_ON_OFFSET_CHANGE, /** * @brief Defines the event triggered when the ARKUI_NODE_SCROLL component is about to scroll. @@ -5670,7 +5888,8 @@ typedef enum { * settings, such as keyboard and mouse operations. \n * 2. Scrolling can be initiated by calling the controller API. \n * 3. The out-of-bounds bounce effect is supported. \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains two parameters: \n * ArkUI_NodeComponentEvent.data[0].f32: scroll offset of each frame. The offset is positive when the * content is scrolled up and negative when the content is scrolled down. \n @@ -5682,7 +5901,8 @@ typedef enum { * * Notes for triggering the event:\n * This event is triggered when the index of either the first or last item changes. \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_NodeComponentEvent}. \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n * {@link ArkUI_NodeComponentEvent} contains three parameters: \n * ArkUI_NodeComponentEvent.data[0].i32: index of the first item of the water flow container. \n * ArkUI_NodeComponentEvent.data[1].i32: index of the last item of the water flow container. \n