Available on crate feature
api-12 only.Structs§
- @brief Defines the input structure of the interconnected multi-column text picker.
- @brief Defines the input structure of the single-column text picker with image resources.
- @brief Define accessible action types.
- @brief Defines the state type for the accessibility checkbox.
- @brief Enumerates the accessibility modes.
- @brief Enumerates the adaptive color modes.
- @brief Enumerates the alignment modes.
- @brief Enumerates the animation curves.
- @brief Enumerates the animation playback modes.
- @brief Defines the status before and after execution of the animation in the current playback direction.
- @brief Enumerates the animation playback modes.
- @brief Defines the playback status for the image animator.
- @brief Enumerates the scroll directions for the
- @brief defines the direction of the barrier line.
- @brief Defines how the specified blend mode is applied.
- @brief Enumerates the blend modes.
- @brief Enumerates the blur styles.
- @brief Enumerates the border styles.
- @brief Enumerates the button types.
- @brief Enumerates the alignment modes between the calendar picker and the entry component.
- @brief Enumerates the styles of the Cancel button.
- @brief Enumerates the shapes of the check box
- @brief Enumerates the clipping region types.
- @brief Enumerates the color modes.
- @brief Defines the gradient color stop structure.
- @brief Enumerates the foreground colors.
- @brief Defines the ArkUI native context object.
- @brief Defines the event callback type.
- @brief Enumerates the text copy and paste modes.
- @brief Enumerates the modes in which components are laid out along the main axis of the container.
- @brief Enumerates the effects used at the edges of the component when the boundary of the scrollable content is reached.
- @brief Enumerates the ellipsis positions.
- @brief Enumerates the types of the Enter key for a single-line text box.
- @brief Define error code enumeration values.
- @brief Enumerates the animation onFinish callback types.
- @brief Enumerates the vertical alignment modes.
- @brief Enumerates the directions of the main axis in the flex container.
- @brief Defines whether the flex container has a single line or multiple lines.
- @brief Enumerates the font styles.
- @brief Enumerates the font weights.
- @brief Enumerates the hit test modes.
- @brief Enumerates the alignment mode in the horizontal direction.
- @brief Enumerates the image interpolation effect.
- @brief Enumerates the image rendering modes.
- @brief Enumerates the image repeat patterns.
- @brief Defines the image size.
- @brief Enumerates the alignment mode of the image with the text.
- @brief Describes the position of a component.
- @brief Describes the width and height of a component.
- @brief Enumerates the modes in which components are laid out along the cross axis of the container.
- @brief Enumerates the component units.
- @brief Enumerates the gradient directions.
- @brief Enumerates the alignment modes of items along the cross axis.
- @brief Define the pattern of element arrangement in the main axis direction of the Swiper component.
- @brief Define the explicit and implicit mode of the SwipeAction method for the Listitem component.
- @brief Describes the margins of a component.
- @brief Enumerates the mask types.
- @brief Defines the custom dialog box controller of ArkUI on the native side.
- @brief Defines the state of the NavDestination component.
- @brief Defines the ArkUI native component object.
- @brief Provides the number types of ArkUI in the native code.
- @brief Defines how the image is resized to fit its container. ImageSpanAlignment @since 12
- @brief Enumerates the styles of the progress indicator.
- @brief Defines a mask area.
- @brief defines the style of the chain.
- @brief Enumerates the render fit.
- @brief Defines the rotation options for component transition.
- @brief Define the state of Router Page.
- @brief defines the enumerated value of the direction of the extended security zone.
- @brief defines the enumerated value of the extended security zone.
- @brief Defines the scaling options for component transition.
- @brief Alignment when scrolling to specific items.
- @brief Enumerates the scrollbar display modes.
- @brief Enumerates the scroll directions for the
component. - @brief Defines the edge to which the component scrolls.
- @brief Defines nested scrolling options.
- @brief Enumerates the alignment modes of list items when scrolling ends.
- @brief Define the rolling source enumeration value.
- @brief Define the current scrolling state.
- @brief Enumerates the shadow styles.
- @brief Enumerates the shadow types.
- @brief Enumerates the custom shapes.
- @brief Enumerates the types of the slider in the block direction.
- @brief Enumerates the scroll directions of the slider.
- @brief Enumerates the slider styles.
- @brief Enumerates the modes for pinning the header to the top or the footer to the bottom.
- @brief Enumerates arrow styles of the navigation point indicator.
- @brief Define the navigation indicator type of the swiper.
- @brief Nested scrolling mode for Swiper components and parent components.
- @brief Enumerates the system color modes.
- @brief Enumerates the text alignment mode.
- @brief Enumerates the text box types.
- @brief Enumerates the text cases.
- @brief Defines whether copy and paste is allowed for text content.
- @brief Defines the entity type for text recognition.
- @brief Enumerates the text decoration styles.
- @brief Enumerates the text decoration types.
- @brief Defines how the adaptive height is determined for the text.
- @brief Enumerates the autofill types.
- @brief Defines the text input style.
- @brief Enumerates the text input types.
- @brief Enumerates the display modes when the text is too long.
- @brief Enumerates the types of the text picker.
- @brief Enumerates the slide-in and slide-out positions of the component from the screen edge during transition.
- @brief Defines the translation options for component transition.
- @brief Enumerates the vertical alignment modes.
- @brief Enumerates the visibility values.
- @brief Enumerates the word break rules.
- @brief Enumerates the types of the
component.
Functions§
- @brief Create accessibility state.
- @brief Dispose accessibility state.
- @brief Get accessibility checked state.
- @brief Get accessibility state disabled.
- @brief Get accessibility state selected.
- @brief Set accessibility checked state.
- @brief Set accessibility state disabled.
- @brief Set accessibility state selected.
- @brief Create accessibility value.
- @brief Dispose accessibility value.
- @brief Get accessibility current value.
- @brief Get accessibility minimum value.
- @brief Get accessibility minimum value.
- @brief Get accessibility text value。
- @brief Set accessibility current value.
- @brief Set accessibility minimum value.
- @brief Set accessibility minimum value.
- @brief Set accessibility text value.
- @brief creates alignment rule information for subcomponents in relative containers.
- @brief Destroys the alignment rule information of subcomponents in relative containers.
- @brief Get the bias value in the horizontal direction.
- @brief Get the bias value in the vertical direction.
- @brief Get the bottom alignment parameters.
- @brief Get the bottom alignment parameters.
- @brief Gets the parameters of horizontal center alignment.
- @brief Gets the parameters of vertical center alignment.
- @brief Gets the parameters of horizontal center alignment.
- @brief Gets the parameters of vertical center alignment.
- @brief Get the end alignment parameter.
- @brief Get the end alignment parameter.
- @brief Gets the alignment of the start-aligned parameter.
- @brief Get the Id of the start-aligned parameter.
- @brief Get the top-aligned parameters.
- @brief Get the top-aligned parameters.
- @brief Sets the horizontal offset parameter of the component under the anchor point constraint.
- @brief Set the vertical offset parameter of the component under the anchor point constraint.
- @brief Set the bottom alignment parameters.
- @brief Set the parameters for horizontal center alignment.
- @brief Set the parameters for vertical center alignment.
- @brief Set the end alignment parameter.
- @brief Set the start alignment parameter.
- @brief Set the parameters for top alignment.
- @brief creates barrier information within the RelativeContaine container.
- @brief Destroy barrier information.
- @brief Gets the direction of the barrier.
- @brief Get the Id of the barrier.
- @brief Get the dependent components of the barrier.
- @brief Gets the number of dependent components of the barrier.
- @brief Set the direction of the barrier.
- @brief Set the Id of the barrier.
- @brief Sets the dependent component of the barrier.
- @brief Creates drawing information for this custom span.
- @brief Disposes of drawing information for this custom span.
- @brief Obtains the baseline offset of the custom span relative to the mounted component.
- @brief Obtains the bottom margin of the custom span relative to the mounted component.
- @brief Obtains the top margin of the custom span relative to the mounted component.
- @brief Obtains the x-axis offset of the custom span relative to the mounted component.
- @brief Creates measurement information for this custom span.
- @brief Disposes of measurement information of this custom span.
- @brief Obtains the font size of a custom span.
- @brief Creates measurement metrics for this custom span.
- @brief Disposes of measurement metrics of this custom span.
- @brief Sets the height for a custom span.
- @brief Sets the width for a custom span.
- @brief Obtains the pointer to a canvas for drawing, which can be converted into the OH_Drawing_Canvas pointer in the Drawing module.
- @brief Obtains the size of a drawing area.
- @brief Create auxiliary line information in the RelativeContaine container.
- @brief Destroy auxiliary line information.
- @brief Get the direction of the auxiliary line.
- @brief Get the Id of the auxiliary line.
- @brief Get the distance from the right side or bottom of the container.
- @brief Get the distance from the left or top of the container.
- @brief Set the direction of the auxiliary line.
- @brief Set the Id of the auxiliary line.
- @brief Set the distance from the right or bottom of the container.
- @brief Set the distance from the left or top of the container.
- @brief Create a image frame from the image path. @param src Indicates the image path. @return Returns the pointer to the image frame object. If a null pointer is returned, the object fails to be created. The possible cause is that the src parameter is abnormal, for example, the pointer is null. @since 12
- @brief Destroy the pointer to the image frame.
- @brief Get the playback duration of the image frame.
- @brief Get the height of the image frame.
- @brief Get the horizontal coordinate of the image relative to the upper left corner of the widget.
- @brief Get the vertical coordinate of the image relative to the upper left corner of the widget.
- @brief Get the width of the image frame.
- @brief Set the playback duration of the image frame.
- @brief Set the height of the image frame.
- @brief Set the horizontal coordinate of the image relative to the upper left corner of the widget.
- @brief Set the vertical coordinate of the image relative to the upper left corner of the widget.
- @brief Set the width of the image frame.
- @brief Creates a deep copy of a size constraint.
- @brief Creates a size constraint.
- @brief Destroys the pointer to a size constraint.
- @brief Obtains the maximum height for a size constraint, in px.
- @brief Obtains the maximum width for a size constraint, in px.
- @brief Obtains the minimum height for a size constraint, in px.
- @brief Obtains the minimum width for a size constraint, in px.
- @brief Obtains the height percentage reference for a size constraint, in px.
- @brief Obtains the width percentage reference for a size constraint, in px.
- @brief Sets the maximum height.
- @brief Sets the maximum width.
- @brief Sets the minimum height.
- @brief Sets the minimum width.
- @brief Sets the height percentage reference.
- @brief Sets the width percentage reference.
- @brief Create configuration items for the ListChildrenMainSize interface settings.
- @brief Destroy the ListChildrenMainSize instance.
- @brief Get the default size of ChildrenMainSizeOption for the List component.
- @brief Get the value of the ChildrenMainSizeOption array for the List component.
- @brief Reset the array size of ChildrenMainSizeOption for the List component.
- @brief Set the default size of ChildrenMainSizeOption for the List component.
- @brief Resize the ChildrenMainSizeOption array operation on the List component.
- @brief Update the value of the ChildrenMainSizeOption array in the List component.
- @brief Create a configuration item for the ListitemSwipeActionItem interface settings.
- @brief Destroy the ListitemSwipeActionItem instance.
- @brief Obtain the threshold for long-distance sliding deletion distance of components.
- @brief Set the threshold for long-distance sliding deletion distance of components.
- @brief Set the layout content of ListItem SwipeActionItem.
- @brief Set the event to be called when a component enters the long-range deletion area and deletes a ListItem.
- @brief Set the event triggered when a component enters the long-range deletion area and deletes a ListItem.
- @brief Set the event to be called when a sliding entry enters the deletion area.
- @brief Set the event triggered when a sliding entry enters the deletion area.
- @brief Set the event to be called when a sliding entry exits the deletion area.
- @brief Set the event triggered when a sliding entry exits the deletion area.
- @brief Set the event triggered when the sliding state of a list item changes.
- @brief Set the event triggered when the sliding state of a list item changes.
- @brief Create a configuration item for the ListitemSwipeActionOption interface settings.
- @brief Destroy the ListitemSwipeActionOption instance.
- @brief Get the sliding effect.
- @brief Set the sliding effect.
- @brief Set the layout content on the right (vertical layout) or bottom (horizontal layout) of the ListItem SwipeActionItem.
- @brief The event called when the sliding operation offset changes.
- @brief Set the event triggered when the sliding operation offset changes.
- @brief Set the layout content on the left (vertical layout) or top (horizontal layout) of the ListItem SwipeActionItem.
- @brief Creates a navigation indicator.
- @brief Destroys the pointer to the indicator.
- @brief Obtains the distance between the navigation point and the bottom of the swiper.
- @brief Obtains the color of the dot navigation indicator.
- @brief Obtains the distance between the navigation point and the end of the swiper.
- @brief Obtains the height of the dot for the dot indicator.
- @brief Obtains the width of the dot for the dot indicator.
- @brief Obtains whether to display the mask style of the dot navigation indicator.
- @brief Obtains the number of maxDisplayCount for the dot navigation indicator.
- @brief Obtains the color of the selected dot for the dot navigation indicator.
- @brief Obtains the height of the selected dot for the dot indicator.
- @brief Obtains the width of the selected dot for the dot indicator.
- @brief Obtains the distance between the navigation point and the start of the swiper.
- @brief Obtains the distance between the navigation point and the top of the swiper.
- @brief Sets the distance between the navigation point and the bottom of the swiper.
- @brief Sets the color of the dot navigation indicator.
- @brief Sets the distance between the navigation point and the right of the swiper.
- @brief Sets the height of the dot for the dot indicator.
- @brief Sets the width of the dot for the dot indicator.
- @brief Sets whether to display the mask style of the dot navigation indicator.
- @brief Sets the number of maxDisplayCount for the dot navigation indicator.
- @brief Sets the color of the selected dot for the navigation indicator.
- @brief Sets the height of the selected dot for the dot indicator.
- @brief Sets the width of the selected dot for the dot indicator.
- @brief Sets the distance between the navigation point and the start of the swiper.
- @brief Sets the distance between the navigation point and the top of the swiper.
- @brief Creates water flow section configuration.
- @brief Destroys the pointer to a water flow section configuration.
- @brief Obtains the gap between columns in the water flow section that matches the specified index.
- @brief Obtains the number of columns (in a vertical layout) or rows (in a horizontal layout) in the water flow section that matches the specified index.
- @brief Obtains the number of items in the water flow section that matches the specified index.
- @brief Obtains the margins of the water flow section that matches the specified index.
- @brief Obtains the gap between rows in the water flow section that matches the specified index.
- @brief Gets the FlowItem grouping configuration information array length.
- @brief The FlowItem grouping configuration information getsthe spindle size of the specified Item based on flowItemIndex.
- @brief The FlowItem grouping configuration information getsthe spindle size of the specified Item based on flowItemIndex.
- @brief Sets the gap between columns in the specified water flow section.
- @brief Sets the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow.
- @brief Sets the number of items in a water flow section.
- @brief Sets the margins for the specified water flow section.
- @brief Sets the gap between rows in the specified water flow section.
- @brief Sets the FlowItem block configuration information array length.
Type Aliases§
- @brief Defines the pointer to the context instance object pointer definition of ArkUI on the native side.
- @brief Defines the pointer to the custom dialog box controller of ArkUI on the native side.
- @brief Defines the pointer type of the ArkUI node content
- @brief Defines the pointer to the ArkUI native component object.