Graphic

Overview

Defines a lightweight graphics system that provides basic UI and container views, including buttons, images, labels, lists, animators, scroll views, swipe views, and layouts. This system also provides the Design for X (DFX) capability to implement features such as view rendering, animation, and input event distribution.

Since:

1.0

Version:

1.0

Summary

Files

File Name

Description

animator.h

Defines the attributes and common functions of the animator module.

easing_equation.h

Defines the attributes and functions of the animation easing module.

interpolation.h

Defines the functions for calculating the interpolation in computer graphics.

color.h

Defines color attributes for the graphics system and implements common color functions.

image.h

Declares basic image attributes, including the image type and path.

screen.h

Declares the screen information.

task.h

Declares the Task class of the graphics module, which provides functions for setting the running period and time of a task.

text.h

Declares the Text class that provides functions to set basic text attributes, such as the text direction and alignment mode.

abstract_adapter.h

Defines the base class for adapters.

root_view.h

Manages a root view.

text_adapter.h

Defines a text adapter that is used to construct UILabel instances.

ui_abstract_clock.h

Declares the UIAbstractClock class that provides the functions related to clocks.

ui_abstract_progress.h

Defines the base class attributes and common functions of a progress bar.

ui_abstract_scroll.h

Declares the base class used to define the attributes of a scroll. The UIList, UIScrollView, and UISwipeView inherit from this class.

ui_analog_clock.h

Declares an analog clock.

ui_arc_label.h

Defines the attributes of an arc label.

ui_axis.h

Defines the attributes and functions of the x- and y-axises. This class is used in UIChart.

ui_box_progress.h

Defines the attributes and common functions of a linear progress bar.

ui_button.h

Defines the attributes and common functions of a button.

ui_canvas.h

Defines the attributes of the canvas component and provides functions for drawing rectangles, circles, and others.

ui_chart.h

Defines the attributes of the chart component and provides functions for adding and deleting data sets to display a chart.

ui_checkbox.h

Defines the attributes and common functions of a check box.

ui_circle_progress.h

Defines the attributes and common functions of a circular progress bar.

ui_dialog.h

Declares the UIDialog class that defines the dialog box component.

ui_digital_clock.h

Declares a digital clock.

ui_image_animator.h

Defines the attributes and functions of an image animator.

ui_image_view.h

Declares an image view.

ui_label.h

Declares a UILabel class that represents a label.

ui_label_button.h

Declares a label button.

ui_list.h

Declares a scrollable list in the vertical or horizontal direction. * This scrollable list can be used with the adapter AbstractAdapter to implement scrolling, inertial scrolling, automatic alignment, and invoking of a callback when a child view at the preset position is selected as this list scrolls. It is used when there is a large number of child views with a fixed format.

ui_picker.h

Defines the attributes and functions of the UIPicker class.

ui_radiobutton.h

Defines the attributes and common functions of a radio button.

ui_scroll_view.h

Declares a view group that allows its child views to be displayed as scroll events occur.

ui_slider.h

Defines the attributes and common functions of a slider.

ui_surface_view.h

Declares the surface view that interacts with the multimedia to achieve camera preview and video playback.

ui_swipe_view.h

Defines the attributes and common functions of a swipe view.

ui_texture_mapper.h

Defines the attributes and functions of a texture mapper.

ui_time_picker.h

Defines the attributes and functions of the UITimePicker class.

ui_toggle_button.h

Defines the attributes and common functions of a toggle button.

ui_view.h

Declares the base class of a view, providing basic view attributes and operations. All views are derived from this class.

ui_view_group.h

Declares a view group.

event_injector.h

Declares the function for simulating input events.

ui_dump_dom_tree.h

Declares a function for exporting information about a Document Object Model (DOM) tree or DOM node.

ui_screenshot.h

Declares the screenshot function.

aod_callback.h

Defines the callback for the touch event notification in screen-off mode.

cancel_event.h

Declares a cancel event, which usually occurs when the target view changes due to user sliding. For example, this event is triggered if you, after pressing a button, does not release the button but slides.

click_event.h

Declares a click event, which indicates that a finger is pressed on the screen and then lifted within 1 second.

drag_event.h

Declares a drag event, which indicates a certain movement (more than 10 pixels) after a view is pressed.

event.h

Declares the base class of a user input event and provides functions to record information such as the event position and timestamp.

key_event.h

Declares a key event, which indicates that a physical button is pressed or released.

long_press_event.h

Declares a long-press event, which indicates that the finger is not raised or moved within 1 second after a view is pressed.

press_event.h

Declares a touch event, which indicates that the touchscreen or mouse is pressed.

release_event.h

Declares a release event, which indicates that the touchscreen or mouse is released.

virtual_device_event.h

Declares a virtual device event, which is used to receive a customized input event and call back the listening function registered.

geometry2d.h

Defines attributes of 2D geometries (including points, lines, rectangles, and polygons) of the lightweight graphics system and provides functions for performing operations on the geometries.

graphic_assert.h

Declares the assertion utility for the graphics module.

graphic_config.h

Provides configuration items required for graphics.

graphic_math.h

Defines mathematical operation functions and types, including trigonometric functions, two-dimensional vectors, three-dimensional vectors, and matrices.

graphic_types.h

Defines the common data types for the graphics system.

heap_base.h

Declares the functions for overriding the new and delete functions.

image_info.h

Defines image information.

flex_layout.h

Declares a flexible layout container. You can perform simple adaptive layout on child views that the container holds, for example, to evenly arrange all child views in the same row or column.

grid_layout.h

Declares a grid layout container. You can perform simple grid layout on child views that the container holds.

layout.h

Declares the base class of the layout, which indicates the basic data types and operations that may be used in the layout.

list.h

Defines a linked list template class, which implements the data structure of bidirectional linked list and provides basic functions such as adding, deleting, inserting, clearing, popping up, and obtaining the size of the linked list.

mem_api.h

Defines the functions for memory application and release. You can implement the malloc and free functions to manage the memory.

rect.h

Defines a rectangle, including the position data of the four boundaries of the rectangle, and provides functions for rectangle inclusion, intersection, and aggregation.

style.h

Defines the attributes and common functions of style.

sys_info.h

Declares the system information about the graphics module, including the function to obtain the information about FPS, which needs to be enabled by the ENABLE_FPS_SUPPORT macro.

theme.h

Declares the base class used to define the functions related to the styles of different components.

theme_manager.h

Declares the singleton class used to manage the current screen theme of an application.

transform.h

Provides functions to transform components, points, and line segments, including rotation and scaling.

version.h

Declares the version number control for the graphics module. This file defines functions to obtain the version number and library description.

Data Structures

Data Structure Name

Description

OHOS::AnimatorCallback

Represents the animator callback.

OHOS::Animator

Represents an animator.

OHOS::AnimatorManager

Represents the animator manager.

OHOS::EasingEquation

Defines functions for specifying the velocity of an animation.

OHOS::Interpolation

Calculates the Bezier interpolation.

OHOS::Color16

Defines the color attribute when the color depth is 16.

OHOS::Color24

Defines the color attribute when the color depth is 24.

OHOS::Color32

Defines the color attribute when the color depth is 32.

OHOS::Color

Converts colors in different formats and defines common colors.

OHOS::Image

Represents basic image attributes, including the image type and path.

OHOS::Screen

Represents the screen info of the device.

OHOS::Task

Represents the Task class of the graphics module. This class provides functions for setting the running period and time of a task.

OHOS::Text

Represents the base class of Text, providing the text attribute setting and text drawing capabilities for components that require font display.

OHOS::AbstractAdapter

Defines the base class for adapters. You can derive AbstractAdapter based on actual requirements and use the GetView() and GetCount() functions to implement adapters of different data types. For details, see TextAdapter.

OHOS::RootView::OnKeyActListener

Represents the listener for monitoring physical key events.

OHOS::RootView::OnVirtualDeviceEventListener

Listens for the input events triggered by a virtual device other than human touching or physical pressing.

OHOS::RootView

Defines the functions related to a root view which contains its child views and represents the root node in a tree structure.

OHOS::TextFormatter

Defines a text formatter. You can inherit this class and implement the Format() function.

OHOS::TextAdapter

Defines a text adapter, which implements UILabel instance construction and supports text data and continuous integer data.

OHOS::UIAbstractClock

An abstract class that contains functions for converting units of time (hour, minute, and second), setting and obtaining the time.

OHOS::UIAbstractProgress

Represents the abstract base class which provides functions related to the progress bar.

OHOS::UIAbstractScroll

Defines the attributes of a scroll, including the scroll direction, blank size of a scroll view, velocity and effects of a scroll animation.

OHOS::UIAnalogClock::Hand

Defines the basic attributes of the analog clock hands. This is an inner class of UIAbstractClock.

OHOS::UIAnalogClock

Provides the functions related to an analog clock.

OHOS::UIArcLabel::ArcTextInfo

Stores the attribute information about this arc text to draw.

OHOS::UIArcLabel

Defines functions related to an arc label.

OHOS::UIAxis

Represents the coordinate axis base class, which defines the basic attributes of coordinate axis, sets whether a coordinate axis is visible, and sets the number of scales on a coordinate axis. This class is used in UIChart.

OHOS::UIXAxis

Defines the unique attributes and functions for the x-axis. This class is used in UIChart.

OHOS::UIYAxis

Defines the unique attributes and functions for the y-axis. This class is used in UIChart.

OHOS::UIBoxProgress

Represents a linear progress bar.

OHOS::UIButton

Represents a button.

OHOS::Paint

Defines the basic styles of graphs drawn on canvases.

OHOS::UICanvas::FontStyle

Defines the font style.

OHOS::UICanvas

Defines a canvas, which is used to draw multiple types of 2D graphs.

OHOS::UIChartDataSerial::PointStyle

Defines the style for the top, bottom, and frontmost points in a line chart.

OHOS::UIChartDataSerial

Defines a data set and provides functions such as adding and deleting data points.

OHOS::UIChart

Defines the chart class and provides functions such as adding and deleting data sets to display a chart.

OHOS::UIChartPillar

Provides special functions for implementing a bar chart.

OHOS::UIChartPolyline

Provides special functions for implementing a polyline.

OHOS::UICheckBox::OnChangeListener

Represents a listener for changes of a check box.

OHOS::UICheckBox

Represents a check box.

OHOS::UICircleProgress

Represents a circular progress bar.

OHOS::UIDialog

Represents a dialog box.

OHOS::UIDigitalClock

Displays time digitally.

OHOS::ImageAnimatorInfo

Provides information about the images.

OHOS::UIImageAnimatorView::AnimatorStopListener

Represents a listener that contains a callback to be invoked when this animator stops.

OHOS::UIImageAnimatorView

Represents an image animator.

OHOS::UIImageView

Defines the functions related to an image view.

OHOS::UILabel

Defines the functions for presenting a label in a specified area, setting the style and background color of a label, and setting the display mode of a long label text.

OHOS::UILabelButton

Provides the functions related to a label button.

OHOS::ListScrollListener

Represents a listener that contains a callback to be invoked when the scroll state changes or when a new child view is selected at the preset position as this list scrolls. The scroll state can be {} or SCROLL_STATE_MOVE}.

OHOS::UIList

Represents a scrollable list which is used with the adapter AbstractAdapter to implement scrolling, inertial scrolling, automatic alignment, and invoking of a callback when a child view is selected at the preset position as this list scrolls.

OHOS::UIPicker::SelectedListener

Defines the listener used by a picker. This listener is triggered when an item is selected after sliding stops.

OHOS::UIPicker

Defines a picker. Multiple texts or numbers can be put into a sliding list for selection. The selected text or numbers are highlighted.

OHOS::UIRadioButton

Represents a radio button.

OHOS::UIRepeatButton

Represents a repeat button.

OHOS::UIScrollView::OnScrollListener

Represents a listener that contains a callback to be invoked upon scroll state changes. The state can either be SCROLL_STATE_STOP or SCROLL_STATE_MOVE.

OHOS::UIScrollView

Supports horizontal or vertical scroll of child views. This class is inherited from UIAbstractScroll.

OHOS::UISlider::UISliderEventListener

Represents the listener for a slider change.

OHOS::UISlider

Represents a slider.

OHOS::UISurfaceView

Represents a surface view that interacts with the multimedia to achieve camera preview and video playback.

OHOS::UISwipeView::OnSwipeListener

Represents a listener for changes of the swipe view.

OHOS::UISwipeView

Represents a swipe view.

OHOS::UITextureMapper::AnimatorStopListener

Represents a listener that contains a callback to be invoked when this animator stops.

OHOS::UITextureMapper

Rotates and scales images.

OHOS::UITimePicker::SelectedListener

Defines the listener used by the time picker. This listener is triggered when an item is selected after sliding stops.

OHOS::UITimePicker

Defines the time picker. The time is in the format of “hour:minute” or “hour:minute:second”. The selected time is highlighted.

OHOS::UIToggleButton

Represents a toggle button.

OHOS::UIView::OnClickListener

Defines a click event listener. You need to register this listener with the view to listen to click events.

OHOS::UIView::OnLongPressListener

Defines a long-press event listener. You need to register this listener with the view to listen to long-press events.

OHOS::UIView::OnDragListener

Defines a drag event listener. You need to register this listener with the view to listen to drag events.

OHOS::UIView::OnTouchListener

Defines a touch event listener. You need to register this listener with the view to listen to touch events.

OHOS::UIView

Defines the base class of a view, providing basic view attributes and operations. All views are derived from this class.

OHOS::UIViewGroup

Represents a view group that consists of its child views.

OHOS::UIDumpDomTree

Provides functions for exporting information about a specified DOM node or information about the DOM tree starting from a specified DOM node.

OHOS::CancelEvent

Defines a cancel event, which usually occurs when the target view changes due to user sliding. For example, this event is triggered if you, after pressing a button, does not release the button but slides.

OHOS::ClickEvent

Defines a click event, which indicates that a finger is pressed on the screen and then lifted within 1 second.

OHOS::DragEvent

Defines a drag event, which indicates a certain movement (more than 10 pixels) after a view is pressed.

OHOS::Event

Defines the base class of a user input event and provides functions to record information such as the event position and timestamp.

OHOS::KeyEvent

Defines a key event, which indicates that a physical button is pressed or released.

OHOS::LongPressEvent

Defines a long-press event, which indicates that the finger is not raised or moved within 1 second after a view is pressed.

OHOS::PressEvent

Defines a touch event, which indicates that the touchscreen or mouse is pressed.

OHOS::ReleaseEvent

Defines a release event, which indicates that the touchscreen or mouse is released.

OHOS::VirtualDeviceEvent

Defines a virtual device event, which is used to receive a customized input event and call back the listening function registered.

OHOS::Line

Defines a line, which consists of the start and end points.

OHOS::Polygon

Defines a polygon, including vertex coordinates and the maximum number of vertices (defined by MAX_VERTEX_NUM).

OHOS::Vector2< T >

Defines the two-dimensional vector, and provides basic mathematical operations such as vector assignment, scalar product, cross product, addition, and subtraction.

OHOS::Vector3< T >

Defines the 3-dimensional vector, and provides basic operators such as [] and ==.

OHOS::Matrix3< T >

Defines a 3 x 3 matrix.

OHOS::Point

Defines a point.

OHOS::HeapBase

Defines the base class, overriding the new and delete functions.

OHOS::ImageHeader

Defines image head node information.

OHOS::ImageInfo

Defines image information.

OHOS::FlexLayout

Defines a flexible layout container. You can perform simple adaptive layout on child views that the container holds, for example, to evenly arrange all child views in the same row or column.

OHOS::GridLayout

Defines a grid layout container. You can perform simple grid layout on child views that the container holds.

OHOS::Layout

Defines the base class of the layout, which indicates the basic data types and operations that may be used in the layout.

OHOS::ListNode< T >

Stores linked list data and contains pointers to the previous node and the next node.

OHOS::List< T >

Defines a linked list template class, which implements the data structure of bidirectional linked list and provides basic functions such as adding, deleting, inserting, clearing, popping up, and obtaining the size of the linked list.

OHOS::Rect

Defines a rectangle, including the position data of the four boundaries of the rectangle, and provides functions for rectangle inclusion, intersection, and aggregation.

OHOS::Style

Defines the basic attributes and functions of a style. You can use this class to set different styles.

OHOS::StyleDefault

Define some default style for UIView.

OHOS::SysInfo::OnFPSChangedListener

Called when the FPS changes.

OHOS::SysInfo

Obtains the system information. Currently, the FPS information can be obtained. To enable the FPS feature, enable the ENABLE_FPS_SUPPORT macro.

OHOS::ButtonStyle

Stores styles of a button in its different states.

OHOS::Theme

Defines the theme class used to define the functions related to the styles of different components.

OHOS::ThemeManager

Declares the singleton class used to manage the current screen theme of an application.

OHOS::TransformMap

Transforms a rectangle, including rotation and scaling.

Macros

Macro Name and Value

Description

VERSION_STANDARD

 

ENABLE_DMA2D    0

DMA2D hardware acceleration, which does not take effect on other platforms.

ENABLE_DMA2D_TEXT    0

DMA2D hardware acceleration for font rendering, which does not take effect on other platforms.

ENABLE_ICU    0

Advanced algorithm for line breaks, which is disabled by default on other platforms.

ENABLE_WINDOW    1

Multi-window, which is enabled by default on other platforms.

ENABLE_FRAME_BUFFER    0

Display buffer for rendering data refresh, which is disabled by default on other platforms.

ENABLE_VECTOR_FONT    1

Vector type font,which is enabled by default on other platforms.

ENABLE_BUFFER_RGBA    1

Graphics bottom-layer RGBA, which is enabled by default.

ENABLE_HARDWARE_ACCELERATION    1

Graphics rendering hardware acceleration, which is enabled by default.

ENABLE_DEBUG    1

Debug mode, which is disabled by default.

ENABLE_MEMORY_HOOKS    0

Memory hook, which is enabled by default. The system memory allocation is taken over after it is enabled.

ENABLE_FPS_SUPPORT    0

Function for monitoring the image refresh frame rate, which is disabled by default.

ENABLE_ANTIALIAS    1

Anti-aliasing, which is enabled by default.

ENABLE_RECT_ANTIALIAS    0

Rectangle anti-aliasing, which is disabled by default.

ENABLE_SPEC_FONT    0

Font color mode, which is disabled by default. After it is enabled, the font color mode is set to 4 to accelerate font rendering.

ENABLE_GRAPHIC_LOG    0

Log function of a graphics subsystem, which is disabled by default.

ENABLE_AOD    0

Function for receiving input events in screen-off mode, which is disabled by default.

GRAPHIC_LOG_LEVEL    5

Defines the log level. A smaller value indicates a higher priority. Logs whose priorities are higher than a specified level can be recorded. Log levels: NONE: disabling logs FATAL: fatal level ERROR: error level WARN: warning level INFO: info level DEBUG: debugging level.

COLOR_DEPTH    32

Defines the color depth of graphics rendering. The default value is 32 bits. The value can be 16 or 32.

DEFAULT_VECTOR_FONT_FILENAME    ”SourceHanSansSC-Regular.otf”

Defines the file name of default vector font.

MATH_MAX (a, b)   ((a) > (b) ? (a) : (b))

Larger of a and b.

MATH_MIN (a, b)   ((a) < (b) ? (a) : (b))

Smaller of a and b.

MATH_ABS (x)   ((x) > 0 ? (x) : (-(x)))

Absolute value of x.

MATH_MINUS (a, b)   ((a) < (b) ? ((b) - (a)) : ((a) - (b)))

Difference between a and b.

Typedefs

Typedef Name

Description

OHOS::EasingFunc) (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

typedef int16_t(* 

Calculates the value for the current time of an animation.

Enumerations

Enumeration Name

Description

: uint8_t { OHOS::Animator::STOP, OHOS::Animator::START, OHOS::Animator::PAUSE, OHOS::Animator::RUNNING }

Enumerates the states of this animator.

{ OHOS::OPA_TRANSPARENT = 0, OHOS::OPA_OPAQUE = 255 }

Enumerates opacity values.

OHOS::UITextLanguageAlignment : uint8_t {   OHOS::TEXT_ALIGNMENT_LEFT = 0, OHOS::TEXT_ALIGNMENT_RIGHT, OHOS::TEXT_ALIGNMENT_CENTER, OHOS::TEXT_ALIGNMENT_TOP,   OHOS::TEXT_ALIGNMENT_BOTTOM }

Enumerates text alignment modes.

OHOS::UITextLanguageDirect : uint8_t { OHOS::TEXT_DIRECT_LTR = 0, OHOS::TEXT_DIRECT_RTL }

Enumerates text directions.

OHOS::UIAbstractClock::WorkMode { OHOS::UIAbstractClock::ALWAYS_ON, OHOS::UIAbstractClock::NORMAL }

Enumerates the working modes of this clock.

OHOS::UIAnalogClock::HandType { OHOS::UIAnalogClock::HandType::HOUR_HAND, OHOS::UIAnalogClock::HandType::MINUTE_HAND, OHOS::UIAnalogClock::HandType::SECOND_HAND }

Enumerates the clock hand types.

OHOS::UIAnalogClock::DrawType { OHOS::UIAnalogClock::DrawType::DRAW_LINE, OHOS::UIAnalogClock::DrawType::DRAW_IMAGE }

Enumerates the drawing types of a clock hand.

OHOS::UIArcLabel::TextOrientation : uint8_t { OHOS::UIArcLabel::TextOrientation::INSIDE, OHOS::UIArcLabel::TextOrientation::OUTSIDE }

Enumerates text orientations.

OHOS::UIBoxProgress::Direction : uint8_t { OHOS::UIBoxProgress::Direction::DIR_LEFT_TO_RIGHT, OHOS::UIBoxProgress::Direction::DIR_RIGHT_TO_LEFT, OHOS::UIBoxProgress::Direction::DIR_TOP_TO_BOTTOM, OHOS::UIBoxProgress::Direction::DIR_BOTTOM_TO_TOP }

Enumerates the directions of the progress bar.

OHOS::UIButton::ButtonImageSrc : uint8_t

Enumerates the images for different button states.

OHOS::UIButton::ButtonState : uint8_t

Enumerates the states of this button.

OHOS::Paint::PaintStyle { OHOS::Paint::STROKE_STYLE = 1, OHOS::Paint::FILL_STYLE, OHOS::Paint::STROKE_FILL_STYLE }

Enumerates paint styles of a closed graph. The styles are invalid for non-closed graphs.

OHOS::UICheckBox::UICheckBoxState : uint8_t

Enumerates the states of a check box.

OHOS::UIDialog::DialogButtonType { OHOS::UIDialog::DialogButtonType::BUTTON1, OHOS::UIDialog::DialogButtonType::BUTTON2, OHOS::UIDialog::DialogButtonType::BUTTON3 }

Enumerates buttons in a dialog box.

OHOS::UIDigitalClock::DisplayMode { OHOS::UIDigitalClock::DISPLAY_12_HOUR_NO_SECONDS, OHOS::UIDigitalClock::DISPLAY_24_HOUR_NO_SECONDS, OHOS::UIDigitalClock::DISPLAY_12_HOUR, OHOS::UIDigitalClock::DISPLAY_24_HOUR }

Enumerates the display modes of this digital clock.

OHOS::UIDigitalClock::TimeElement { OHOS::UIDigitalClock::HOUR_ELEMENT, OHOS::UIDigitalClock::MINUTE_ELEMENT, OHOS::UIDigitalClock::SECOND_ELEMENT }

Enumerates the time elements of this digital clock.

OHOS::UILabel::LineBreakMode : uint8_t {   OHOS::UILabel::LINE_BREAK_ADAPT = 0, OHOS::UILabel::LINE_BREAK_STRETCH, OHOS::UILabel::LINE_BREAK_WRAP, OHOS::UILabel::LINE_BREAK_ELLIPSIS,   OHOS::UILabel::LINE_BREAK_MARQUEE, OHOS::UILabel::LINE_BREAK_CLIP, OHOS::UILabel::LINE_BREAK_MAX }

Enumerates the display modes of a long text.

OHOS::VirtualDeviceEvent::DeviceType

Enumerates virtual device types.

OHOS::ColorMode : uint8_t {   OHOS::ARGB8888 = 0, OHOS::RGB888, OHOS::RGB565, OHOS::ARGB1555,   OHOS::ARGB4444, OHOS::AL44, OHOS::AL88, OHOS::L1,   OHOS::L2, OHOS::L4, OHOS::L8, OHOS::A1,   OHOS::A2, OHOS::A4, OHOS::A8, OHOS::UNKNOW }

colormode of image and font.

: uint8_t {   OHOS::STYLE_BACKGROUND_COLOR, OHOS::STYLE_BACKGROUND_OPA, OHOS::STYLE_BORDER_RADIUS, OHOS::STYLE_BORDER_COLOR,   OHOS::STYLE_BORDER_OPA, OHOS::STYLE_BORDER_WIDTH, OHOS::STYLE_PADDING_LEFT, OHOS::STYLE_PADDING_RIGHT,   OHOS::STYLE_PADDING_TOP, OHOS::STYLE_PADDING_BOTTOM, OHOS::STYLE_MARGIN_LEFT, OHOS::STYLE_MARGIN_RIGHT,   OHOS::STYLE_MARGIN_TOP, OHOS::STYLE_MARGIN_BOTTOM, OHOS::STYLE_IMAGE_OPA, OHOS::STYLE_TEXT_COLOR,   OHOS::STYLE_TEXT_FONT, OHOS::STYLE_LETTER_SPACE, OHOS::STYLE_LINE_SPACE, OHOS::STYLE_TEXT_OPA,   OHOS::STYLE_LINE_COLOR, OHOS::STYLE_LINE_WIDTH, OHOS::STYLE_LINE_OPA, OHOS::STYLE_LINE_CAP }

Enumerates keys of styles.

OHOS::CapType : uint8_t { OHOS::CAP_NONE, OHOS::CAP_ROUND }

Enumerates cap styles.

OHOS::SysInfo::FPSCalculateType { OHOS::SysInfo::FPS_CT_FIXED_TIME, OHOS::SysInfo::FPS_CT_AVERAGE_SAMPLING, OHOS::SysInfo::FPS_CT_PRECISE_SAMPLING }

Enumerates the FPS capture types.

Functions

Function Name

Description

OHOS::AnimatorCallback::Callback (UIView view)=0

virtual void 

Called when each frame starts. This is a pure virtual function, which needs your inheritance and implementation.

OHOS::AnimatorCallback::OnStop (UIView &view)

virtual void 

Called when an animator stops. This is a pure virtual function, which needs your inheritance and implementation.

OHOS::AnimatorCallback::~AnimatorCallback ()

virtual 

A default destructor used to delete an AnimatorCallback instance.

OHOS::Animator::Animator ()

 

A default constructor used to create an Animator instance.

OHOS::Animator::Animator (AnimatorCallback callback, UIView view, uint32_t time, bool repeat)

 

A constructor used to create an Animator instance.

OHOS::Animator::~Animator ()

virtual 

A destructor used to delete the Animator instance.

OHOS::Animator::Start ()

void 

Starts this animator.

OHOS::Animator::Stop ()

void 

Stops this animator.

OHOS::Animator::Pause ()

void 

Pauses this animator.

OHOS::Animator::Resume ()

void 

Resumes this animator from where it was paused.

OHOS::Animator::GetState () const

uint8_t 

Obtains the current state of this animator.

OHOS::Animator::SetState (uint8_t state)

void 

Sets the current state for this animator.

OHOS::Animator::GetTime () const

uint32_t 

Obtains the total duration of this animator.

OHOS::Animator::SetTime (uint32_t time)

void 

Sets the total duration for this animator.

OHOS::Animator::GetRunTime () const

uint32_t 

Obtains the running time of this animator.

OHOS::Animator::SetRunTime (uint32_t runTime)

void 

Sets the running time for this animator.

OHOS::Animator::IsRepeat () const

bool 

Checks whether this animator is repeated.

OHOS::AnimatorManager::GetInstance ()

static AnimatorManager  

Obtains the AnimatorManager instance.

OHOS::AnimatorManager::Init () override

void 

Initializes this task.

OHOS::AnimatorManager::Add (Animator animator)

void 

Adds the Animator instance to the AnimatorManager linked list for management, so that the Run function of the Animator class is called once for each frame.

OHOS::AnimatorManager::Remove (const Animator animator)

void 

Removes the Animator instance from the AnimatorManager linked list.

OHOS::AnimatorManager::Callback () override

void 

Called when this task is executed.

OHOS::EasingEquation::SetBackOvershoot (double overshoot)

static void 

Sets the parameter s in the equation (s+1)t^3 - st^2 for a back easing.

OHOS::EasingEquation::BackEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in with an overshoot.

OHOS::EasingEquation::BackEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases out with an overshoot.

OHOS::EasingEquation::BackEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in and then out with an overshoot.

OHOS::EasingEquation::CircEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in shaping like a circular curve.

OHOS::EasingEquation::CircEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases out shaping like a circular curve.

OHOS::EasingEquation::CircEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in and then out shaping like a circular curve.

OHOS::EasingEquation::CubicEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in shaping like a cubic curve.

OHOS::EasingEquation::CubicEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases out shaping like a cubic curve.

OHOS::EasingEquation::CubicEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in and then out shaping like a cubic curve.

OHOS::EasingEquation::LinearEaseNone (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Displays no linear easing effects.

OHOS::EasingEquation::QuadEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in shaping like a quadratic curve.

OHOS::EasingEquation::QuadEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases out shaping like a quadratic curve.

OHOS::EasingEquation::QuadEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in and then out shaping like a quadratic curve.

OHOS::EasingEquation::QuintEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in shaping like a quintic curve.

OHOS::EasingEquation::QuintEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases out shaping like a quintic curve.

OHOS::EasingEquation::QuintEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in and then out shaping like a quintic curve.

OHOS::EasingEquation::SineEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in shaping like a sinusoidal curve.

OHOS::EasingEquation::SineEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases out shaping like a sinusoidal curve.

OHOS::EasingEquation::SineEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

static int16_t 

Eases in and then out shaping like a sinusoidal curve.

OHOS::Interpolation::GetBezierInterpolation (int16_t t, int16_t u0, int16_t u1, int16_t u2, int16_t u3)

static int16_t 

Obtains the value calculated by the cubic Bezier equation.

OHOS::Color::GetMixColor (ColorType c1, ColorType c2, uint8_t mix)

static ColorType 

Mixes two colors (color 1 and color 2) based on a specified opacity.

OHOS::Color::GetColorFromRGB (uint8_t r8, uint8_t g8, uint8_t b8)

static ColorType 

Obtains the color based on the RGB color value.

OHOS::Color::GetColorFromRGBA (uint8_t r8, uint8_t g8, uint8_t b8, uint8_t alpha)

static ColorType 

Obtains the color based on the RGBA color value.

OHOS::Color::ColorTo32 (ColorType color)

static uint32_t 

Converts color data into the RGBA8888 format.

OHOS::Color::ColorTo32 (Color16 color, uint8_t alpha)

static uint32_t 

Converts color data with the 16-bit color depth into the RGBA8888 format.

OHOS::Color::ColorTo16 (Color32 color)

static uint16_t 

Converts color data from the RGBA8888 format into the RGB565 format.

OHOS::Color::White ()

static ColorType 

Obtains the color data of white.

OHOS::Color::Silver ()

static ColorType 

Obtains the color data of silver.

OHOS::Color::Gray ()

static ColorType 

Obtains the color data of gray.

OHOS::Color::Black ()

static ColorType 

Obtains the color data of black.

OHOS::Color::Red ()

static ColorType 

Obtains the color data of red.

OHOS::Color::Maroon ()

static ColorType 

Obtains the color data of maroon.

OHOS::Color::Yellow ()

static ColorType 

Obtains the color data of yellow.

OHOS::Color::Olive ()

static ColorType 

Obtains the color data of olive.

OHOS::Color::Lime ()

static ColorType 

Obtains the color data of lime.

OHOS::Color::Green ()

static ColorType 

Obtains the color data of green.

OHOS::Color::Cyan ()

static ColorType 

Obtains the color data of cyan.

OHOS::Color::Aqua ()

static ColorType 

Obtains the color data of aqua.

OHOS::Color::Teal ()

static ColorType 

Obtains the color data of teal.

OHOS::Color::Blue ()

static ColorType 

Obtains the color data of blue.

OHOS::Color::Navy ()

static ColorType 

Obtains the color data of navy.

OHOS::Color::Magenta ()

static ColorType 

Obtains the color data of magenta.

OHOS::Color::Purple ()

static ColorType 

Obtains the color data of purple.

OHOS::Color::Orange ()

static ColorType 

Obtains the color data of orange.

OHOS::Image::Image ()

 

A constructor used to create an Image instance. You can use this constructor when a component requires a map.

OHOS::Image::~Image ()

virtual 

A destructor used to delete the Image instance.

OHOS::Image::GetImageInfo () const

const ImageInfo  

Obtains the image information in an array.

OHOS::Image::GetPath () const

const char  

Obtains the image path in binary.

OHOS::Image::GetHeader (ImageHeader &header) const

void 

Obtains the basic image information, including the image format, width, and height.

OHOS::Image::GetSrcType () const

uint8_t 

Obtains the image type.

OHOS::Image::SetSrc (const char src)

bool 

Sets the image path.

OHOS::Image::SetSrc (const ImageInfo src)

bool 

Sets the image information.

OHOS::Screen::GetInstance ()

static Screen

Obtains a singleton Screen instance.

OHOS::Screen::GetWidth ()

uint16_t 

Obtains the width of this screen.

OHOS::Screen::GetHeight ()

uint16_t 

Obtains the height of this screen.

OHOS::Task::Task ()

 

A constructor used to create a Task instance.

OHOS::Task::Task (uint32_t period)

 

A constructor used to create a Task instance with the specified running period.

OHOS::Task::~Task ()

virtual 

A destructor used to delete the Task instance.

OHOS::Task::SetPeriod (uint32_t period)

void 

Sets the running period for this task.

OHOS::Task::SetLastRun (uint32_t lastRun)

void 

Sets the end time for this task.

OHOS::Task::GetPeriod () const

uint32_t 

Obtains the running period of this task.

OHOS::Task::GetLastRun () const

uint32_t 

Obtains the end time of this task.

OHOS::Task::TaskExecute ()

void 

Executes this task.

OHOS::Task::Callback ()=0

virtual void 

Called when this task is executed.

OHOS::Task::Init ()

virtual void 

Initializes this task.

OHOS::Text::Text ()

 

A constructor used to create a Text instance.

OHOS::Text::~Text ()

virtual 

A destructor used to delete the Text instance.

OHOS::Text::SetText (const char text)

void 

Sets the content for this text.

OHOS::Text::GetText () const

const char  

Obtains the content of this text.

OHOS::Text::SetFont (const char name, uint8_t size)

void 

Sets the font name and size.

OHOS::Text::SetFontId (uint8_t fontId)

void 

Sets the font ID.

OHOS::Text::GetFontId () const

uint8_t 

Obtains the font ID.

OHOS::Text::SetDirect (UITextLanguageDirect direct)

void 

Sets the direction for this text.

OHOS::Text::GetDirect () const

UITextLanguageDirect 

Obtains the direction of this text.

OHOS::Text::SetAlign (UITextLanguageAlignment horizontalAlign, UITextLanguageAlignment verticalAlign=TEXT_ALIGNMENT_TOP)

void 

Sets the alignment mode for this text.

OHOS::Text::GetHorAlign () const

UITextLanguageAlignment 

Obtains the horizontal alignment mode.

OHOS::Text::GetVerAlign () const

UITextLanguageAlignment 

Obtains the vertical alignment mode.

OHOS::Text::SetTextRotation (LabelRotateDegree angle)

void 

Sets the clockwise rotation angle for this text.

OHOS::Text::GetTextRotation () const

LabelRotateDegree 

Obtains the clockwise rotation degree of this text.

OHOS::Text::GetTextRotateDegree () const

uint16_t 

Obtains the number of text rotation degrees.

OHOS::Text::GetTextSize () const

Point 

Obtains the size of this text.

OHOS::Text::SetExpandWidth (bool expand)

void 

Sets whether to adapt the component width to this text.

OHOS::Text::IsExpandWidth () const

bool 

Checks whether the component width adapts to this text.

OHOS::Text::SetExpandHeight (bool expand)

void 

Sets whether to adapt the component height to this text.

OHOS::Text::IsExpandHeight () const

bool 

Checks whether the component height adapts to this text.

OHOS::Text::GetEllipsisIndex (const Rect &textRect, const Style &style)

uint16_t 

Obtains the index of the character from where text will be replaced by ellipses based on the text rectangle and style.

OHOS::AbstractAdapter::AbstractAdapter ()

 

A constructor used to create an AbstractAdapter instance.

OHOS::AbstractAdapter::~AbstractAdapter ()

virtual 

A destructor used to delete the AbstractAdapter instance.

OHOS::AbstractAdapter::GetCount ()=0

virtual uint16_t 

Obtains the number of adapter data items.

OHOS::AbstractAdapter::GetView (UIView inView, int16_t index)=0

virtual UIView  

Obtains a UIView instance to convert adapter data into another UIView instance.

OHOS::RootView::GetInstance ()

static RootView  

Obtains a singleton RootView instance.

OHOS::RootView::OnKeyActListener::OnKeyAct (UIView &view, const KeyEvent &event)=0

virtual bool 

Responds to a physical key event.

OHOS::RootView::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::RootView::OnKeyEvent (const KeyEvent &event)

virtual void 

Executes a physical key event.

OHOS::RootView::SetOnKeyActListener (OnKeyActListener onKeyActListener)

void 

Sets the listener that contains a callback to be invoked upon a physical key event.

OHOS::RootView::ClearOnKeyActListener ()

void 

Clears the listener for monitoring physical key events.

OHOS::RootView::OnVirtualDeviceEventListener::OnVirtualDeviceEvent (UIView &view, VirtualDeviceEvent event)=0

virtual bool 

Responds to an input event triggered by a virtual device.

OHOS::RootView::OnVirtualDeviceEvent (const VirtualDeviceEvent &event)

virtual void 

Executes an input event triggered by a virtual device.

OHOS::RootView::SetOnVirtualDeviceEventListener (OnVirtualDeviceEventListener onVirtualDeviceEventListener)

void 

Sets a listener for monitoring the input events of a virtual device.

OHOS::RootView::ClearOnVirtualDeviceEventListener ()

void 

Clears the listener for monitoring the input events of a virtual device.

OHOS::RootView::FindSubView (const UIView &parentView, const UIView subView)

static bool 

Checks whether the target view is one of the child views of the specified parent view.

OHOS::TextFormatter::Format (int16_t value, char outText, uint16_t textLen)

virtual bool 

Converts the input integer into a character string for output.

OHOS::TextAdapter::TextAdapter ()

 

A constructor used to create a UILabel instance.

OHOS::TextAdapter::~TextAdapter ()

virtual 

A destructor used to delete the UILabel instance.

OHOS::TextAdapter::GetView (UIView inView, int16_t index) override

UIView  

Obtains a UILabel instance to convert adapter data into another UILabel instance.

OHOS::TextAdapter::SetData (List< const char > data)

void 

Sets the UILabel adapter data, which is a string linked list.

OHOS::TextAdapter::SetData (int16_t start, int16_t end)

void 

Sets continuously increasing data. For example, if you need to set data 0, 1, 2, 3, 4, use this function to set start to 0 and end to 4.

OHOS::TextAdapter::SetFontId (uint8_t fontId)

void 

Sets font ID.

OHOS::TextAdapter::GetFontId () const

uint8_t 

Obtains font ID.

OHOS::TextAdapter::SetFont (const char name, uint8_t size)

void 

Sets the font.

OHOS::TextAdapter::GetStyle ()

Style

Obtains the UILabel adapter style.

OHOS::TextAdapter::GetCount () override

virtual uint16_t 

Obtains the data size of the UILabel adapter.

OHOS::TextAdapter::SetWidth (int16_t width)

void 

Sets the width of UILabel constructed by the adapter.

OHOS::TextAdapter::SetDirect (UITextLanguageDirect direct)

void 

Sets the direction of the UILabel constructed by the adapter.

OHOS::TextAdapter::SetHeight (int16_t height)

void 

Sets the height of the UILabel constructed by the adapter.

OHOS::TextAdapter::SetLineBreakMode (const uint8_t lineBreakMode)

void 

Sets the LineBreakMode attribute of UILabel constructed by the adapter. For details about the values of LineBreakMode, see LINE_BREAK_ADAPT, LINE_BREAK_WRAP, LINE_BREAK_ELLIPSIS, and LINE_BREAK_MARQUEE.

OHOS::TextAdapter::SetOnClickListener (UIView::OnClickListener clickListener)

void 

Sets the callback function to be invoked upon a click event.

OHOS::TextAdapter::SetTextFormatter (TextFormatter formatter)

void 

Sets the text formatter.

OHOS::UIAbstractClock::UIAbstractClock ()

 

A default constructor used to create a UIAbstractClock instance.

OHOS::UIAbstractClock::UIAbstractClock (uint8_t hour, uint8_t minute, uint8_t second)

 

A constructor used to create a UIAbstractClock instance with time elements (hour, minute and second).

OHOS::UIAbstractClock::~UIAbstractClock ()

virtual 

A destructor used to delete the UIAbstractClock instance.

OHOS::UIAbstractClock::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIAbstractClock::SetTime24Hour (uint8_t hour, uint8_t minute, uint8_t second)

void 

Sets the time in 24-hour format.

OHOS::UIAbstractClock::SetTime12Hour (uint8_t hour, uint8_t minute, uint8_t second, bool am)

void 

Sets the time in 12-hour format.

OHOS::UIAbstractClock::GetCurrentHour () const

uint8_t 

Obtains the current number of hours.

OHOS::UIAbstractClock::GetCurrentMinute () const

uint8_t 

Obtains the current number of minutes.

OHOS::UIAbstractClock::GetCurrentSecond () const

uint8_t 

Obtains the current number of seconds.

OHOS::UIAbstractClock::IncOneSecond ()

void 

Increases the time by one second.

OHOS::UIAbstractClock::UpdateClock (bool clockInit)

virtual void 

Updates this clock.

OHOS::UIAbstractClock::SetWorkMode (WorkMode newMode)

virtual void 

Sets the working mode for this clock.

OHOS::UIAbstractClock::GetWorkMode () const

virtual WorkMode 

Obtains the working mode of this clock.

OHOS::UIAbstractProgress::UIAbstractProgress ()

 

A constructor used to create a UIAbstractProgress instance.

OHOS::UIAbstractProgress::~UIAbstractProgress ()

virtual 

A destructor used to delete the UIAbstractProgress instance.

OHOS::UIAbstractProgress::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UIAbstractProgress::EnableBackground (bool enable)

void 

Sets whether the background of the progress bar is visible.

OHOS::UIAbstractProgress::SetValue (int16_t value)

void 

Sets the current value for this progress bar.

OHOS::UIAbstractProgress::GetValue () const

int16_t 

Obtains the current value of this progress bar.

OHOS::UIAbstractProgress::SetRange (int16_t rangeMax, int16_t rangeMin)

void 

Sets the range for this progress bar.

OHOS::UIAbstractProgress::GetRangeMin () const

int16_t 

Obtains the minimum value of this progress bar.

OHOS::UIAbstractProgress::GetRangeMax () const

int16_t 

Obtains the maximum value of this progress bar.

OHOS::UIAbstractProgress::SetImage (const char foregroundImage, const char backgroundImage=nullptr)

void 

Sets the image for this progress bar.

OHOS::UIAbstractProgress::SetImage (const ImageInfo foregroundImage, const ImageInfo backgroundImage=nullptr)

void 

Sets the image as a pixel map for this progress bar.

OHOS::UIAbstractProgress::SetStep (uint16_t step)

void 

Sets the step for this progress bar.

OHOS::UIAbstractProgress::GetStep () const

uint16_t 

Obtains the current step of this progress bar.

OHOS::UIAbstractProgress::SetBackgroundStyle (const Style &style)

void 

Sets the background style for this progress bar.

OHOS::UIAbstractProgress::SetBackgroundStyle (uint8_t key, int64_t value)

void 

Sets a background style for this progress bar.

OHOS::UIAbstractProgress::GetBackgroundStyle () const

const Style

Obtains the background style of this progress bar.

OHOS::UIAbstractProgress::GetBackgroundStyle (uint8_t key) const

int64_t 

Obtains the value of a background style of this progress bar.

OHOS::UIAbstractProgress::SetForegroundStyle (const Style &style)

void 

Sets the foreground style for this progress bar.

OHOS::UIAbstractProgress::SetForegroundStyle (uint8_t key, int64_t value)

void 

Sets a foreground style for this progress bar.

OHOS::UIAbstractProgress::GetForegroundStyle () const

const Style

Obtains the foreground style of this progress bar.

OHOS::UIAbstractProgress::GetForegroundStyle (uint8_t key) const

int64_t 

Obtains the value of a foreground style of this progress bar.

OHOS::UIAbstractProgress::SetCapType (CapType cap)

void 

Sets the type of caps on the background and foreground of the progress bar.

OHOS::UIAbstractScroll::UIAbstractScroll ()

 

A constructor used to create a UIAbstractScroll instance.

OHOS::UIAbstractScroll::~UIAbstractScroll ()

virtual 

A destructor used to delete the UIAbstractScroll instance.

OHOS::UIAbstractScroll::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIAbstractScroll::GetDirection () const

uint8_t 

Obtains the scroll direction.

OHOS::UIAbstractScroll::SetScrollBlankSize (uint16_t size)

void 

Sets the blank size for this scroll view.

OHOS::UIAbstractScroll::SetMaxScrollDistance (uint16_t distance)

void 

Sets the maximum scroll distance after a finger lifts the screen.

OHOS::UIAbstractScroll::SetReboundSize (uint16_t size)

void 

Sets the rebound size, which is the distance a knob moves after being released when it reaches the end of a scrollbar.

OHOS::UIAbstractScroll::GetMaxScrollDistance () const

uint16_t 

Obtains the maximum scroll distance after a finger lifts the screen.

OHOS::UIAbstractScroll::SetDragFunc (EasingFunc func)

void 

Sets the easing function that specifies a scroll animation after a finger lifts the screen.

OHOS::UIAbstractScroll::SetThrowDrag (bool throwDrag)

void 

Sets whether to continue scrolling after a finger lifts the screen.

OHOS::UIAbstractScroll::MoveChildByOffset (int16_t offsetX, int16_t offsetY) override

void 

Moves the position of all child views.

OHOS::UIAbstractScroll::SetDragACCLevel (uint16_t value)

void 

Sets the drag acceleration.

OHOS::UIAbstractScroll::GetDragACCLevel () const

uint8_t 

Obtains the drag acceleration.

OHOS::UIAbstractScroll::SetSwipeACCLevel (uint16_t value)

void 

Sets the compensation distance after a finger lifts the screen.

OHOS::UIAbstractScroll::GetSwipeACCLevel () const

uint8_t 

Obtains the compensation distance after a finger lifts the screen.

OHOS::UIAnalogClock::UIAnalogClock ()

 

A default constructor used to create a UIAnalogClock instance.

OHOS::UIAnalogClock::~UIAnalogClock ()

virtual 

A destructor used to delete the UIAnalogClock instance.

OHOS::UIAnalogClock::Hand::Hand ()

 

A default constructor used to create a Hand instance.

OHOS::UIAnalogClock::Hand::~Hand ()

virtual 

A destructor used to delete the Hand instance.

OHOS::UIAnalogClock::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIAnalogClock::SetHandImage (HandType type, const UIImageView &img, Point position, Point center)

void 

Sets the image used to draw a clock hand.

OHOS::UIAnalogClock::SetHandLine (HandType type, Point position, Point center, ColorType color, uint16_t width, uint16_t height, OpacityType opacity)

void 

Sets the line used to draw a clock hand.

OHOS::UIAnalogClock::GetHandRotateCenter (HandType type) const

Point 

Obtains the rotation center of a specified clock hand.

OHOS::UIAnalogClock::GetHandPosition (HandType type) const

Point 

Obtains the position of a specified clock hand.

OHOS::UIAnalogClock::GetHandInitAngle (HandType type) const

uint16_t 

Obtains the initial rotation angle of the specified clock hand.

OHOS::UIAnalogClock::GetHandCurrentAngle (HandType type) const

uint16_t 

Obtains the current rotation angle of the specified clock hand.

OHOS::UIAnalogClock::SetInitTime24Hour (uint8_t hour, uint8_t minute, uint8_t second)

void 

Sets the initial time in the 24-hour format.

OHOS::UIAnalogClock::SetInitTime12Hour (uint8_t hour, uint8_t minute, uint8_t second, bool am)

void 

Sets the initial time in the 12-hour format.

OHOS::UIAnalogClock::OnDraw (const Rect &invalidatedArea) override

void 

Draws an analog clock.

OHOS::UIAnalogClock::OnPostDraw (const Rect &invalidatedArea) override

virtual void 

Performs the operations needed after the drawing.

OHOS::UIAnalogClock::SetPosition (int16_t x, int16_t y) override

void 

Sets the position for this analog clock.

OHOS::UIAnalogClock::SetPosition (int16_t x, int16_t y, int16_t width, int16_t height) override

void 

Sets the position and size for this analog clock.

OHOS::UIAnalogClock::SetWorkMode (WorkMode newMode) override

void 

Sets the working mode for this analog clock.

OHOS::UIAnalogClock::UpdateClock (bool clockInit) override

void 

Updates the time of this analog clock.

OHOS::UIArcLabel::UIArcLabel ()

 

A default constructor used to create a UIArcLabel instance.

OHOS::UIArcLabel::~UIArcLabel ()

virtual 

A destructor used to delete the UIArcLabel instance.

OHOS::UIArcLabel::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIArcLabel::GetWidth () override

int16_t 

Obtains the width of this arc text.

OHOS::UIArcLabel::GetHeight () override

int16_t 

Obtains the height of this arc text.

OHOS::UIArcLabel::SetText (const char text)

void 

Sets the text content for this arc label.

OHOS::UIArcLabel::GetText () const

const char  

Obtains the text of this arc label.

OHOS::UIArcLabel::SetAlign (UITextLanguageAlignment horizontalAlign)

void 

Sets the alignment mode for this text.

OHOS::UIArcLabel::GetHorAlign () const

UITextLanguageAlignment 

Obtains the horizontal alignment mode.

OHOS::UIArcLabel::GetDirect ()

UITextLanguageDirect 

Obtains the direction of this text.

OHOS::UIArcLabel::SetFontId (uint8_t fontId)

void 

Sets the font ID for this arc label.

OHOS::UIArcLabel::GetFontId () const

uint8_t 

Obtains the font ID composed of font name and size.

OHOS::UIArcLabel::SetFont (const char name, uint8_t size)

void 

Sets the font for this arc label.

OHOS::UIArcLabel::SetArcTextCenter (int16_t x, int16_t y)

void 

Sets the center position for this arc text.

OHOS::UIArcLabel::GetArcTextCenter () const

Point 

Obtains the center position of this arc text.

OHOS::UIArcLabel::SetArcTextRadius (uint16_t radius)

void 

Sets the radius for this arc text.

OHOS::UIArcLabel::GetArcTextRadius () const

uint16_t 

Obtains the radius of this arc text.

OHOS::UIArcLabel::SetArcTextAngle (int16_t startAngle, int16_t endAngle)

void 

Sets the start angle and end angle for this arc text.

OHOS::UIArcLabel::GetArcTextStartAngle () const

int16_t 

Obtains the start angle of this arc text.

OHOS::UIArcLabel::GetArcTextEndAngle () const

int16_t 

Obtains the end angle of this arc text.

OHOS::UIArcLabel::SetArcTextOrientation (TextOrientation orientation)

void 

Sets the orientation for this arc text.

OHOS::UIArcLabel::GetArcTextOrientation () const

TextOrientation 

Obtains the orientation of this arc text.

OHOS::UIArcLabel::OnDraw (const Rect &invalidatedArea) override

virtual void 

Draws an arc text.

OHOS::UIAxis::UIAxis ()

 

A constructor used to create a UIAxis instance.

OHOS::UIAxis::~UIAxis ()

virtual 

A destructor used to delete the UIAxis instance.

OHOS::UIAxis::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIAxis::SetDataRange (uint16_t min, uint16_t max)=0

virtual bool 

Sets the value range of a coordinate axis.

OHOS::UIAxis::SetMarkNum (uint16_t count)=0

virtual void 

Sets the number of scales on a coordinate axis.

OHOS::UIAxis::SetLineColor (const ColorType &color)

void 

Sets the line color of the coordinate axis.

OHOS::UIAxis::OnDraw (const Rect &invalidatedArea) override

void 

Called when a view is drawn.

OHOS::UIAxis::OnPreDraw (const Rect &invalidatedArea) override

bool 

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

OHOS::UIAxis::TranslateToPixel (int16_t &value)=0

virtual void 

Translates data into pixel coordinates.

OHOS::UIXAxis::UIXAxis ()

 

A constructor used to create a UIXAxis instance.

OHOS::UIXAxis::~UIXAxis ()

virtual 

A destructor used to delete the UIXAxis instance.

OHOS::UIXAxis::TranslateToPixel (int16_t &value) override

void 

Translates data into the x coordinate of a pixel.

OHOS::UIXAxis::SetDataRange (uint16_t min, uint16_t max) override

bool 

Sets the value range of the X axis.

OHOS::UIXAxis::SetMarkNum (uint16_t count) override

void 

Sets the number of scales on the x-axis.

OHOS::UIYAxis::UIYAxis ()

 

A constructor used to create a UIYAxis instance.

OHOS::UIYAxis::~UIYAxis ()

virtual 

A destructor used to delete the UIYAxis instance.

OHOS::UIYAxis::TranslateToPixel (int16_t &value) override

void 

Translates data into the y coordinate of a pixel.

OHOS::UIYAxis::SetDataRange (uint16_t min, uint16_t max) override

bool 

Sets the value range of the y-axis.

OHOS::UIYAxis::SetMarkNum (uint16_t count) override

void 

Sets the number of scales on the Y axis.

OHOS::UIBoxProgress::UIBoxProgress ()

 

A constructor used to create a UIBoxProgress instance.

OHOS::UIBoxProgress::~UIBoxProgress ()

virtual 

A destructor used to delete the UIBoxProgress instance.

OHOS::UIBoxProgress::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIBoxProgress::SetWidth (int16_t width) override

void 

Sets the width for the view holding this progress bar.

OHOS::UIBoxProgress::SetHeight (int16_t height) override

void 

Sets the height for this view.

OHOS::UIBoxProgress::SetDirection (const Direction &direction)

void 

Sets the direction for this progress bar.

OHOS::UIBoxProgress::GetDirection () const

Direction 

Obtains the direction of this progress bar.

OHOS::UIBoxProgress::SetValidWidth (int16_t width)

void 

Sets the actual width for this progress bar.

OHOS::UIBoxProgress::GetValidWidth () const

int16_t 

Obtains the actual width of this progress bar.

OHOS::UIBoxProgress::SetValidHeight (int16_t height)

void 

Sets the actual height for this progress bar.

OHOS::UIBoxProgress::GetValidHeight () const

int16_t 

Obtains the actual height of this progress bar.

OHOS::UIBoxProgress::OnDraw (const Rect &invalidatedArea) override

void 

Called when a view is drawn.

OHOS::UIButton::UIButton ()

 

A constructor used to create a UIButton instance.

OHOS::UIButton::UIButton (const char id)

 

A constructor used to create a UIButton instance based on the button ID.

OHOS::UIButton::~UIButton ()

virtual 

A destructor used to delete the UIButton instance.

OHOS::UIButton::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UIButton::OnPreDraw (const Rect &invalidatedArea) override

bool 

Do something before draw, this function will be invoked mainly to check if this view need to cover invalidate area so render manager can decide which layer to draw firstly.

OHOS::UIButton::OnDraw (const Rect &invalidatedArea) override

void 

Executes the draw action.

OHOS::UIButton::OnPressEvent (const PressEvent &event) override

void 

Executes the press event action.

OHOS::UIButton::OnReleaseEvent (const ReleaseEvent &event) override

void 

Executes the press release event action.

OHOS::UIButton::OnCancelEvent (const CancelEvent &event) override

void 

Executes the cancel event action.

OHOS::UIButton::SetImageSrc (const char defaultImgSrc, const char triggeredImgSrc)

void 

Sets the image for this button.

OHOS::UIButton::SetImageSrc (const ImageInfo defaultImgSrc, const ImageInfo triggeredImgSrc)

void 

Sets the image for this button.

OHOS::UIButton::SetImagePosition (const int16_t x, const int16_t y)

void 

Sets the position for this image.

OHOS::UIButton::GetImageX () const

int16_t 

Obtains the x-coordinate of this image.

OHOS::UIButton::GetImageY () const

int16_t 

Obtains the y-coordinate of this image.

OHOS::UIButton::GetCurImageSrc () const

const Image  

Obtains the image for the current button state.

OHOS::UIButton::GetWidth () override

int16_t 

Obtains the width of this image.

OHOS::UIButton::GetHeight () override

int16_t 

Obtains the height of this image.

OHOS::UIButton::SetWidth (int16_t width) override

void 

Sets the width for this image.

OHOS::UIButton::SetHeight (int16_t height) override

void 

Sets the height for this image.

OHOS::UIButton::GetContentRect () override

virtual Rect 

Obtains a rectangular area that contains coordinate information.

OHOS::UIButton::GetStyle (uint8_t key) const override

int64_t 

Obtains the value of a style.

OHOS::UIButton::SetStyle (uint8_t key, int64_t value) override

void 

Sets a style.

OHOS::UIButton::GetStyleForState (uint8_t key, ButtonState state) const

int64_t 

Obtains the style of a button in a specific state.

OHOS::UIButton::SetStyleForState (uint8_t key, int64_t value, ButtonState state)

void 

Sets the style for a button in a specific state.

OHOS::UIButton::Disable ()

void 

Disables this button.

OHOS::UIButton::Enable ()

void 

Enables this button.

OHOS::UIButton::SetStateForStyle (ButtonState state)

void 

Sets the state for a button. After the setting, calling SetStyle will change the style of this button, but not its state.

OHOS::Paint::Paint ()

 

A constructor used to create a Paint instance.

OHOS::Paint::~Paint ()

virtual 

A destructor used to delete the Paint instance.

OHOS::Paint::SetStyle (PaintStyle style)

void 

Sets the paint style of a closed graph.

OHOS::Paint::GetStyle () const

PaintStyle 

Obtains the paint style of a closed graph.

OHOS::Paint::SetStrokeWidth (uint16_t width)

void 

Sets the width of a line or border.

OHOS::Paint::GetStrokeWidth () const

uint16_t 

Obtains the width of a line or border.

OHOS::Paint::SetStrokeColor (ColorType color)

void 

Sets the color of a line or border.

OHOS::Paint::GetStrokeColor () const

ColorType 

Obtains the color of a line or border.

OHOS::Paint::SetFillColor (ColorType color)

void 

Sets fill color.

OHOS::Paint::GetFillColor () const

ColorType 

Obtains the fill color.

OHOS::Paint::SetOpacity (uint8_t opacity)

void 

Sets the opacity.

OHOS::Paint::GetOpacity () const

uint8_t 

Obtains the opacity.

OHOS::UICanvas::UICanvas ()

 

A constructor used to create a UICanvas instance.

OHOS::UICanvas::~UICanvas ()

virtual 

A destructor used to delete the UICanvas instance.

OHOS::UICanvas::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UICanvas::Clear ()

void 

Clears the entire canvas.

OHOS::UICanvas::SetStartPosition (const Point &startPoint)

void 

Sets the coordinates of the start point for drawing a line. For example, if startPoint is set to {50, 50}, the line is drawn from this set of coordinates on the canvas.

OHOS::UICanvas::GetStartPosition () const

const Point

Obtains the coordinates of the start point of a line.

OHOS::UICanvas::DrawLine (const Point &endPoint, const Paint &paint)

void 

Draws a straight line.

OHOS::UICanvas::DrawLine (const Point &startPoint, const Point &endPoint, const Paint &paint)

void 

Draws a straight line from the coordinates of the start point.

OHOS::UICanvas::DrawCurve (const Point &control1, const Point &control2, const Point &endPoint, const Paint &paint)

void 

Draws a cubic Bezier curve.

OHOS::UICanvas::DrawCurve (const Point &startPoint, const Point &control1, const Point &control2, const Point &endPoint, const Paint &paint)

void 

Draws a cubic Bezier curve from the start point coordinates.

OHOS::UICanvas::DrawRect (const Point &startPoint, int16_t height, int16_t width, const Paint &paint)

void 

Draws a rectangle.

OHOS::UICanvas::DrawCircle (const Point &center, uint16_t radius, const Paint &paint)

void 

Draws a circle.

OHOS::UICanvas::DrawSector (const Point &center, uint16_t radius, int16_t startAngle, int16_t endAngle, const Paint &paint)

void 

Draws a sector.

OHOS::UICanvas::DrawArc (const Point &center, uint16_t radius, int16_t startAngle, int16_t endAngle, const Paint &paint)

void 

Draws an arc.

OHOS::UICanvas::DrawImage (const Point &startPoint, const char image, const Paint &paint)

void 

Draws an image.

OHOS::UICanvas::DrawLabel (const Point &startPoint, const char text, uint16_t maxWidth, const FontStyle &fontStyle, const Paint &paint)

void 

Draws text.

OHOS::UICanvas::OnDraw (const Rect &invalidatedArea) override

virtual void 

Called when a view is drawn.

OHOS::UIChartDataSerial::UIChartDataSerial ()

 

A constructor used to create a UIChartDataSerial instance.

OHOS::UIChartDataSerial::~UIChartDataSerial ()

virtual 

A destructor used to delete the UIChartDataSerial instance.

OHOS::UIChartDataSerial::SetMaxDataCount (uint16_t maxCount)

bool 

Sets the maximum number of data points that can be stored in a data set.

OHOS::UIChartDataSerial::ModifyPoint (uint16_t index, const Point &point)

bool 

Modifies the value of a data point in the data set.

OHOS::UIChartDataSerial::GetPoint (uint16_t index, Point &point)

bool 

Obtains the coordinates in the chart for a data point in the data set.

OHOS::UIChartDataSerial::AddPoints (const Point data, uint16_t count)

bool 

Adds data points.

OHOS::UIChartDataSerial::ClearData ()

void 

Clears all data points.

OHOS::UIChartDataSerial::GetDataCount () const

uint16_t 

Obtains the number of data points available in the data set.

OHOS::UIChartDataSerial::EnableSmooth (bool smooth)

void 

Sets whether to smooth a polyline.

OHOS::UIChartDataSerial::IsSmooth () const

bool 

Checks whether smoothing is performed on a polyline.

OHOS::UIChartDataSerial::EnableGradient (bool enable)

void 

Enables the fill color of a line chart.

OHOS::UIChartDataSerial::IsGradient () const

bool 

Checks whether a polyline has a fill color.

OHOS::UIChartDataSerial::GetPeakIndex () const

uint16_t 

Obtains the index of the top point in the data set.

OHOS::UIChartDataSerial::GetLatestIndex () const

uint16_t 

Obtains the index of the frontmost point (the latest added or modified data point in a data set).

OHOS::UIChartDataSerial::GetValleyIndex () const

uint16_t 

Obtains the index of the bottom point in a data set.

OHOS::UIChartDataSerial::GetPeakData () const

int16_t 

Obtains the Y value of the top point in a data set.

OHOS::UIChartDataSerial::GetValleyData () const

int16_t 

Obtains the Y value of the bottom point in a data set.

OHOS::UIChartDataSerial::GetLineColor () const

ColorType 

Obtains the polyline color of the data set in a line chart.

OHOS::UIChartDataSerial::GetFillColor () const

ColorType 

Obtains the fill color of the data set.

OHOS::UIChartDataSerial::SetFillColor (const ColorType &color)

void 

Sets the fill color of the data set.

OHOS::UIChartDataSerial::SetLineColor (const ColorType &color)

void 

Sets the polyline color of the data set in the line chart.

OHOS::UIChartDataSerial::HidePoint (uint16_t index, uint16_t count)

void 

Hides some points in the data set.

OHOS::UIChartDataSerial::GetHideIndex () const

uint16_t 

Obtains the index from which the data set starts to hide.

OHOS::UIChartDataSerial::GetHideCount () const

uint16_t 

Obtains the number of hidden points in the data set.

OHOS::UIChartDataSerial::SetHeadPointStyle (const PointStyle &style)

void 

Sets the style of the frontmost point on a polyline.

OHOS::UIChartDataSerial::SetTopPointStyle (const PointStyle &style)

void 

Sets the style of the top point of a polyline.

OHOS::UIChartDataSerial::SetBottomPointStyle (const PointStyle &style)

void 

Sets the style of the bottom point of a polyline.

OHOS::UIChartDataSerial::GetHeadPointStyle () const

const PointStyle

Obtains the style of the frontmost point on a polyline.

OHOS::UIChartDataSerial::GetTopPointStyle () const

const PointStyle

Obtains the style of the top point of a polyline.

OHOS::UIChartDataSerial::GetBottomPointStyle () const

const PointStyle

Obtains the style of the bottom point of a polyline.

OHOS::UIChartDataSerial::EnableHeadPoint (bool enable)

void 

Enables the feature of drawing the frontmost point on a polyline.

OHOS::UIChartDataSerial::EnableTopPoint (bool enable)

void 

Enables the feature of drawing the top point of a polyline. If there are multiple top points, only the first one is drawn.

OHOS::UIChartDataSerial::EnableBottomPoint (bool enable)

void 

Enables the feature of drawing the bottom point of a polyline. If there are multiple bottom points, only the first one is drawn.

OHOS::UIChart::UIChart ()

 

A constructor used to create a UIChart instance.

OHOS::UIChart::~UIChart ()

virtual 

A destructor used to delete the UIChart instance.

OHOS::UIChart::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIChart::SetHeight (int16_t height) override

void 

Sets the height for this component.

OHOS::UIChart::SetWidth (int16_t width) override

void 

Sets the width for this component.

OHOS::UIChart::OnPreDraw (const Rect &invalidatedArea) override

bool 

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

OHOS::UIChart::OnDraw (const Rect &invalidatedArea) override

void 

Called when a view is drawn.

OHOS::UIChart::AddDataSerial (UIChartDataSerial dataSerial)

virtual bool 

Adds a data set.

OHOS::UIChart::DeleteDataSerial (UIChartDataSerial dataSerial)

virtual bool 

Deletes a data set.

OHOS::UIChart::ClearDataSerial ()

virtual void 

Clears all data sets.

OHOS::UIChart::RefreshChart ()=0

virtual void 

Refreshes a chart and redraws the dirty region.

OHOS::UIChart::GetXAxis ()

UIXAxis

Obtains the x-axis instance.

OHOS::UIChart::GetYAxis ()

UIYAxis

Obtains the y-axis instance.

OHOS::UIChart::EnableReverse (bool enable)

void 

Enables chart reverse.

OHOS::UIChartPillar::UIChartPillar ()

 

A constructor used to create a UIChartPillar instance.

OHOS::UIChartPillar::~UIChartPillar ()

virtual 

A destructor used to delete the UIChartPillar instance.

OHOS::UIChartPillar::RefreshChart () override

void 

Refreshes a bar chart and redraws the dirty region.

OHOS::UIChartPolyline::UIChartPolyline ()

 

A constructor used to create a UIChartPolyline instance.

OHOS::UIChartPolyline::~UIChartPolyline ()

virtual 

A destructor used to delete the UIChartPolyline instance.

OHOS::UIChartPolyline::RefreshChart () override

void 

Refreshes a line chart and redraws the dirty region.

OHOS::UIChartPolyline::SetGradientOpacity (uint8_t minOpa, uint8_t maxOpa)

void 

Sets the opacity range of the fill color gradient.

OHOS::UIChartPolyline::SetGradientBottom (uint16_t bottom)

void 

Sets the distance between the bottom edge of the fill color range and the x-axis.

OHOS::UICheckBox::UICheckBox ()

 

A constructor used to create a UICheckBox instance.

OHOS::UICheckBox::~UICheckBox ()

virtual 

A destructor used to delete the UICheckBox instance.

OHOS::UICheckBox::OnChangeListener::OnChange (UICheckBoxState state)=0

virtual bool 

Called when the state of this check box is switched. This is a virtual function, which needs your implementation.

OHOS::UICheckBox::OnChangeListener::~OnChangeListener ()

virtual 

A destructor used to delete the OnChangeListener instance.

OHOS::UICheckBox::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UICheckBox::SetOnChangeListener (OnChangeListener onStateChangeListener)

void 

Sets the listener for this check box.

OHOS::UICheckBox::OnPreDraw (const Rect &invalidatedArea) override

bool 

Do something before draw, this function will be invoked mainly to check if this view need to cover invalidate area so render manager can decide which layer to draw firstly.

OHOS::UICheckBox::OnDraw (const Rect &invalidatedArea) override

void 

Executes the draw action Ondraw invokes the rendering function provided by the underlying layer to draw pictures based on the selected status of the checkbox.

OHOS::UICheckBox::OnClickEvent (const ClickEvent &event) override

void 

Executes the click event action OnClickEvent will reverse the selected state of checkbox. Example: If the check box is selected, the checkbox status is changed to Unselected after the click action is taken.

OHOS::UICheckBox::SetImages (const char selectedImageSrc, const char unselectedImageSrc)

virtual void 

Sets the images for this check box.

OHOS::UICheckBox::SetImages (const ImageInfo selectedImageSrc, const ImageInfo unselectedImageSrc)

virtual void 

Sets the images for this check box.

OHOS::UICheckBox::GetState () const

UICheckBoxState 

Obtains the state of this check box.

OHOS::UICheckBox::SetState (UICheckBoxState state)

void 

Sets the state for this check box.

OHOS::UICircleProgress::UICircleProgress ()

 

A constructor used to create a UICircleProgress instance.

OHOS::UICircleProgress::~UICircleProgress ()

virtual 

A destructor used to delete the UICircleProgress instance.

OHOS::UICircleProgress::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UICircleProgress::OnPreDraw (const Rect &invalidatedArea) override

bool 

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

OHOS::UICircleProgress::OnDraw (const Rect &invalidatedArea) override

void 

Called when a view is drawn.

OHOS::UICircleProgress::SetCenterPosition (int16_t x, int16_t y)

void 

Sets the coordinates of the center point for this circular progress bar.

OHOS::UICircleProgress::GetCenterPosition () const

Point 

Obtains the coordinates of the center point for this circular progress bar.

OHOS::UICircleProgress::SetRadius (uint16_t radius)

void 

Sets the outer radius for this circular progress bar.

OHOS::UICircleProgress::GetRadius () const

uint16_t 

Obtains the outer radius of this circular progress bar.

OHOS::UICircleProgress::SetStartAngle (int16_t startAngle)

void 

Sets the start angle.

OHOS::UICircleProgress::GetStartAngle () const

int16_t 

Obtains the start angle.

OHOS::UICircleProgress::SetEndAngle (int16_t endAngle)

void 

Sets the end angle.

OHOS::UICircleProgress::GetEndAngle () const

int16_t 

Obtains the end angle.

OHOS::UICircleProgress::SetProgressImagePosition (int16_t x, int16_t y)

void 

Sets the coordinates of the foreground image for this progress bar relative to the view.

OHOS::UICircleProgress::SetBackgroundImagePosition (int16_t x, int16_t y)

void 

Sets the coordinates of the background image for this progress bar relative to the view.

OHOS::UICircleProgress::SetLineColor (ColorType color)

void 

Sets the foreground color for this progress bar.

OHOS::UIDialog::UIDialog ()

 

A constructor used to create a UIDialog instance.

OHOS::UIDialog::~UIDialog ()

virtual 

A destructor used to delete the UIDialog instance.

OHOS::UIDialog::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIDialog::SetTitle (const char title)

void 

Sets the title for this dialog box.

OHOS::UIDialog::SetText (const char text)

void 

Sets the text for this dialog box.

OHOS::UIDialog::OnPreDraw (const Rect &invalidatedArea) override

bool 

Checks whether this label needs to be covered before drawing it.

OHOS::UIDialog::SetButton (DialogButtonType buttonType, const char text, OnClickListener listener)

void 

Sets a button for this dialog box.

OHOS::UIDialog::SetVisible (bool visible) override

void 

Sets whether a dialog box is visible.

OHOS::UIDigitalClock::UIDigitalClock ()

 

A default constructor used to create a UIDigitalClock instance.

OHOS::UIDigitalClock::~UIDigitalClock ()

virtual 

A destructor used to delete the UIDigitalClock instance.

OHOS::UIDigitalClock::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIDigitalClock::SetFontId (uint8_t fontId)

void 

Sets the dynamic font ID for this digital clock.

OHOS::UIDigitalClock::SetFont (const char name, uint8_t size)

void 

Sets the dynamic font for this digital clock.

OHOS::UIDigitalClock::SetColor (ColorType color)

void 

Sets the font color for this digital clock.

OHOS::UIDigitalClock::SetDisplayMode (DisplayMode dm)

void 

Sets the display mode for this digital clock.

OHOS::UIDigitalClock::GetDisplayMode () const

DisplayMode 

Obtains the display mode of this digital clock.

OHOS::UIDigitalClock::DisplayLeadingZero (bool displayLeadingZero)

void 

Sets whether to add 0 before the hour of this digital clock.

OHOS::UIDigitalClock::SetOpacity (uint8_t opacity)

void 

Sets the opacity for this digital clock.

OHOS::UIDigitalClock::GetOpacity () const

uint8_t 

Obtains the opacity of this digital clock.

OHOS::UIDigitalClock::UpdateClock (bool clockInit) override

void 

Updates this digital clock.

OHOS::UIImageAnimatorView::UIImageAnimatorView ()

 

A constructor used to create a UIImageAnimatorView instance.

OHOS::UIImageAnimatorView::~UIImageAnimatorView ()

virtual 

A destructor used to delete the UIImageAnimatorView instance.

OHOS::UIImageAnimatorView::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char imageSrc, uint8_t imageNum, uint16_t timeOfUpdate)

void 

Sets the images and speed for this animator.

OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char imageSrc, uint8_t imageNum)

void 

Sets the images for this animator.

OHOS::UIImageAnimatorView::SetTimeOfUpdate (uint16_t timeOfUpdate)

void 

Sets the speed for this animator.

OHOS::UIImageAnimatorView::GetTimeOfUpdate () const

uint16_t 

Obtains the speed of this animator.

OHOS::UIImageAnimatorView::SetTimeOfPause (uint16_t timeOfPause)

void 

Sets the interval between two playbacks of an infinitely repeated animator.

OHOS::UIImageAnimatorView::GetTimeOfPause () const

uint16_t 

Obtains the interval between two playbacks of an infinitely repeated animator.

OHOS::UIImageAnimatorView::GetImageAnimatorSrc () const

const ImageAnimatorInfo  

Obtains the image array of this frame animator.

OHOS::UIImageAnimatorView::GetImageAnimatorImageNum () const

uint8_t 

Obtains the number of images.

OHOS::UIImageAnimatorView::SetSizeFixed (bool fixed)

void 

Sets whether the image size is fixed to the view size.

OHOS::UIImageAnimatorView::IsSizeFixed () const

bool 

Checks whether the image size is fixed to the view size.

OHOS::UIImageAnimatorView::SetRepeat (bool repeat)

void 

Sets whether to play this animator for infinite times.

OHOS::UIImageAnimatorView::IsRepeat () const

bool 

Checks whether this animator is played for infinite times.

OHOS::UIImageAnimatorView::SetRepeatTimes (uint32_t times)

void 

Sets the playback times for this animator.

OHOS::UIImageAnimatorView::GetRepeatTimes () const

uint32_t 

Obtains the playback times.

OHOS::UIImageAnimatorView::GetState () const

uint8_t 

Obtains the current state of this animator.

OHOS::UIImageAnimatorView::SetReverse (bool reverse)

void 

Sets the playback sequence for this animator.

OHOS::UIImageAnimatorView::IsReverse () const

bool 

Obtains the playback sequence of this animator.

OHOS::UIImageAnimatorView::Start ()

void 

Starts this animator.

OHOS::UIImageAnimatorView::Stop (bool needReset=true)

void 

Stops this animator.

OHOS::UIImageAnimatorView::Pause ()

void 

Pauses this animator at the current image.

OHOS::UIImageAnimatorView::Resume ()

void 

Resumes this animator from the current image.

OHOS::UIImageAnimatorView::AnimatorStopListener::~AnimatorStopListener ()

virtual 

A destructor used to delete an AnimatorStopListener instance.

OHOS::UIImageAnimatorView::AnimatorStopListener::OnAnimatorStop (UIView &view)

virtual void 

Called when this animator stops.

OHOS::UIImageAnimatorView::SetAnimatorStopListener (AnimatorStopListener listener)

void 

Sets the listener for the stop of this animator.

OHOS::UIImageView::UIImageView ()

 

A default constructor used to create a UIImageView instance.

OHOS::UIImageView::~UIImageView ()

virtual 

A destructor used to delete the UIImageView instance.

OHOS::UIImageView::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIImageView::GetWidth () override

int16_t 

Obtains the width of this image view.

OHOS::UIImageView::GetHeight () override

int16_t 

Obtains the height of this image view.

OHOS::UIImageView::OnPreDraw (const Rect &invalidatedArea) override

bool 

Checks whether this image view needs to be covered to optimize the drawing process.

OHOS::UIImageView::OnDraw (const Rect &invalidatedArea) override

void 

Draws this image view.

OHOS::UIImageView::SetSrc (const char src)

void 

Sets the image path.

OHOS::UIImageView::SetSrc (const ImageInfo src)

void 

Sets the image information.

OHOS::UIImageView::SetAutoEnable (bool enable)

void 

Sets whether the image view size needs to be adaptive to the image size.

OHOS::UIImageView::SetBlurLevel (BlurLevel level)

void 

Sets the blur level for this image when it is rotated or scaled.

OHOS::UIImageView::GetBlurLevel () const

BlurLevel 

Obtains the blur level of this image when it is rotated or scaled.

OHOS::UIImageView::SetTransformAlgorithm (TransformAlgorithm algorithm)

void 

Sets the algorithm used for image rotation and scaling.

OHOS::UIImageView::GetTransformAlgorithm () const

TransformAlgorithm 

Obtains the algorithm used for image rotation and scaling.

OHOS::UIImageView::GetPath () const

const char  

获取图片路径

OHOS::UIImageView::GetImageInfo () const

const ImageInfo  

获取图片信息

OHOS::UIImageView::GetSrcType () const

uint8_t 

获取图片类型

OHOS::UILabel::UILabel ()

 

A constructor used to create a UILabel instance.

OHOS::UILabel::~UILabel ()

virtual 

A destructor used to delete the UILabel instance.

OHOS::UILabel::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UILabel::GetWidth () override

int16_t 

Obtains the width of this label.

OHOS::UILabel::GetHeight () override

int16_t 

Obtains the height of this label.

OHOS::UILabel::OnPreDraw (const Rect &invalidatedArea) override

bool 

Checks whether this label needs to be covered before drawing it.

OHOS::UILabel::OnDraw (const Rect &invalidatedArea) override

void 

Draws this label.

OHOS::UILabel::SetText (const char text)

void 

Sets the text content for this label.

OHOS::UILabel::GetText () const

const char  

Obtains the text of this label.

OHOS::UILabel::SetLineBreakMode (const uint8_t lineBreakMode)

void 

Sets the line break mode for this text.

OHOS::UILabel::GetLineBreakMode () const

uint8_t 

Obtains the line break mode of this text.

OHOS::UILabel::SetTextColor (ColorType color)

void 

Sets the color for this text.

OHOS::UILabel::GetTextColor () const

ColorType 

Obtains the color of this text.

OHOS::UILabel::SetAlign (UITextLanguageAlignment horizontalAlign, UITextLanguageAlignment verticalAlign=TEXT_ALIGNMENT_TOP)

void 

Sets the alignment mode for this text.

OHOS::UILabel::GetHorAlign () const

UITextLanguageAlignment 

Obtains the horizontal alignment mode.

OHOS::UILabel::GetVerAlign () const

UITextLanguageAlignment 

Obtains the vertical alignment mode.

OHOS::UILabel::SetDirect (UITextLanguageDirect direct)

void 

Sets the direction for this text.

OHOS::UILabel::GetDirect () const

UITextLanguageDirect 

Obtains the direction of this text.

OHOS::UILabel::SetFontId (uint8_t fontId)

void 

Sets the font ID for this label.

OHOS::UILabel::GetFontId () const

uint8_t 

Obtains the font ID composed of font name and size.

OHOS::UILabel::SetFont (const char name, uint8_t size)

void 

Sets the font for this label.

OHOS::UILabel::SetRollSpeed (uint16_t speed)

void 

Sets the scroll speed for this text.

OHOS::UILabel::GetTextWidth ()

uint16_t 

Obtains the width of this text.

OHOS::UILabel::GetTextHeight ()

uint16_t 

Obtains the height of this text.

OHOS::UILabel::SetRollStartPos (int16_t pos)

void 

Sets the position where this text starts to roll.

OHOS::UILabel::GetRollStartPos () const

int16_t 

Obtains the position where this text starts to roll.

OHOS::UILabel::SetWidth (int16_t width) override

void 

Sets the width for this label.

OHOS::UILabel::SetHeight (int16_t height) override

void 

Sets the height for this label.

OHOS::UILabel::SetTextRotation (LabelRotateDegree angle)

void 

Sets the clockwise rotation angle for this text.

OHOS::UILabel::GetTextRotation () const

LabelRotateDegree 

Obtains the clockwise rotation degree of this text.

OHOS::UILabel::GetTextRotateDegree () const

uint16_t 

Obtains the number of text rotation degrees.

OHOS::UILabelButton::UILabelButton ()

 

A constructor used to create a UILabelButton instance.

OHOS::UILabelButton::~UILabelButton ()

virtual 

A destructor used to delete the UILabelButton instance.

OHOS::UILabelButton::OnDraw (const Rect &invalidatedArea) override

void 

Draws a label button.

OHOS::UILabelButton::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UILabelButton::SetText (const char text)

void 

Sets the text for this label button.

OHOS::UILabelButton::GetText () const

const char  

Obtains the text of this label button.

OHOS::UILabelButton::SetLablePosition (int16_t x, int16_t y)

void 

Sets the position for this label relative to the button holding it.

OHOS::UILabelButton::GetLabelPosition () const

Point 

Obtains the position of this label relative to the button holding it.

OHOS::UILabelButton::SetAlign (UITextLanguageAlignment align)

void 

Sets the alignment mode for this text.

OHOS::UILabelButton::GetAlign () const

UITextLanguageAlignment 

Obtains the alignment mode of this text.

OHOS::UILabelButton::SetDirect (UITextLanguageDirect direct)

void 

Sets the direction for this text.

OHOS::UILabelButton::GetDirect () const

UITextLanguageDirect 

Obtains the direction of this text.

OHOS::UILabelButton::SetLabelStyle (Style &labelStyle)

void 

Sets the style for this label.

OHOS::UILabelButton::SetLabelStyle (uint8_t key, int64_t value)

void 

Sets a style for this label.

OHOS::UILabelButton::GetLabelStyle () const

const Style

Obtains the style of this label.

OHOS::UILabelButton::GetLabelStyle (uint8_t key) const

int64_t 

Obtains the value of a style of this label.

OHOS::UILabelButton::SetTextColor (ColorType color)

void 

Sets the color for this text.

OHOS::UILabelButton::SetFont (const char name, uint8_t size)

void 

Sets the font for this text.

OHOS::UILabelButton::SetFontId (uint8_t fontId)

void 

Sets the font ID.

OHOS::UILabelButton::GetFontId () const

uint8_t 

Obtains the font ID.

OHOS::ListScrollListener::ListScrollListener ()

 

A constructor used to create a ListScrollListener instance with the default state SCROLL_STATE_STOP.

OHOS::ListScrollListener::~ListScrollListener ()

virtual 

A destructor used to delete the ListScrollListener instance.

OHOS::ListScrollListener::OnScrollStart (int16_t index, UIView view)

virtual void 

Called when a scroll starts.

OHOS::ListScrollListener::OnScrollEnd (int16_t index, UIView view)

virtual void 

Called when a scroll ends.

OHOS::ListScrollListener::OnItemSelected (int16_t index, UIView view)

virtual void 

Called when a new child view is selected at the preset position as this list scrolls. For details about how to set the position, see SetSelectPosition.

OHOS::ListScrollListener::GetScrollState () const

uint8_t 

Obtains the scroll state of this list.

OHOS::UIList::UIList ()

 

A constructor used to create a UIList instance in the vertical direction.

OHOS::UIList::UIList (uint8_t direction)

 

A constructor used to create a UIList instance in the specified direction.

OHOS::UIList::~UIList ()

virtual 

A destructor used to delete the UIList instance.

OHOS::UIList::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIList::OnDragEvent (const DragEvent &event) override

bool 

Called when the view is being dragged.

OHOS::UIList::OnDragEndEvent (const DragEvent &event) override

bool 

Called when the view stops dragging.

OHOS::UIList::OnPressEvent (const PressEvent &event) override

void 

Called when the view is pressed.

OHOS::UIList::SetAdapter (AbstractAdapter adapter)

void 

Sets the adapter for this list. The content of this list is initialized when the adapter is set.

OHOS::UIList::MoveChildByOffset (int16_t x, int16_t y) override

virtual void 

Moves the position of all child views.

OHOS::UIList::ScrollTo (uint16_t index)

void 

Scrolls to change the index of the first row or column of the current view.

OHOS::UIList::ScrollBy (int16_t distance)

void 

Scrolls the content in this list.

OHOS::UIList::SetStartIndex (uint16_t index)

void 

Sets the start index for this list.

OHOS::UIList::GetStartIndex () const

uint16_t 

Obtains the start index of this list. The default value is 0.

OHOS::UIList::SetLoopState (bool state)

void 

Sets the loop state for this list, in which a loop scroll is possible since the top and bottom of the list are connected together.

OHOS::UIList::GetLoopState () const

bool 

Checks whether this list is in a loop state.

OHOS::UIList::SetSelectPosition (uint16_t position)

void 

Sets the position where a child view is selected as this list scrolls.

OHOS::UIList::GetSelectView ()

UIView  

Obtains the child view being selected at the preset position.

OHOS::UIList::SetScrollStateListener (ListScrollListener scrollListener)

void 

Sets the listener that contains a callback to be invoked when a child view is selected as this list scrolls.

OHOS::UIList::RefreshList ()

void 

Refreshes this list. The number of child views in the current view is fixed and the positions of those reserved child views as this list scrolls remain unchanged.

OHOS::UIList::EnableAutoAlign (bool state)

void 

Sets the automatic alignment state for this list. When a scroll stops, a child view is selected and its position is automatically aligned with the preset position.

OHOS::UIList::RemoveAll () override

void 

Removes all child views.

OHOS::UIPicker::UIPicker ()

 

A constructor used to create a UIPicker instance.

OHOS::UIPicker::~UIPicker ()

virtual 

A destructor used to delete the UIPicker instance.

OHOS::UIPicker::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIPicker::OnPreDraw (const Rect &invalidatedArea) override

bool 

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

OHOS::UIPicker::SetValues (const char value[], uint16_t count)

bool 

Sets dynamic text data in the picker by using a string array.

OHOS::UIPicker::SetValues (int16_t start, int16_t end)

bool 

Sets the numeric data in the picker by using a given numeric range.

OHOS::UIPicker::ClearValues ()

virtual void 

Clears all values in the picker.

OHOS::UIPicker::SetFontId (uint8_t backgroundFontId, uint8_t highlightFontId)

void 

Sets the font IDs of dynamic text, which is the string array set through SetValues.

OHOS::UIPicker::GetBackgroundFontId () const

uint16_t 

Obtains the font ID of the background text.

OHOS::UIPicker::GetHighlightFontId () const

uint16_t 

Obtains the font ID of the highlighted text.

OHOS::UIPicker::SetTextColor (ColorType backgroundColor, ColorType highlightColor)

void 

Sets the text color.

OHOS::UIPicker::GetBackgroundTextColor () const

ColorType 

Obtains the color of the background text.

OHOS::UIPicker::GetHighlightTextColor () const

ColorType 

Obtains the color of the highlighted text.

OHOS::UIPicker::SetSelected (uint16_t index)

bool 

Sets the index of the item currently selected in the picker.

OHOS::UIPicker::GetSelected () const

uint16_t 

Obtains the index of the item currently selected in the picker.

OHOS::UIPicker::SetItemHeight (int16_t height)

void 

Sets the height of each item in the picker.

OHOS::UIPicker::SetWidth (int16_t width) override

void 

Sets the width for this component.

OHOS::UIPicker::SetHeight (int16_t height) override

void 

Sets the height for this component.

OHOS::UIPicker::SetLoopState (bool state)

void 

Sets whether a picker can slide cyclically.

OHOS::UIPicker::SelectedListener::SelectedListener ()

 

A constructor used to create a SelectedListener instance.

OHOS::UIPicker::SelectedListener::~SelectedListener ()

virtual 

A destructor used to delete the SelectedListener instance.

OHOS::UIPicker::SelectedListener::OnPickerStoped (UIPicker &picker)

virtual void 

Called when an item is selected after sliding stops. This function is implemented by applications.

OHOS::UIPicker::RegisterSelectedListener (SelectedListener pickerListener)

void 

Registers a listener for a selected event.

OHOS::UIPicker::SetDirect (UITextLanguageDirect direct)

void 

Sets the text direction.

OHOS::UIPicker::SetTextFormatter (TextFormatter formatter)

void 

Sets the text formatter.

OHOS::UIRadioButton::UIRadioButton ()

 

A constructor used to create a UIRadioButton instance.

OHOS::UIRadioButton::UIRadioButton (const char name)

 

Default constructor.

OHOS::UIRadioButton::~UIRadioButton ()

virtual 

A destructor used to delete the UIRadioButton instance.

OHOS::UIRadioButton::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UIRadioButton::OnPreDraw (const Rect &invalidatedArea) override

bool 

Do something before draw, this function will be invoked mainly to check if this view need to cover invalidate area so render manager can decide which layer to draw firstly.

OHOS::UIRadioButton::OnClickEvent (const ClickEvent &event) override

void 

Executes the click event action OnClickEvent will reverse the selected state of checkbox. Example: If the check box is selected, the checkbox status is changed to Unselected after the click action is taken.

OHOS::UIRadioButton::SetName (const char name)

void 

Sets the name for this radio button.

OHOS::UIRadioButton::GetName () const

const char  

Obtains the name of this radio button.

OHOS::UIRepeatButton::UIRepeatButton ()

 

A constructor used to create a UIRepeatButton instance.

OHOS::UIRepeatButton::~UIRepeatButton ()

virtual 

A destructor used to delete the UIRepeatButton instance.

OHOS::UIRepeatButton::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UIRepeatButton::SetInterval (uint16_t interval)

virtual void 

Sets the interval between two consecutive click events.

OHOS::UIRepeatButton::GetInterval () const

virtual uint16_t 

Obtains the interval between two consecutive click events.

OHOS::UIRepeatButton::OnClickEvent (const ClickEvent &event) override

virtual void 

The action of click event.

OHOS::UIRepeatButton::OnReleaseEvent (const ReleaseEvent &event) override

virtual void 

The action of release event.

OHOS::UIRepeatButton::OnLongPressEvent (const LongPressEvent &event) override

virtual bool 

The action of long press event.

OHOS::UIRepeatButton::HandleTickEvent ()

void 

handle the event of long pressing.

OHOS::UIScrollView::OnScrollListener::OnScrollListener ()

 

A constructor used to create an OnScrollListener instance with the default scroll state SCROLL_STATE_STOP.

OHOS::UIScrollView::OnScrollListener::~OnScrollListener ()

virtual 

A destructor used to delete the OnScrollListener instance.

OHOS::UIScrollView::OnScrollListener::OnScrollStart ()

virtual void 

Called when a scroll starts.

OHOS::UIScrollView::OnScrollListener::OnScrollEnd ()

virtual void 

Called when a scroll ends.

OHOS::UIScrollView::OnScrollListener::GetScrollState () const

uint8_t 

Obtains the scroll state of this view.

OHOS::UIScrollView::UIScrollView ()

 

A constructor used to create a UIScrollView instance, with both horizontal and vertical scrolls supported.

OHOS::UIScrollView::~UIScrollView ()

virtual 

A destructor used to delete the UIScrollView instance.

OHOS::UIScrollView::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIScrollView::OnPostDraw (const Rect &invalidatedArea) override

void 

Called after a view is drawn.

OHOS::UIScrollView::OnDragEvent (const DragEvent &event) override

bool 

Called when the view is being dragged.

OHOS::UIScrollView::OnDragEndEvent (const DragEvent &event) override

bool 

Called when the view stops dragging.

OHOS::UIScrollView::OnPressEvent (const PressEvent &event) override

void 

Called when the view is pressed.

OHOS::UIScrollView::ScrollBy (int16_t xDistance, int16_t yDistance)

void 

Scrolls the content of this view.

OHOS::UIScrollView::SetScrollbarWidth (uint8_t width)

void 

Sets the width for this scroll bar.

OHOS::UIScrollView::SetHorizontalScrollState (bool state)

void 

Sets whether a horizontal scroll is enabled.

OHOS::UIScrollView::GetHorizontalScrollState () const

bool 

Checks whether a horizontal scroll is enabled.

OHOS::UIScrollView::SetVerticalScrollState (bool state)

void 

Sets whether a vertical scroll is enabled.

OHOS::UIScrollView::GetVerticalScrollState () const

bool 

Checks whether a vertical scroll is enabled.

OHOS::UIScrollView::SetXScrollBarVisible (bool state)

void 

Sets whether the horizontal scroll bar is visible.

OHOS::UIScrollView::SetYScrollBarVisible (bool state)

void 

Sets whether the vertical scroll bar is visible.

OHOS::UIScrollView::RegisterScrollListener (OnScrollListener scrollListener)

void 

Registers a listener that contains a callback to be invoked upon scroll state changes.

OHOS::UISlider::UISlider ()

 

A constructor used to create a UISlider instance.

OHOS::UISlider::~UISlider ()

virtual 

A destructor used to delete the UISlider instance.

OHOS::UISlider::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UISlider::SetKnobWidth (int16_t width)

void 

Sets the width for this knob.

OHOS::UISlider::GetKnobWidth ()

int16_t 

Obtains the knob width.

OHOS::UISlider::SetImage (const ImageInfo backgroundImage, const ImageInfo foregroundImage, const ImageInfo knobImage)

void 

Sets the images as pixel maps for this slider, including the background, foreground, and knob images.

OHOS::UISlider::SetImage (const char backgroundImage, const char foregroundImage, const char knobImage)

void 

Sets the images for this slider, including the background, foreground, and knob images.

OHOS::UISlider::SetSliderColor (const ColorType backgroundColor, const ColorType foregroundColor, const ColorType knobColor)

void 

Sets the colors for this slider, including the background, foreground, and knob colors.

OHOS::UISlider::SetSliderRadius (int16_t backgroundRadius, int16_t foregroundRadius, int16_t knobRadius)

void 

Sets the corner radiuses for this slider, including the background, foreground, and knob corner radiuses.

OHOS::UISlider::SetKnobStyle (const Style &style)

void 

Sets the knob style.

OHOS::UISlider::SetKnobStyle (uint8_t key, int64_t value)

void 

Sets a knob style.

OHOS::UISlider::GetKnobStyle () const

const Style

Obtains the knob style.

OHOS::UISlider::GetKnobStyle (uint8_t key) const

int64_t 

Obtains the value of a knob style.

OHOS::UISlider::OnClickEvent (const ClickEvent &event) override

void 

Called when the view is clicked.

OHOS::UISlider::OnDragEvent (const DragEvent &event) override

bool 

Called when the view is being dragged.

OHOS::UISlider::OnDragEndEvent (const DragEvent &event) override

bool 

Called when the view stops dragging.

OHOS::UISlider::OnPreDraw (const Rect &invalidatedArea) override

bool 

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

OHOS::UISlider::OnDraw (const Rect &invalidatedArea) override

void 

Called when a view is drawn.

OHOS::UISlider::UISliderEventListener::~UISliderEventListener ()

virtual 

A destructor used to delete the UISliderEventListener instance.

OHOS::UISlider::UISliderEventListener::OnChange (int16_t value)

virtual void 

Called when the slider is dragged or clicked. This is a virtual function, which needs your implementation.

OHOS::UISlider::UISliderEventListener::OnRelease (int16_t value)

virtual void 

Called when the slider is released. This is a virtual function, which needs your implementation.

OHOS::UISlider::SetSliderEventListener (UISliderEventListener listener)

void 

Sets the listener for a slider change.

OHOS::UISurfaceView::UISurfaceView ()

 

A constructor used to create a UISurfaceView instance.

OHOS::UISurfaceView::~UISurfaceView ()

 

A destructor used to delete the UISurfaceView instance.

OHOS::UISurfaceView::GetSurface () const

Surface  

Obtains the surface, which should be used together with the camera and video modules.

OHOS::UISurfaceView::SetPosition (int16_t x, int16_t y) override

void 

Sets the position for this view.

OHOS::UISurfaceView::SetPosition (int16_t x, int16_t y, int16_t width, int16_t height) override

void 

Sets the position and size for this view.

OHOS::UISurfaceView::Resize (int16_t width, int16_t height) override

void 

Adjusts the size of this view.

OHOS::UISurfaceView::SetX (int16_t x) override

void 

Sets the x-coordinate for this view.

OHOS::UISurfaceView::SetY (int16_t y) override

void 

Sets the y-coordinate for this view.

OHOS::UISurfaceView::SetWidth (int16_t width) override

void 

Sets the width for this view.

OHOS::UISurfaceView::SetHeight (int16_t height) override

void 

Sets the height for this view.

OHOS::UISurfaceView::SetVisible (bool visible) override

void 

Sets whether this view is visible.

OHOS::UISurfaceView::OnPreDraw (const Rect &invalidatedArea) override

bool 

Called before this view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so that the drawing process is optimized.

OHOS::UISurfaceView::OnDraw (const Rect &invalidatedArea) override

void 

Called when this view is drawn.

OHOS::UISwipeView::UISwipeView (uint8_t direction=HORIZONTAL)

 

A constructor used to create a UISwipeView instance.

OHOS::UISwipeView::~UISwipeView ()

virtual 

A destructor used to delete the UISwipeView instance.

OHOS::UISwipeView::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UISwipeView::SetDirection (uint8_t direction)

void 

Sets the dragging direction.

OHOS::UISwipeView::GetDirection () const

uint8_t 

Obtains the dragging direction.

OHOS::UISwipeView::Add (UIView view) override

void 

Adds a view.

OHOS::UISwipeView::Insert (UIView prevView, UIView insertView) override

void 

Inserts a view.

OHOS::UISwipeView::Remove (UIView view) override

virtual void 

Deletes a view.

OHOS::UISwipeView::SetCurrentPage (uint16_t index, bool needAnimator=false)

void 

Sets the index for the current tab.

OHOS::UISwipeView::GetCurrentPage () const

uint16_t 

Obtains the current tab index.

OHOS::UISwipeView::GetCurrentView () const

UIView  

Obtains the current view.

OHOS::UISwipeView::SetBlankSize (uint16_t size)

void 

Sets a blank size, as defined in DEFAULT_BLANK_SIZE.

OHOS::UISwipeView::OnDragEvent (const DragEvent &event) override

bool 

revice drag event, Switch to specified view when drag

OHOS::UISwipeView::OnDragEndEvent (const DragEvent &event) override

bool 

Called when the view stops dragging.

OHOS::UISwipeView::SetAnimatorTime (uint16_t time)

void 

Sets the time for the page being animated. The page will go beyond the blank during this time.

OHOS::UISwipeView::SetLoopState (bool loop)

void 

Sets whether the swipe view supports a cycle swipe.

OHOS::UISwipeView::GetViewByIndex (uint16_t index) const

UIView  

Obtains a view based on its index.

OHOS::UISwipeView::GetOnSwipeListener ()

OnSwipeListener

Obtains the listener set for swipe events.

OHOS::UISwipeView::SetOnSwipeListener (OnSwipeListener onSwipeListener)

void 

Sets the listener that contains a callback to be invoked upon a swipe event.

OHOS::UISwipeView::MoveChildByOffset (int16_t xOffset, int16_t yOffset) override

void 

Moves the position of all child views.

OHOS::UITextureMapper::UITextureMapper ()

 

A constructor used to create a UITextureMapper instance.

OHOS::UITextureMapper::~UITextureMapper ()

virtual 

A destructor used to delete the UITextureMapper instance.

OHOS::UITextureMapper::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UITextureMapper::Start ()

void 

Starts this animator.

OHOS::UITextureMapper::SetRotateStart (int16_t start)

void 

Sets the start angle of rotation for this image.

OHOS::UITextureMapper::SetRotateEnd (int16_t end)

void 

Sets the end angle of rotation for this image.

OHOS::UITextureMapper::SetScaleStart (float start)

void 

Sets the start ratio for scaling this image.

OHOS::UITextureMapper::SetScaleEnd (float end)

void 

Sets the end ratio for scaling this image.

OHOS::UITextureMapper::SetDurationTime (uint16_t durationTime)

void 

Sets the duration for this animator, in milliseconds.

OHOS::UITextureMapper::SetDelayTime (uint16_t delayTime)

void 

Sets the delay time for this animator, in milliseconds.

OHOS::UITextureMapper::SetEasingFunc (EasingFunc easingFunc)

void 

Sets the easing function for this animator.

OHOS::UITextureMapper::Cancel ()

void 

Cancels this animator.

OHOS::UITextureMapper::Reset ()

void 

Displays the original image.

OHOS::UITextureMapper::SetPivot (int16_t x, int16_t y)

void 

Sets the coordinates of the rotation and scaling pivots for this image.

OHOS::UITextureMapper::AnimatorStopListener::~AnimatorStopListener ()

virtual 

A destructor used to delete an AnimatorStopListener instance.

OHOS::UITextureMapper::AnimatorStopListener::OnAnimatorStop (UIView &view)=0

virtual void 

Called when this animator stops. This is a pure virtual function, which needs your inheritance and implementation.

OHOS::UITextureMapper::SetAnimatorStopListener (AnimatorStopListener listener)

void 

Sets the listener for the stop of this animator.

OHOS::UITimePicker::UITimePicker ()

 

A constructor used to create a UITimePicker instance.

OHOS::UITimePicker::~UITimePicker ()

virtual 

A destructor used to delete the UITimePicker instance.

OHOS::UITimePicker::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UITimePicker::SetSelected (const char value)

bool 

Sets the time currently selected in the time picker.

OHOS::UITimePicker::GetSelectValue ()

const char  

Obtains the time currently selected in the time picker.

OHOS::UITimePicker::GetSelectHour () const

const char  

Obtains the hour currently selected in the time picker.

OHOS::UITimePicker::GetSelectMinute () const

const char  

Obtains the minute currently selected in the time picker.

OHOS::UITimePicker::GetSelectSecond () const

const char  

Obtains the second currently selected in the time picker.

OHOS::UITimePicker::SetItemHeight (int16_t height)

void 

Sets the height of each item in the time picker.

OHOS::UITimePicker::EnableSecond (bool state)

void 

Sets whether to enable seconds in the time picker.

OHOS::UITimePicker::SetTextStyle (uint8_t backgroundFontId, uint8_t highlightFontId, ColorType backgroundColor, ColorType highlightColor)

void 

Sets the text format in the time picker, including the font ID and color.

OHOS::UITimePicker::SetWidth (int16_t width) override

void 

Sets the width for the time picker.

OHOS::UITimePicker::SetHeight (int16_t height) override

void 

Sets the height for the time picker.

OHOS::UITimePicker::SelectedListener::SelectedListener ()

 

A constructor used to create a SelectedListener instance.

OHOS::UITimePicker::SelectedListener::~SelectedListener ()

 

A destructor used to delete the SelectedListener instance.

OHOS::UITimePicker::SelectedListener::OnTimePickerStoped (UITimePicker &picker)

virtual void 

Called when an item is selected after sliding stops. This function is implemented by applications.

OHOS::UITimePicker::RegisterSelectedListener (SelectedListener timePickerListener)

void 

Registers a listener for a selected event.

OHOS::UIToggleButton::UIToggleButton ()

 

A constructor used to create a UIToggleButton instance.

OHOS::UIToggleButton::~UIToggleButton ()

virtual 

A destructor used to delete the UIToggleButton instance.

OHOS::UIToggleButton::GetViewType () const override

UIViewType 

Obtains the component type.

OHOS::UIToggleButton::SetState (bool state)

void 

Sets the state for this toggle button.

OHOS::UIToggleButton::GetState () const

bool 

Obtains the state of this toggle button.

OHOS::UIView::OnClickListener::OnClick (UIView &view, const ClickEvent &event)

virtual bool 

Called when a view is clicked.

OHOS::UIView::OnClickListener::~OnClickListener ()

virtual 

A destructor used to delete the OnClickListener instance.

OHOS::UIView::OnLongPressListener::OnLongPress (UIView &view, const LongPressEvent &event)

virtual bool 

Called when a view is long pressed.

OHOS::UIView::OnLongPressListener::~OnLongPressListener ()

virtual 

A destructor used to delete the OnLongPressListener instance.

OHOS::UIView::OnDragListener::OnDragStart (UIView &view, const DragEvent &event)

virtual bool 

Called when a view starts to drag.

OHOS::UIView::OnDragListener::OnDrag (UIView &view, const DragEvent &event)

virtual bool 

Called when a view is being dragged.

OHOS::UIView::OnDragListener::OnDragEnd (UIView &view, const DragEvent &event)

virtual bool 

Called when a view stops dragging.

OHOS::UIView::OnDragListener::~OnDragListener ()

virtual 

A destructor used to delete the OnDragListener instance.

OHOS::UIView::OnTouchListener::OnPress (UIView &view, const PressEvent &event)

virtual bool 

Called when a view is pressed.

OHOS::UIView::OnTouchListener::OnRelease (UIView &view, const ReleaseEvent &event)

virtual bool 

Called when a view is released.

OHOS::UIView::OnTouchListener::OnCancel (UIView &view, const CancelEvent &event)

virtual bool 

Called when a click event on a view is canceled.

OHOS::UIView::OnTouchListener::~OnTouchListener ()

virtual 

A destructor used to delete the OnTouchListener instance.

OHOS::UIView::UIView ()

 

A default constructor used to create an UIView instance.

OHOS::UIView::UIView (const char id)

 

A constructor used to create an UIView instance.

OHOS::UIView::~UIView ()

virtual 

A destructor used to delete the UIView instance.

OHOS::UIView::OnPreDraw (const Rect &invalidatedArea)

virtual bool 

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

OHOS::UIView::OnDraw (const Rect &invalidatedArea)

virtual void 

Called when a view is drawn.

OHOS::UIView::OnPostDraw (const Rect &invalidatedArea)

virtual void 

Called after a view is drawn.

OHOS::UIView::ReMeasure ()

virtual void 

Remeasures the view size.

OHOS::UIView::Invalidate ()

void 

Refreshes the invalidated area of the view.

OHOS::UIView::InvalidateRect (const Rect &invalidatedArea)

void 

Refreshes a view in a specified invalidated area.

OHOS::UIView::OnLongPressEvent (const LongPressEvent &event)

virtual bool 

Called when the view is long pressed.

OHOS::UIView::OnDragStartEvent (const DragEvent &event)

virtual bool 

Called when the view starts to drag.

OHOS::UIView::OnDragEvent (const DragEvent &event)

virtual bool 

Called when the view is being dragged.

OHOS::UIView::OnDragEndEvent (const DragEvent &event)

virtual bool 

Called when the view stops dragging.

OHOS::UIView::OnClickEvent (const ClickEvent &event)

virtual void 

Called when the view is clicked.

OHOS::UIView::OnPressEvent (const PressEvent &event)

virtual void 

Called when the view is pressed.

OHOS::UIView::OnReleaseEvent (const ReleaseEvent &event)

virtual void 

Called when the view is released.

OHOS::UIView::OnCancelEvent (const CancelEvent &event)

virtual void 

Called when a click event on the view is canceled.

OHOS::UIView::SetOnDragListener (OnDragListener onDragListener)

void 

Sets a drag event listener for the view.

OHOS::UIView::GetOnDragListener ()

OnDragListener

Obtains the drag event listener for the view.

OHOS::UIView::SetOnClickListener (OnClickListener onClickListener)

void 

Sets a click event listener for the view.

OHOS::UIView::GetOnClickListener ()

OnClickListener

Obtains the click event listener for the view.

OHOS::UIView::SetOnLongPressListener (OnLongPressListener onLongPressListener)

void 

Sets a long-press event listener for the view.

OHOS::UIView::GetOnLongPressListener ()

OnLongPressListener

Obtains the long-press event listener for the view.

OHOS::UIView::SetOnTouchListener (OnTouchListener onTouchListener)

void 

Sets a touch event listener for the view.

OHOS::UIView::GetTouchListener ()

OnTouchListener

Obtains the touch event listener for the view.

OHOS::UIView::GetTargetView (const Point &point, UIView last)

virtual void 

Obtains the top-level view based on specified coordinates.

OHOS::UIView::SetParent (UIView parent)

void 

Sets the parent view for the view.

OHOS::UIView::GetParent () const

UIView  

Obtains the parent view of the view.

OHOS::UIView::SetNextSibling (UIView sibling)

void 

Sets the next sibling view for the view.

OHOS::UIView::GetNextSibling () const

UIView  

Obtains the next sibling view of the view.

OHOS::UIView::SetVisible (bool visible)

virtual void 

Sets whether the view is visible.

OHOS::UIView::IsVisible () const

bool 

Checks whether the view is visible.

OHOS::UIView::SetTouchable (bool touch)

void 

Sets whether the view is touchable.

OHOS::UIView::IsTouchable () const

bool 

Checks whether the view is touchable.

OHOS::UIView::SetDraggable (bool draggable)

void 

Sets whether the view is draggable.

OHOS::UIView::IsDraggable () const

bool 

Checks whether the view is draggable.

OHOS::UIView::SetDragParentInstead (bool dragParentInstead)

void 

Sets whether to transfer the drag event to the parent view for processing when the view is being dragged.

OHOS::UIView::IsDragParentInstead () const

bool 

Obtains whether the view transfers a drag event to the parent view for processing.

OHOS::UIView::GetRect () const

Rect 

Obtains the absolute rectangle area of the view. When the view has deformation such as rotation, the rectangle area is the intersection set of the absolute rectangle area and deformation matrix.

OHOS::UIView::GetVisibleRect () const

Rect 

Obtains the visible absolute rectangle area of the view.

OHOS::UIView::GetMaskedRect () const

Rect 

Obtains the valid absolute rectangle area of the view. The valid area refers to the area where the view can be displayed. Generally, the valid area is the same as the visible view area, but they may be different in the grid layout.

OHOS::UIView::GetOrigRect () const

Rect 

Obtains the absolute rectangle area of the view.

OHOS::UIView::GetContentRect ()

virtual Rect 

Obtains the content of the absolute rectangle area of the view. This area excludes padding.

OHOS::UIView::GetRelativeRect () const

Rect 

Obtains the rectangular area of the view relative to the parent view, that is, the rectangular area relative to the coordinates of the parent view.

OHOS::UIView::ResizeVisibleArea (int16_t x, int16_t y, int16_t width, int16_t height)

void 

Adjusts the size of the visible area. This operation may affect the final display size.

OHOS::UIView::SetWidth (int16_t width)

virtual void 

Sets the width for the view.

OHOS::UIView::GetWidth ()

virtual int16_t 

Obtains the width for the view.

OHOS::UIView::SetHeight (int16_t height)

virtual void 

Sets the height for the view.

OHOS::UIView::GetHeight ()

virtual int16_t 

Obtains the height for the view.

OHOS::UIView::Resize (int16_t width, int16_t height)

virtual void 

Adjusts the size of the view.

OHOS::UIView::SetX (int16_t x)

virtual void 

Sets the x-coordinate for the view.

OHOS::UIView::GetX () const

int16_t 

Obtains the x-coordinate for the view.

OHOS::UIView::SetY (int16_t y)

virtual void 

Sets the y-coordinate for the view.

OHOS::UIView::GetY () const

int16_t 

Obtains the y-coordinate for the view.

OHOS::UIView::SetPosition (int16_t x, int16_t y)

virtual void 

Sets the position for the view.

OHOS::UIView::SetPosition (int16_t x, int16_t y, int16_t width, int16_t height)

virtual void 

Adjusts the position and size of the view.

OHOS::UIView::IsViewGroup () const

bool 

Checks whether the view is a container view.

OHOS::UIView::SetIntercept (bool isIntercept)

void 

Sets whether to intercept the drag event. If intercepted, the view does not transfer the drag event to the parent view after local processing.

OHOS::UIView::SetTransformMap (const TransformMap &transMap)

void 

Sets the affine transformation matrix.

OHOS::UIView::GetTransformMap ()

TransformMap

Obtains an affine transformation matrix.

OHOS::UIView::GetChildById (const char id) const

virtual UIView  

Obtains the child view of a specified ID.

OHOS::UIView::SetViewId (const char id)

void 

Sets the view ID.

OHOS::UIView::GetViewId () const

const char  

Obtains the view ID.

OHOS::UIView::SetViewIndex (int16_t index)

void 

Sets the view index.

OHOS::UIView::GetViewIndex () const

int16_t 

Obtains the view index.

OHOS::UIView::GetViewType () const

virtual UIViewType 

Obtains the view type.

OHOS::UIView::LayoutChildren (bool neeInvalidate=false)

virtual void 

Lays out all child views according to the preset arrangement mode.

OHOS::UIView::LayoutCenterOfParent (int16_t xOffSet=0, int16_t yOffset=0)

void 

Lays out the view in the center of the parent view.

OHOS::UIView::LayoutLeftOfParent (int16_t offset=0)

void 

Lays out the view on the left of the parent view.

OHOS::UIView::LayoutRightOfParent (int16_t offset=0)

void 

Lays out the view on the right of the parent view.

OHOS::UIView::LayoutTopOfParent (int16_t offset=0)

void 

Lays out the view on the top of the parent view.

OHOS::UIView::LayoutBottomOfParent (int16_t offset=0)

void 

Lays out the view on the bottom of the parent view.

OHOS::UIView::AlignLeftToSibling (const char id, int16_t offset=0)

void 

Aligns the view with the left of a sibling view.

OHOS::UIView::AlignRightToSibling (const char id, int16_t offset=0)

void 

Aligns the view with the right of a sibling view.

OHOS::UIView::AlignTopToSibling (const char id, int16_t offset=0)

void 

Aligns the view with the top of a sibling view.

OHOS::UIView::AlignBottomToSibling (const char id, int16_t offset=0)

void 

Aligns the view with the bottom of a sibling view.

OHOS::UIView::AlignHorCenterToSibling (const char id, int16_t offset=0)

void 

Aligns the view with the center of a sibling view in the x-axis.

OHOS::UIView::AlignVerCenterToSibling (const char id, int16_t offset=0)

void 

Aligns the view with the center of a sibling view in the y-axis.

OHOS::UIView::LayoutLeftToSibling (const char id, int16_t offset=0)

void 

Lays out the view on the left of a sibling view.

OHOS::UIView::LayoutRightToSibling (const char id, int16_t offset=0)

void 

Lays out the view on the right of a sibling view.

OHOS::UIView::LayoutTopToSibling (const char id, int16_t offset=0)

void 

Lays out the view on the above of a sibling view.

OHOS::UIView::LayoutBottomToSibling (const char id, int16_t offset=0)

void 

Lays out the view on the below of a sibling view.

OHOS::UIView::SetStyle (Style &style)

virtual void 

Sets the view style.

OHOS::UIView::SetStyle (uint8_t key, int64_t value)

virtual void 

Sets a style.

OHOS::UIView::GetStyle (uint8_t key) const

virtual int64_t 

Obtains the value of a style.

OHOS::UIView::GetStyleConst () const

const Style

Obtains the view style. This function applies to scenarios where the style does not need to be modified, which saves memory.

OHOS::UIViewGroup::UIViewGroup ()

 

A default constructor used to create a UIViewGroup instance.

OHOS::UIViewGroup::~UIViewGroup ()

virtual 

A destructor used to delete the UIViewGroup instance.

OHOS::UIViewGroup::GetViewType () const override

UIViewType 

Obtains the view type.

OHOS::UIViewGroup::Add (UIView view)

virtual void 

Adds a child view.

OHOS::UIViewGroup::Insert (UIView prevView, UIView insertView)

virtual void 

Inserts a new child view behind the current one.

OHOS::UIViewGroup::Remove (UIView view)

virtual void 

Removes a child view.

OHOS::UIViewGroup::RemoveAll ()

virtual void 

Removes all child views.

OHOS::UIViewGroup::GetTargetView (const Point &point, UIView last) override

virtual void 

Obtains the target child view that is visible and can respond to touch events based on given coordinates.

OHOS::UIViewGroup::MoveChildByOffset (int16_t x, int16_t y)

virtual void 

Moves all child views.

OHOS::UIViewGroup::GetChildrenHead () const

UIView  

Obtains the first child view in this view group.

OHOS::UIViewGroup::GetChildrenTail () const

UIView  

Obtains the last child view in this view group.

OHOS::UIViewGroup::SetDisallowIntercept (bool flag)

void 

Sets whether this view group is intercepted upon touch events.

OHOS::UIViewGroup::GetChildById (const char id) const override

UIView  

Obtains the target child view with a specified ID.

OHOS::UIViewGroup::SetAutoSize (bool state)

void 

Sets whether the size of this view group is adaptive to that of all child views.

OHOS::UIViewGroup::GetAllChildRelativeRect () const

Rect 

Obtains the rectangle area of a new view group after being adaptive to the size of all child views.

OHOS::UIViewGroup::OnChildChanged ()

virtual void 

Performs operations needed after a child view is added or removed.

OHOS::UIDumpDomTree::GetInstance ()

static UIDumpDomTree  

Obtains an instance in singleton pattern.

OHOS::UIDumpDomTree::DumpDomTree (const char id, const char path)

bool 

Exports information about a DOM tree starting from a specified DOM node and saves the information to a specified path.

OHOS::UIDumpDomTree::DumpDomTree (const char id)

bool 

Exports information about a DOM tree starting from a specified DOM node and saves the information to the default path. The default path is DEFAULT_DUMP_DOM_TREE_PATH.

OHOS::UIDumpDomTree::DumpDomNode (const char id)

char  

Exports information about a specified DOM node.

OHOS::CancelEvent::CancelEvent (const Point &pos)

 

A constructor used to create a CancelEvent instance.

OHOS::CancelEvent::~CancelEvent ()

virtual 

A destructor used to delete the CancelEvent instance.

OHOS::ClickEvent::ClickEvent (const Point &pos)

 

A constructor used to create a ClickEvent instance.

OHOS::ClickEvent::~ClickEvent ()

virtual 

A destructor used to delete the ClickEvent instance.

OHOS::DragEvent::DragEvent (const Point &newPos, const Point &lastPos, const Point &totalLen)

 

A constructor used to create a DragEvent instance.

OHOS::DragEvent::~DragEvent ()

virtual 

A destructor used to delete the DragEvent instance.

OHOS::DragEvent::GetLastPoint () const

const Point

Obtains the coordinates of the last position in the drag event.

OHOS::DragEvent::GetStartPoint () const

const Point

Obtains the start coordinates in the drag event.

OHOS::DragEvent::SetPreLastPoint (const Point &preLastPos)

void 

Sets the coordinates of the stay position before the last position in the drag event.

OHOS::DragEvent::GetPreLastPoint () const

const Point

Obtains the coordinates of the stay position before the last position in the drag event.

OHOS::DragEvent::GetDragDirection () const

uint8_t 

Obtains the direction in the drag event.

OHOS::DragEvent::GetDeltaX () const

int16_t 

Obtains the difference between the current position and the last position of the view in the x-axis.

OHOS::DragEvent::GetDeltaY () const

int16_t 

Obtains the difference between the current position and the last position of the view in the y-axis.

OHOS::Event::Event ()

 

A default constructor used to create an Event instance.

OHOS::Event::Event (const Point &curPos)

 

A constructor used to create an Event instance.

OHOS::Event::~Event ()

virtual 

A destructor used to delete the Event instance.

OHOS::Event::GetCurrentPos () const

const Point

Obtains the position where an event occurs.

OHOS::Event::GetTimeStamp () const

const TimeType & 

Obtains the timestamp when an event occurs.

OHOS::Event::SetTimeStamp (const TimeType &timeStamp)

void 

Sets the timestamp when an event occurs.

OHOS::KeyEvent::KeyEvent (uint16_t keyId, uint16_t state)

 

A constructor used to create a KeyEvent instance.

OHOS::KeyEvent::~KeyEvent ()

 

A destructor used to delete the KeyEvent instance.

OHOS::KeyEvent::GetKeyId () const

uint16_t 

Obtains the key ID.

OHOS::KeyEvent::GetState () const

uint16_t 

Obtains the key state.

OHOS::LongPressEvent::LongPressEvent (const Point &pos, const TimeType &timeStamp)

 

A constructor used to create a LongPressEvent instance.

OHOS::LongPressEvent::~LongPressEvent ()

virtual 

A destructor used to delete the LongPressEvent instance.

OHOS::PressEvent::PressEvent (const Point &pos)

 

A constructor used to create a PressEvent instance.

OHOS::PressEvent::~PressEvent ()

virtual 

A destructor used to delete the PressEvent instance.

OHOS::ReleaseEvent::ReleaseEvent (const Point &pos)

 

A constructor used to create a ReleaseEvent instance.

OHOS::ReleaseEvent::~ReleaseEvent ()

virtual 

A destructor used to delete the ReleaseEvent instance.

OHOS::VirtualDeviceEvent::VirtualDeviceEvent (uint16_t type, uint16_t value)

 

A constructor used to create a VirtualDeviceEvent instance.

OHOS::VirtualDeviceEvent::~VirtualDeviceEvent ()

 

A destructor used to delete the VirtualDeviceEvent instance.

OHOS::VirtualDeviceEvent::GetType () const

uint16_t 

Obtains the type of the virtual device.

OHOS::VirtualDeviceEvent::GetState () const

uint16_t 

Obtains the state of the virtual event.

OHOS::Line::Line ()

 

The default constructor used to create a Line instance.

OHOS::Line::Line (const Vector2< int16_t > &a, const Vector2< int16_t > &b)

 

A constructor used to create a Line instance.

OHOS::Line::Line (int16_t x1, int16_t y1, int16_t x2, int16_t y2)

 

A constructor used to create a Line instance.

OHOS::Line::~Line ()

 

A destructor used to delete the Line instance.

OHOS::Line::operator[] (uint8_t index)

Vector2< int16_t > & 

Obtains the start or end point of the line based on the value of index.

OHOS::Line::operator[] (uint8_t index) const

const Vector2< int16_t > 

Obtains the start or end point of the line based on the value of index.

OHOS::Polygon::Polygon ()

 

The default constructor used to create a Polygon instance.

OHOS::Polygon::Polygon (const Rect &rect)

 

A constructor used to construct a Polygon instance based on a rectangle.

OHOS::Polygon::Polygon (const Vector2< int16_t > vertexes, const uint8_t vertexNum)

 

A constructor used to create a Polygon instance based on the vertex coordinates and the number of coordinates.

OHOS::Polygon::~Polygon ()

 

A destructor used to delete the Polygon instance.

OHOS::Polygon::MakeAABB () const

Rect 

Obtains the minimum rectangle that can contain the polygon. All vertices of the polygon are inside this rectangle.

OHOS::Polygon::GetVertexNum () const

uint8_t 

Obtains the number of vertices of the polygon.

OHOS::Polygon::SetVertexNum (uint8_t vertexNum)

void 

Sets the number of vertices of a polygon.

OHOS::Intersect (const Line &a, const Line &b, Vector2< int16_t > &out)

bool 

Checks whether line segment a and line segment b intersect, and returns the intersection point (if available).

OHOS::IsIntersect (const Line &a, const Line &b)

bool 

Chekcs whether line segment a and line segment b intersect.

OHOS::Clip (Polygon &poly, const Line &line)

void 

Clips a polygon by using a line segment.

OHOS::SuthHodgClip (const Rect &clipRect, const Polygon &polygon)

Polygon 

Implements Sutherland-Hodgman, an algorithm used for clipping polygons.

OHOS::Clip (const Line &line, const Polygon &poly, Vector2< int16_t > pOut, uint8_t pNum)

void 

Clips a polygon by using a line segment and obtains the intersections.

OHOS::Vector2< T >::Vector2 ()

 

A constructor used to create a Vector2 instance.

OHOS::Vector2< T >::Vector2 (T x, T y)

 

A constructor used to create a Vector2 instance based on the X and Y coordinates.

OHOS::Vector2< T >::~Vector2 ()

 

A destructor used to delete the Vector2 instance.

OHOS::Vector2< T >::Dot (const Vector2< T > &other) const

Calculates the scalar product of the two-dimensional vector and another two-dimensional vector.

OHOS::Vector2< T >::Cross (const Vector2< T > &other) const

Calculates the cross product of the two-dimensional vector and another two-dimensional vector.

OHOS::Vector3< T >::Vector3 ()

 

A constructor used to create a Vector3 instance.

OHOS::Vector3< T >::Vector3 (T x, T y, T z)

 

Defines a Vector3 instance and initializes the values of x, y, and z.

OHOS::Vector3< T >::~Vector3 ()

 

A destructor used to delete the Vector3 instance.

OHOS::Matrix3< T >::Matrix3 ()

 

Defines a Matrix3 instance and initializes the 3 x 3 matrix data.

OHOS::Matrix3< T >::Matrix3 (T m00, T m01, T m02, T m10, T m11, T m12, T m20, T m21, T m22)

 

Defines a Matrix3 instance and initializes the 3 x 3 matrix data.

OHOS::Matrix3< T >::~Matrix3 ()

 

A destructor used to delete the Matrix3 instance.

OHOS::Matrix3< T >::GetData () const

const T  

Obtains the 3 x 3 matrix data.

OHOS::Matrix3< T >::Determinant () const

Obtains the determinant of the matrix.

OHOS::Matrix3< T >::Inverse () const

Matrix3 

Obtains the inverse matrix.

OHOS::Matrix3< T >::Rotate (T angle, const Vector2< T > &pivot)

static Matrix3 

Obtains a rotation matrix. After a matrix is rotated, its data is shifted leftwards by 15 bits. Therefore, the result data needs to be shifted rightwards by 15 bits.

OHOS::Matrix3< T >::Scale (const Vector2< T > &scale, const Vector2< T > &fixed)

static Matrix3 

Obtains the scaling matrix. After a matrix is scaled, its data is shifted leftwards by 8 bits. Therefore, the result data needs to be shifted rightwards by 8 bits.

OHOS::Matrix3< T >::Translate (const Vector2< T > &trans)

static Matrix3< T > 

Obtains a matrix translation.

OHOS::HeapBase::operator new (size_t size)

void  

Overrides the new function.

OHOS::HeapBase::operator delete (void p)

void 

Overrides the delete function.

OHOS::FlexLayout::FlexLayout ()

 

A default constructor used to create a FlexLayout instance.

OHOS::FlexLayout::~FlexLayout ()

virtual 

A destructor used to delete the FlexLayout instance.

OHOS::FlexLayout::SetMajorAxisAlign (const AlignType &align)

void 

Sets the alignment mode of the primary axis (the axis where the layout direction is located). The child views in the layout are placed in this mode in the direction of the primary axis.

OHOS::FlexLayout::SetSecondaryAxisAlign (const AlignType &align)

void 

Sets the alignment mode of the secondary axis (the axis perpendicular to the set layout direction).

OHOS::FlexLayout::SetFlexWrap (uint8_t wrap)

void 

Sets whether to support word wrap.

OHOS::FlexLayout::LayoutChildren (bool needInvalidate=false) override

virtual void 

Lays out all child views according to the preset arrangement mode.

OHOS::GridLayout::GridLayout ()

 

A default constructor used to create a GridLayout instance.

OHOS::GridLayout::~GridLayout ()

virtual 

A destructor used to delete the GridLayout instance.

OHOS::GridLayout::SetRows (const uint16_t &rows)

void 

Sets the number of rows in a grid.

OHOS::GridLayout::SetCols (const uint16_t &cols)

void 

Sets the number of columns in a grid.

OHOS::GridLayout::LayoutChildren (bool needInvalidate=false) override

virtual void 

Lays out all child views according to the preset arrangement mode.

OHOS::Layout::Layout ()

 

A default constructor used to create a Layout instance.

OHOS::Layout::~Layout ()

virtual 

A destructor used to delete the Layout instance.

OHOS::Layout::SetLayoutDirection (const DirectionType &direction)

void 

Sets the layout direction.

OHOS::List< T >::List ()

 

A default constructor used to create a List instance. The initial size is 0.

OHOS::List< T >::~List ()

virtual 

A destructor used to delete the List instance.

OHOS::List< T >::Front () const

const T 

Obtains the head node data of a linked list.

OHOS::List< T >::Back () const

const T 

Obtains the tail node data of a linked list.

OHOS::List< T >::PushBack (T data)

void 

Inserts data at the end of a linked list.

OHOS::List< T >::PushFront (T data)

void 

Inserts data at the start of a linked list.

OHOS::List< T >::PopBack ()

void 

Pops up a data record at the end of a linked list.

OHOS::List< T >::PopFront ()

void 

Pops up a data record at the start of a linked list.

OHOS::List< T >::Insert (ListNode< T > node, T data)

void 

Inserts data before a specified node, which follows the inserted data node.

OHOS::List< T >::Remove (ListNode< T > node)

void 

Deletes a data node.

OHOS::List< T >::Clear ()

void 

Deletes all nodes from a linked list.

OHOS::List< T >::Head () const

ListNode< T >  

Obtains the head node address of a linked list.

OHOS::List< T >::Tail () const

ListNode< T >  

Obtains the tail node address of a linked list.

OHOS::List< T >::Begin () const

ListNode< T >  

Obtains the head node address of a linked list.

OHOS::List< T >::End () const

const ListNode< T >  

Obtains the end node address of a linked list.

OHOS::List< T >::Next (const ListNode< T > node) const

ListNode< T >  

Obtains the address of the node following the specified node.

OHOS::List< T >::IsEmpty () const

bool 

Checks whether a linked list is empty.

OHOS::List< T >::Size () const

uint16_t 

Obtains the size of a linked list.

OHOS::ImageCacheMalloc (ImageInfo &info)

void  

Applies for the image cache memory. You can customize the memory area when loading image resources.

OHOS::ImageCacheFree (ImageInfo &info)

void 

Releases the image cache memory.

OHOS::UIMalloc (uint32_t size)

void  

Applies for memory for the graphics module. You can implement this function to override the malloc and new functions.

OHOS::UIFree (void buffer)

void 

Releases memory for the graphics module. You can implement this function to override the free and delete functions.

OHOS::Rect::Rect ()

 

A constructor used to create a Rect instance.

OHOS::Rect::~Rect ()

 

A destructor used to delete the Rect instance.

OHOS::Rect::Rect (int16_t left, int16_t top, int16_t right, int16_t bottom)

 

A constructor used to create a Rect instance based on the coordinates of the four boundaries.

OHOS::Rect::Rect (const Rect &other)

 

A constructor used to create a Rect instance by copying another rectangle.

OHOS::Rect::Rect (const Rect &&other)

 

A constructor used to create a Rect instance by copying another rectangle.

OHOS::Rect::SetRect (int16_t left, int16_t top, int16_t right, int16_t bottom)

void 

Sets the coordinates of the four boundaries of a rectangle.

OHOS::Rect::GetWidth () const

int16_t 

Obtains the rectangle width.

OHOS::Rect::GetHeight () const

int16_t 

Obtains the rectangle height.

OHOS::Rect::GetX () const

int16_t 

Obtains the left boundary coordinate of the rectangle.

OHOS::Rect::GetY () const

int16_t 

Obtains the top boundary coordinate of the rectangle.

OHOS::Rect::GetLeft () const

int16_t 

Obtains the left boundary coordinate of the rectangle.

OHOS::Rect::GetTop () const

int16_t 

Obtains the top boundary coordinate of the rectangle.

OHOS::Rect::GetRight () const

int16_t 

Obtains the right boundary coordinate of the rectangle.

OHOS::Rect::GetBottom () const

int16_t 

Obtains the bottom boundary coordinate of the rectangle.

OHOS::Rect::SetX (int16_t x)

void 

Changes the left boundary coordinate of the rectangle without changing the rectangle width.

OHOS::Rect::SetY (int16_t y)

void 

Changes the top boundary coordinate of the rectangle without changing the rectangle height.

OHOS::Rect::SetPosition (int16_t x, int16_t y)

void 

Changes the coordinates of the left and top boundaries of the rectangle without changing the rectangle width and height.

OHOS::Rect::SetWidth (int16_t width)

void 

Changes the width of the rectangle without changing the coordinate of the left boundary.

OHOS::Rect::SetHeight (int16_t height)

void 

Changes the height of the rectangle without changing the coordinate of the top boundary.

OHOS::Rect::SetLeft (int16_t left)

void 

Sets the coordinate of the left boundary of a rectangle.

OHOS::Rect::SetTop (int16_t top)

void 

Sets the coordinate of the top boundary of a rectangle.

OHOS::Rect::SetRight (int16_t right)

void 

Sets the coordinate of the right boundary of a rectangle.

OHOS::Rect::SetBottom (int16_t bottom)

void 

Sets the coordinate of the bottom boundary of a rectangle.

OHOS::Rect::Resize (int16_t width, int16_t height)

void 

Sets the width and height of a rectangle.

OHOS::Rect::GetSize () const

uint32_t 

Obtains the area of a rectangle.

OHOS::Rect::Intersect (const Rect &rect1, const Rect &rect2)

bool 

Checks whether two rectangles intersect.

OHOS::Rect::Join (const Rect &rect1, const Rect &rect2)

void 

Obtains the minimum rectangle that contains another two rectangles.

OHOS::Rect::IsContains (const Vector2< int16_t > &point) const

bool 

Checks whether the rectangle contains a coordinate point.

OHOS::Rect::IsContains (const Point &point) const

bool 

Checks whether the rectangle contains a coordinate point.

OHOS::Rect::IsExtends (const Rect &other) const

bool 

Checks whether the rectangle is adjacent to another rectangle horizontally or vertically.

OHOS::Rect::IsIntersect (const Rect &other) const

bool 

Checks whether the rectangle intersects with another rectangle.

OHOS::Rect::IsContains (const Rect &other) const

bool 

Checks whether the rectangle contains another rectangle.

OHOS::Style::Style ()

 

A constructor used to create a Style instance.

OHOS::Style::~Style ()

virtual 

A destructor used to delete the Style instance.

OHOS::Style::SetStyle (uint8_t key, int64_t value)

void 

Sets a style.

OHOS::Style::GetStyle (uint8_t key) const

int64_t 

Obtains the value of a style.

OHOS::StyleDefault::StyleDefault ()

 

A constructor used to create a StyleDefault instance.

OHOS::StyleDefault::~StyleDefault ()

 

A destructor used to delete the StyleDefault instance.

OHOS::StyleDefault::GetDefaultStyle ()

static Style

Obtains the default style.

OHOS::StyleDefault::GetBrightStyle ()

static Style

Obtains the bright style.

OHOS::StyleDefault::GetBrightColorStyle ()

static Style

Obtains the bright color style.

OHOS::StyleDefault::GetButtonPressedStyle ()

static Style

Obtains the button pressed style.

OHOS::StyleDefault::GetButtonReleasedStyle ()

static Style

Obtains the button released style.

OHOS::StyleDefault::GetButtonInactivedStyle ()

static Style

Obtains the button inactived style.

OHOS::StyleDefault::GetLabelStyle ()

static Style

Obtains the label style.

OHOS::StyleDefault::GetBackgroundTransparentStyle ()

static Style

Obtains the background transparent style.

OHOS::StyleDefault::GetProgressBackgroundStyle ()

static Style

Obtains the progress background style.

OHOS::StyleDefault::GetProgressForegroundStyle ()

static Style

Obtains the progress foreground style.

OHOS::StyleDefault::GetSliderKnobStyle ()

static Style

Obtains the slider knob style.

OHOS::StyleDefault::GetPickerBackgroundStyle ()

static Style

Obtains the picker background style.

OHOS::StyleDefault::GetPickerHighlightStyle ()

static Style

Obtains the picker highlight style.

OHOS::SysInfo::OnFPSChangedListener::OnFPSChangedListener ()

 

A constructor used to create an OnFPSChangedListener instance with the default sampling type FPS_CT_FIXED_TIME.

OHOS::SysInfo::OnFPSChangedListener::~OnFPSChangedListener ()

virtual 

A destructor used to delete the OnFPSChangedListener instance.

OHOS::SysInfo::OnFPSChangedListener::OnFPSChanged (float newFPS)=0

virtual void 

Called when the FPS data changes.

OHOS::SysInfo::OnFPSChangedListener::GetFPSCalculateType () const

FPSCalculateType 

Obtains the FPS sampling type.

OHOS::SysInfo::OnFPSChangedListener::SetFPSCalculateType (FPSCalculateType type)

void 

Sets the FPS sampling type.

OHOS::SysInfo::GetFPS ()

static float 

Obtains the FPS data.

OHOS::SysInfo::RegisterFPSChangedListener (OnFPSChangedListener onFPSChangedListener)

static void 

Registers the listener for notifying the FPS changes.

OHOS::Theme::Theme ()

 

A constructor used to create a Theme instance.

OHOS::Theme::~Theme ()

virtual 

A destructor used to delete the Theme instance.

OHOS::Theme::GetMainStyle ()

Style

Obtains the basic style.

OHOS::Theme::GetButtonStyle ()

ButtonStyle

Obtains the style of this button.

OHOS::Theme::GetLabelStyle ()

Style

Obtains the style of this label.

OHOS::Theme::GetPickerBackgroundStyle ()

Style

Obtains the background style of this picker.

OHOS::Theme::GetPickerHighlightStyle ()

Style

Obtains the highlight style of this picker.

OHOS::Theme::GetProgressBackgroundStyle ()

Style

Obtains the background style of this progress bar.

OHOS::Theme::GetProgressForegroundStyle ()

Style

Obtains the foreground style of this progress bar.

OHOS::Theme::GetSliderKnobStyle ()

Style

Obtains the style of this slider knob.

OHOS::ThemeManager::GetInstance ()

static ThemeManager

Obtains the singleton instance of the ThemeManager class.

OHOS::ThemeManager::SetCurrent (Theme theme)

void 

Sets the current screen theme for this application.

OHOS::ThemeManager::GetCurrent ()

Theme  

Obtains the current screen theme of this application.

OHOS::TransformMap::TransformMap ()

 

The default constructor used to create a TransformMap instance.

OHOS::TransformMap::TransformMap (const Rect &rect)

 

A constructor used to create a TransformMap instance.

OHOS::TransformMap::~TransformMap ()

 

A destructor used to delete the TransformMap instance.

OHOS::TransformMap::GetClockWise () const

bool 

Checks whether the vertex coordinates of a polygon are clockwise.

OHOS::TransformMap::SetPolygon (const Polygon &polygon)

void 

Sets a polygon after rectangle transformation.

OHOS::TransformMap::GetPolygon () const

Polygon 

Obtains the polygon after rectangle transformation.

OHOS::TransformMap::GetPivot () const

Point 

Obtains the pivot for the rotation or scaling operation.

OHOS::TransformMap::IsInvalid () const

bool 

Checks whether the TransformMap instance is invalid. When the vertices are all 0, the TransformMap is invalid.

OHOS::TransformMap::GetBoxRect () const

Rect 

Obtains the minimum rectangle that can contain a polygon. All vertices of the polygon are inside this rectangle.

OHOS::TransformMap::Rotate (int16_t angle, const Vector2< int16_t > &pivot)

void 

Rotates the rectangle.

OHOS::TransformMap::Scale (const Vector2< float > scale, const Vector2< int16_t > &pivot)

void 

Scales the rectangle.

OHOS::Rotate (const Vector2< int16_t > &point, int16_t angle, const Vector2< int16_t > &pivot, Vector2< int16_t > &out)

void 

Rotates a point around the pivot by a certain angle.

OHOS::Rotate (const Line &origLine, int16_t angle, const Vector2< int16_t > &pivot, Line &out)

void 

Rotates a line around the pivot by a certain angle.

OHOS::Rotate (const Rect &origRect, int16_t angle, const Vector2< int16_t > &pivot, Polygon &out)

void 

Rotates a rectangle around the pivot by a certain angle.

OHOS::GetVersion ()

std::string 

Obtains the version number of the graphics module.

OHOS::GetLibDsc ()

std::string 

Obtains the library description of the graphics module.

Details

Macro Definition Documentation

VERSION_STANDARD

  1. #define VERSION_STANDARD

Description:

Defines three graphics library versions: lightweight, standard, and extended versions. The three versions have different requirements on the memory and hardware. The standard version is enabled by default.

The macros of the versions are defined as follows:

Typedef Documentation

EasingFunc

  1. typedef int16_t(* OHOS::EasingFunc) (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime)

Description:

Calculates the value for the current time of an animation.

Returns the value for the current time.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Enumeration Type Documentation

anonymous enum

  1. anonymous enum : uint8_t

Description:

Enumerates the states of this animator.

Enumerator

Description

STOP 

Stop

START 

Start

PAUSE 

Pause

RUNNING 

Running (reserved and not used currently)

anonymous enum

  1. anonymous enum : uint8_t

Description:

Enumerates keys of styles.

Enumerator

Description

STYLE_BACKGROUND_COLOR 

Background color

STYLE_BACKGROUND_OPA 

Background opacity

STYLE_BORDER_RADIUS 

Border radius

STYLE_BORDER_COLOR 

Border color

STYLE_BORDER_OPA 

Border opacity

STYLE_BORDER_WIDTH 

Border width

STYLE_PADDING_LEFT 

Left padding

STYLE_PADDING_RIGHT 

Right padding

STYLE_PADDING_TOP 

Top padding

STYLE_PADDING_BOTTOM 

Bottom padding

STYLE_MARGIN_LEFT 

Left margin

STYLE_MARGIN_RIGHT 

Right margin

STYLE_MARGIN_TOP 

Top margin

STYLE_MARGIN_BOTTOM 

Bottom margin

STYLE_IMAGE_OPA 

Image opacity

STYLE_TEXT_COLOR 

Text color

STYLE_TEXT_FONT 

Text font

STYLE_LETTER_SPACE 

Letter spacing

STYLE_LINE_SPACE 

Line spacing

STYLE_TEXT_OPA 

Text opacity

STYLE_LINE_COLOR 

Line color

STYLE_LINE_WIDTH 

Line width

STYLE_LINE_OPA 

Line opacity

STYLE_LINE_CAP 

Line cap style

anonymous enum

  1. anonymous enum

Description:

Enumerates opacity values.

Enumerator

Description

OPA_TRANSPARENT 

The opacity is 0.

OPA_OPAQUE 

The opacity is 100%.

ButtonImageSrc

  1. enum [OHOS::UIButton::ButtonImageSrc]($api-api-SmartVision-Devices-Graphic.md#gaf9f6c0c373f090e79b9e8d847e186e92) : uint8_t

Description:

Enumerates the images for different button states.

You can define a different image for each button state.

ButtonState

  1. enum [OHOS::UIButton::ButtonState]($api-api-SmartVision-Devices-Graphic.md#ga188dd55c17ee44be27fa80543f13f729) : uint8_t

Description:

Enumerates the states of this button.

The button has three states.

CapType

  1. enum [OHOS::CapType]($api-api-SmartVision-Devices-Graphic.md#ga2db3928cdf793f4950245a6841dd43d6) : uint8_t

Description:

Enumerates cap styles.

Enumerator

Description

CAP_NONE 

No cap style

CAP_ROUND 

Round cap style

ColorMode

  1. enum [OHOS::ColorMode]($api-api-SmartVision-Devices-Graphic.md#ga3a3fb04ed2cda4017e6771c66b692141) : uint8_t

Description:

colormode of image and font.

Enumerator

Description

ARGB8888 

ARGB8888 color mode

RGB888 

RGB888 color mode

RGB565 

RGB565 color mode

ARGB1555 

ARGB1555 color mode

ARGB4444 

ARGB4444 color mode

AL44 

AL44 color mode

AL88 

AL88 color mode

L1 

L1 color mode

L2 

L2 color mode

L4 

L4 color mode

L8 

L8 color mode

A1 

A1 color mode

A2 

A2 color mode

A4 

A4 color mode

A8 

A8 color mode

UNKNOW 

unknow color mode

DeviceType

  1. enum [OHOS::VirtualDeviceEvent::DeviceType]($api-api-SmartVision-Devices-Graphic.md#gaf8133740d5a3cb2f88a7f33cb11c6dbd)

Description:

Enumerates virtual device types.

DialogButtonType

  1. enum [OHOS::UIDialog::DialogButtonType]($api-api-SmartVision-Devices-Graphic.md#ga1bfefa0b46fd5a79a28d0c9a75114295)

Description:

Enumerates buttons in a dialog box.

Enumerator

Description

BUTTON1 

First button

BUTTON2 

Second button

BUTTON3 

Third button

Direction

  1. enum [OHOS::UIBoxProgress::Direction]($api-api-SmartVision-Devices-Graphic.md#ga4a7a2c192206c8b18379f42a5fd176eb) : uint8_t

Description:

Enumerates the directions of the progress bar.

Enumerator

Description

DIR_LEFT_TO_RIGHT 

Filling from left to right

DIR_RIGHT_TO_LEFT 

Filling from right to left

DIR_TOP_TO_BOTTOM 

Filling from top to bottom

DIR_BOTTOM_TO_TOP 

Filling from bottom to top

DisplayMode

  1. enum [OHOS::UIDigitalClock::DisplayMode]($api-api-SmartVision-Devices-Graphic.md#gabe3b64b11e5bf5d7b54e1039e40f306b)

Description:

Enumerates the display modes of this digital clock.

Enumerator

Description

DISPLAY_12_HOUR_NO_SECONDS 

12-hour format, without seconds

DISPLAY_24_HOUR_NO_SECONDS 

24-hour format, without seconds

DISPLAY_12_HOUR 

12-hour format

DISPLAY_24_HOUR 

24-hour format

DrawType

  1. enum [OHOS::UIAnalogClock::DrawType]($api-api-SmartVision-Devices-Graphic.md#ga0a595eeb50ce4e7dfff9ede16098d2db)

Description:

Enumerates the drawing types of a clock hand.

Enumerator

Description

DRAW_LINE 

Using a line to draw a clock hand

DRAW_IMAGE 

Using an image to draw a clock hand

FPSCalculateType

  1. enum [OHOS::SysInfo::FPSCalculateType]($api-api-SmartVision-Devices-Graphic.md#ga75d850e3abff6c2f617b689a0cb9a3d1)

Description:

Enumerates the FPS capture types.

Enumerator

Description

FPS_CT_FIXED_TIME 

Fixed time sampling: The system collects the number of page refresh times within one second.

FPS_CT_AVERAGE_SAMPLING 

Average sampling: The system collects statistics on the average frame rate of 100 frames. No extra space is required to store the data of each frame. The precision is not as high as that of precise sampling.

FPS_CT_PRECISE_SAMPLING 

Precise sampling: The system collects statistics on the average frame rate of the current 100 frames. Extra space is required to save the data of each frame. The result is more precise than that of average sampling.

HandType

  1. enum [OHOS::UIAnalogClock::HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf)

Description:

Enumerates the clock hand types.

Enumerator

Description

HOUR_HAND 

Hour hand

MINUTE_HAND 

Minute hand

SECOND_HAND 

Second hand

LineBreakMode

  1. enum [OHOS::UILabel::LineBreakMode]($api-api-SmartVision-Devices-Graphic.md#gaf2ba9acac6cafffc549781ace0475cd5) : uint8_t

Description:

Enumerates the display modes of a long text.

Enumerator

Description

LINE_BREAK_ADAPT 

The label size is adaptive to the text size.

LINE_BREAK_STRETCH 

The height of this label remains unchanged, and the width is adaptive to the text size.

LINE_BREAK_WRAP 

The width of this label remains unchanged, and the height is adaptive to the text size. The text switches to the next line if the text exceeds the maximum label width.

LINE_BREAK_ELLIPSIS 

The width and height of this label remain unchanged. If this text is too long, ellipsis will be used at the end.

LINE_BREAK_MARQUEE 

The width and height of this label remain unchanged. If this text is too long, it will be rolled to display.

LINE_BREAK_CLIP 

The width and height of this label remain unchanged. If this text is too long, it will be cropped to display.

LINE_BREAK_MAX 

Maximum value of the line break mode, which is used for validity check.

PaintStyle

  1. enum [OHOS::Paint::PaintStyle]($api-api-SmartVision-Devices-Graphic.md#ga548320a469b7862fa416af062cad5d7a)

Description:

Enumerates paint styles of a closed graph. The styles are invalid for non-closed graphs.

Enumerator

Description

STROKE_STYLE 

Stroke only

FILL_STYLE 

Fill only

STROKE_FILL_STYLE 

Stroke and fill

TextOrientation

  1. enum [OHOS::UIArcLabel::TextOrientation]($api-api-SmartVision-Devices-Graphic.md#ga0778527bee4a7ddd8d46395585a5cfb9) : uint8_t

Description:

Enumerates text orientations.

Enumerator

Description

INSIDE 

Inside

OUTSIDE 

Outside

TimeElement

  1. enum [OHOS::UIDigitalClock::TimeElement]($api-api-SmartVision-Devices-Graphic.md#gaa6aacc9ecbf5e20f22e50e542a69f472)

Description:

Enumerates the time elements of this digital clock.

Enumerator

Description

HOUR_ELEMENT 

Clock

MINUTE_ELEMENT 

Minute

SECOND_ELEMENT 

Second

UICheckBoxState

  1. enum [OHOS::UICheckBox::UICheckBoxState]($api-api-SmartVision-Devices-Graphic.md#ga15a3f0302aded0e4d1584ddc6002335d) : uint8_t

Description:

Enumerates the states of a check box.

UITextLanguageAlignment

  1. enum [OHOS::UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) : uint8_t

Description:

Enumerates text alignment modes.

Enumerator

Description

TEXT_ALIGNMENT_LEFT 

Left-aligned

TEXT_ALIGNMENT_RIGHT 

Right-aligned

TEXT_ALIGNMENT_CENTER 

Centered

TEXT_ALIGNMENT_TOP 

Top-aligned

TEXT_ALIGNMENT_BOTTOM 

Bottom-aligned

UITextLanguageDirect

  1. enum [OHOS::UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) : uint8_t

Description:

Enumerates text directions.

Enumerator

Description

TEXT_DIRECT_LTR 

Left-to-right

TEXT_DIRECT_RTL 

Right-to-left

WorkMode

  1. enum [OHOS::UIAbstractClock::WorkMode]($api-api-SmartVision-Devices-Graphic.md#ga19db90932bc71e6bbced6ccf2935ac98)

Description:

Enumerates the working modes of this clock.

Enumerator

Description

ALWAYS_ON 

Always on (drawing not updated)

NORMAL 

Normal (drawing updated with the time change)

Function Documentation

AbstractAdapter()

  1. OHOS::AbstractAdapter::AbstractAdapter ()

Description:

A constructor used to create an AbstractAdapter instance.

Add() [1/3]

  1. void OHOS::AnimatorManager::Add ([Animator]($api-api-SmartVision-Devices-OHOS-Animator.md) * animator)

Description:

Adds the Animator instance to the AnimatorManager linked list for management, so that the Run function of the Animator class is called once for each frame.

Parameters:

Name

Description

animator Indicates the pointer to the Animator instance to add.

See also:

Remove

Add() [2/3]

  1. virtual void OHOS::UIViewGroup::Add ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)

Description:

Adds a child view.

Reimplemented in OHOS::UISwipeView.

Parameters:

Name

Description

view Indicates the pointer to the child view to add.

Add() [3/3]

  1. void OHOS::UISwipeView::Add ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)

Description:

Adds a view.

Reimplemented from OHOS::UIViewGroup.

Parameters:

Name

Description

view Indicates the view to add.

AddDataSerial()

  1. virtual bool OHOS::UIChart::AddDataSerial ([UIChartDataSerial]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial.md) * dataSerial)

Description:

Adds a data set.

Parameters:

Name

Description

dataSerial Indicates the pointer to the data set class. For details, see UIChartDataSerial.

Returns:

Returns true if the data set is added successfully; returns false otherwise.

See also:

DeleteDataSerial

AddPoints()

  1. bool OHOS::UIChartDataSerial::AddPoints (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) * data, uint16_t count )

Description:

Adds data points.

The new data points are appended to the last added data. No more data points can be added if the maximum number is reached

Parameters:

Name

Description

data Indicates the pointer to the start address of the data point.
count Indicates the number of data points to add.

Returns:

Returns true if the data points are added successfully; returns false otherwise.

AlignBottomToSibling()

  1. void OHOS::UIView::AlignBottomToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Aligns the view with the bottom of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the top, and a negative number indicates the offset to the bottom.

AlignHorCenterToSibling()

  1. void OHOS::UIView::AlignHorCenterToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Aligns the view with the center of a sibling view in the x-axis.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the right, and a negative number indicates the offset to the left.

AlignLeftToSibling()

  1. void OHOS::UIView::AlignLeftToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Aligns the view with the left of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the right, and a negative number indicates the offset to the left.

AlignRightToSibling()

  1. void OHOS::UIView::AlignRightToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Aligns the view with the right of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the left, and a negative number indicates the offset to the right.

AlignTopToSibling()

  1. void OHOS::UIView::AlignTopToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Aligns the view with the top of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the bottom, and a negative number indicates the offset to the top.

AlignVerCenterToSibling()

  1. void OHOS::UIView::AlignVerCenterToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Aligns the view with the center of a sibling view in the y-axis.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the bottom, and a negative number indicates the offset to the top.

Animator() [1/2]

  1. OHOS::Animator::Animator ()

Description:

A default constructor used to create an Animator instance.

Animator() [2/2]

  1. OHOS::Animator::Animator ([AnimatorCallback]($api-api-SmartVision-Devices-OHOS-AnimatorCallback.md) * callback, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view, uint32_t time, bool repeat )

Description:

A constructor used to create an Animator instance.

Parameters:

Name

Description

callback Indicates the animator callback for producing animator effects. For details, see AnimatorCallback.
view Indicates the UIView instance bound to an animator, which can be used when invoking the animator callback.
time Indicates the duration of this animator, in milliseconds.
repeat Specifies whether to repeat this animator. true indicates the animator is repeated, and false (default value) indicates the animator is played once.

Aqua()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Aqua ()

Description:

Obtains the color data of aqua.

Returns:

Returns the color data.

Back()

  1. const T [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Back () const

Description:

Obtains the tail node data of a linked list.

Returns:

Returns the tail node data.

BackEaseIn()

  1. static int16_t OHOS::EasingEquation::BackEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in with an overshoot.

(s+1)*t^3 - s*t^2 is the equation for a back easing. The animation moves back slightly at the beginning and then accelerates towards the end.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

SetBackOvershoot | BackEaseOut | BackEaseInOut

BackEaseInOut()

  1. static int16_t OHOS::EasingEquation::BackEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in and then out with an overshoot.

(s+1)*t^3 - s*t^2 is the equation for a back easing. The animation slightly moves back at the beginning, goes towards the end, slightly exceeds it and finally comes back.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

SetBackOvershoot | BackEaseIn | BackEaseOut

BackEaseOut()

  1. static int16_t OHOS::EasingEquation::BackEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases out with an overshoot.

(s+1)*t^3 - s*t^2 is the equation for a back easing. The animation moves towards the end, slightly exceeds it and finally comes back.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

SetBackOvershoot | BackEaseIn | BackEaseInOut

Begin()

  1. [ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)<T>* [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Begin () const

Description:

Obtains the head node address of a linked list.

Returns:

Returns the head node address.

Black()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Black ()

Description:

Obtains the color data of black.

Returns:

Returns the color data.

Blue()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Blue ()

Description:

Obtains the color data of blue.

Returns:

Returns the color data.

Callback()

  1. virtual void OHOS::AnimatorCallback::Callback ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)

Description:

Called when each frame starts. This is a pure virtual function, which needs your inheritance and implementation.

Parameters:

Name

Description

view Indicates the UIView instance, which is added from the constructor of the Animator class.

Cancel()

  1. void OHOS::UITextureMapper::Cancel ()

Description:

Cancels this animator.

After being cancelled, the animator will stop in the current playback state.

CancelEvent()

  1. OHOS::CancelEvent::CancelEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)

Description:

A constructor used to create a CancelEvent instance.

Parameters:

Name

Description

pos Indicates the position where the cancel event occurs.

CircEaseIn()

  1. static int16_t OHOS::EasingEquation::CircEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in shaping like a circular curve.

sqrt(1-t^2) is the equation for a circular easing. The animation starts slowly from zero velocity and accelerates fast towards the end. The acceleration change is similar to a circular curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

CircEaseOut | CircEaseInOut

CircEaseInOut()

  1. static int16_t OHOS::EasingEquation::CircEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in and then out shaping like a circular curve.

sqrt(1-t^2) is the equation for a circular easing. The animation accelerates slowly until halfway and decreases slowly towards the end. The acceleration change is similar to a circular curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

CircEaseIn | CircEaseOut

CircEaseOut()

  1. static int16_t OHOS::EasingEquation::CircEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases out shaping like a circular curve.

sqrt(1-t^2) is the equation for a circular easing. The animation starts fast and decelerates slowly towards the end. The acceleration change is similar to a circular curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

CircEaseIn | CircEaseInOut

Clear() [1/2]

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Clear ()

Description:

Deletes all nodes from a linked list.

Clear() [2/2]

  1. void OHOS::UICanvas::Clear ()

Description:

Clears the entire canvas.

ClearData()

  1. void OHOS::UIChartDataSerial::ClearData ()

Description:

Clears all data points.

ClearDataSerial()

  1. virtual void OHOS::UIChart::ClearDataSerial ()

Description:

Clears all data sets.

ClearOnKeyActListener()

  1. void OHOS::RootView::ClearOnKeyActListener ()

Description:

Clears the listener for monitoring physical key events.

ClearOnVirtualDeviceEventListener()

  1. void OHOS::RootView::ClearOnVirtualDeviceEventListener ()

Description:

Clears the listener for monitoring the input events of a virtual device.

ClearValues()

  1. virtual void OHOS::UIPicker::ClearValues ()

Description:

Clears all values in the picker.

ClickEvent()

  1. OHOS::ClickEvent::ClickEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)

Description:

A constructor used to create a ClickEvent instance.

Parameters:

Name

Description

pos Indicates the position where the click event occurs.

Clip() [1/2]

  1. void OHOS::Clip (const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & line, const [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) & poly, [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > * pOut, uint8_t * pNum )

Description:

Clips a polygon by using a line segment and obtains the intersections.

Parameters:

Name

Description

line Indicates the line segment used for clipping.
poly Indicates the polygon to clip.
pOut Indicates the pointer to the intersections.
pNum Indicates the pointer to the number of the intersections.

Clip() [2/2]

  1. void OHOS::Clip ([Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) & poly, const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & line )

Description:

Clips a polygon by using a line segment.

Parameters:

Name

Description

poly Indicates the polygon to clip.
line Indicates the line segment used for clipping.

ColorTo16()

  1. static uint16_t OHOS::Color::ColorTo16 ([Color32]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Converts color data from the RGBA8888 format into the RGB565 format.

Parameters:

Name

Description

color Indicates the color data with the 32-bit color depth, which is defined by Color32.

Returns:

Returns the RGB565 color data.

ColorTo32() [1/2]

  1. static uint32_t OHOS::Color::ColorTo32 ([Color16]($api-api-SmartVision-Devices-OHOS-Color16.md) color, uint8_t alpha )

Description:

Converts color data with the 16-bit color depth into the RGBA8888 format.

Parameters:

Name

Description

color Indicates the color data with the 16-bit color depth, which is defined by Color16.
alpha Indicates the alpha, that is, how opaque each pixel is.

Returns:

Returns the RGBA8888 color data.

ColorTo32() [2/2]

  1. static uint32_t OHOS::Color::ColorTo32 ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Converts color data into the RGBA8888 format.

The color data definition varies according to the color depth.

Parameters:

Name

Description

color Indicates the color data, which is defined by ColorType.

Returns:

Returns the RGBA8888 color data.

Cross()

  1. T [OHOS::Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T >::Cross (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T > & other) const

Description:

Calculates the cross product of the two-dimensional vector and another two-dimensional vector.

Parameters:

Name

Description

other Indicates the two-dimensional vector to be used for calculation.

Returns:

Returns the cross product.

CubicEaseIn()

  1. static int16_t OHOS::EasingEquation::CubicEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in shaping like a cubic curve.

t^3 is the equation for a cubic easing. The animation starts slowly from zero velocity and accelerates fast towards the end. The acceleration change is similar to a cubic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

CubicEaseOut | CubicEaseInOut

CubicEaseInOut()

  1. static int16_t OHOS::EasingEquation::CubicEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in and then out shaping like a cubic curve.

t^3 is the equation for a cubic easing. The animation accelerates slowly until halfway and decelerates slowly towards the end. The acceleration change is similar to a cubic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

CubicEaseIn | CubicEaseOut

CubicEaseOut()

  1. static int16_t OHOS::EasingEquation::CubicEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases out shaping like a cubic curve.

t^3 is the equation for a cubic easing. The animation starts fast and decelerates slowly towards the end. The acceleration change is similar to a cubic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

CubicEaseIn | CubicEaseInOut

Cyan()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Cyan ()

Description:

Obtains the color data of cyan.

Returns:

Returns the color data.

DeleteDataSerial()

  1. virtual bool OHOS::UIChart::DeleteDataSerial ([UIChartDataSerial]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial.md) * dataSerial)

Description:

Deletes a data set.

Parameters:

Name

Description

dataSerial Indicates the pointer to the data set class. For details, see UIChartDataSerial.

Returns:

Returns true if the data set is deleted successfully; returns false otherwise.

See also:

AddDataSerial

Determinant()

  1. T [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::Determinant

Description:

Obtains the determinant of the matrix.

Returns:

Returns the determinant.

Disable()

  1. void OHOS::UIButton::Disable ()

Description:

Disables this button.

DisplayLeadingZero()

  1. void OHOS::UIDigitalClock::DisplayLeadingZero (bool displayLeadingZero)

Description:

Sets whether to add 0 before the hour of this digital clock.

Parameters:

Name

Description

displayLeadingZero Specifies whether to add 0 before the hour of this digital clock. true indicates that 0 is added, and false indicates the opposite case.

Dot()

  1. T [OHOS::Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T >::Dot (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T > & other) const

Description:

Calculates the scalar product of the two-dimensional vector and another two-dimensional vector.

Parameters:

Name

Description

other Indicates the two-dimensional vector to be used for calculation.

Returns:

Returns the scalar product.

DragEvent()

  1. OHOS::DragEvent::DragEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & newPos, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & lastPos, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & totalLen )

Description:

A constructor used to create a DragEvent instance.

Parameters:

Name

Description

newPos Indicates the new position in the drag event.
lastPos Indicates the last position in the drag event.
totalLen Indicates the distance that the view has been dragged, including the movement on the x-axis and y-axis.

DrawArc()

  1. void OHOS::UICanvas::DrawArc (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & center, uint16_t radius, int16_t startAngle, int16_t endAngle, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws an arc.

Only stroke is supported. When the start angle is smaller than the end angle, the sector is drawn clockwise. Otherwise, the sector is drawn counterclockwise.

Parameters:

Name

Description

center Indicates the coordinates of the arc’s center.
radius Indicates the radius of the arc.
startAngle Indicates the start angle of the arc. Value 0 indicates the 12-o’clock direction, and 90 indicates the 3-o’clock direction.
endAngle Indicates the end angle of the arc. Value 0 indicates the 12-o’clock direction, and 90 indicates the 3-o’clock direction.
paint Indicates the arc style. For details, see Paint.

DrawCircle()

  1. void OHOS::UICanvas::DrawCircle (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & center, uint16_t radius, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a circle.

Parameters:

Name

Description

center Indicates the coordinates of the circle center.
radius Indicates the radius of the circle.
paint Indicates the circle style. For details, see Paint.

DrawCurve() [1/2]

  1. void OHOS::UICanvas::DrawCurve (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & control1, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & control2, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & endPoint, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a cubic Bezier curve.

If SetStartPosition is not used to set the coordinates of the start point of the curve, the drawing starts from the end point of the last line. Currently, the opacity cannot be set, and the maximum line width is 3.

Parameters:

Name

Description

control1 Indicates the coordinates of the first control point of the cubic Bezier curve.
control2 Indicates the coordinates of the second control point of the cubic Bezier curve.
endPoint Indicates the coordinates of the end point of the cubic Bezier curve.
paint Indicates the curve style. For details, see Paint.

DrawCurve() [2/2]

  1. void OHOS::UICanvas::DrawCurve (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & startPoint, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & control1, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & control2, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & endPoint, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a cubic Bezier curve from the start point coordinates.

Currently, the opacity cannot be set, and the maximum line width is 3.

Parameters:

Name

Description

startPoint Indicates the coordinates of the start point of the cubic Bezier curve.
control1 Indicates the coordinates of the first control point of the cubic Bezier curve.
control2 Indicates the coordinates of the second control point of the cubic Bezier curve.
endPoint Indicates the coordinates of the end point of the cubic Bezier curve.
paint Indicates the curve style. For details, see Paint.

DrawImage()

  1. void OHOS::UICanvas::DrawImage (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & startPoint, const char * image, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws an image.

Parameters:

Name

Description

startPoint Indicates the coordinates of the start point.
image Indicates the pointer to the image source.
paint Indicates the image style. For details, see Paint.

DrawLabel()

  1. void OHOS::UICanvas::DrawLabel (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & startPoint, const char * text, uint16_t maxWidth, const [FontStyle]($api-api-SmartVision-Devices-OHOS-UICanvas-FontStyle.md) & fontStyle, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws text.

Only fill is supported. If the text length exceeds the value of maxWidth, the text will be truncated.

Parameters:

Name

Description

startPoint Indicates the coordinates of the start point.
text Indicates the pointer to the text content.
maxWidth Indicates the maximum width of the text that can be displayed. If the maximum width is exceeded, the text is truncated.
fontStyle Indicates the text layout and font style. For details, see FontStyle.
paint Indicates the text style. For details, see Paint.

DrawLine() [1/2]

  1. void OHOS::UICanvas::DrawLine (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & endPoint, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a straight line.

If SetStartPosition is not used to set the coordinates of the start point of the line, the drawing starts from the end point of the last line.

Parameters:

Name

Description

endPoint Indicates the end point of the straight line.
paint Indicates the straight line style. For details, see Paint.

DrawLine() [2/2]

  1. void OHOS::UICanvas::DrawLine (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & startPoint, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & endPoint, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a straight line from the coordinates of the start point.

Parameters:

Name

Description

startPoint Indicates the coordinates of the start point.
endPoint Indicates the coordinates of the end point.
paint Indicates the straight line style. For details, see Paint.

DrawRect()

  1. void OHOS::UICanvas::DrawRect (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & startPoint, int16_t height, int16_t width, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a rectangle.

Parameters:

Name

Description

startPoint Indicates the coordinates of the point at the upper left corner of the rectangle.
height Indicates the height of the rectangle.
width Indicates the width of the rectangle.
paint Indicates the rectangle style. For details, see Paint.

DrawSector()

  1. void OHOS::UICanvas::DrawSector (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & center, uint16_t radius, int16_t startAngle, int16_t endAngle, const [Paint]($api-api-SmartVision-Devices-OHOS-Paint.md) & paint )

Description:

Draws a sector.

When the start angle is smaller than the end angle, the sector is drawn clockwise. Otherwise, the sector is drawn counterclockwise.

Parameters:

Name

Description

center Indicates the coordinates of the sector’s center.
radius Indicates the radius of the sector.
startAngle Indicates the start angle of the sector. Value 0 indicates the 12-o’clock direction, and 90 indicates the 3-o’clock direction.
endAngle Indicates the end angle of the sector. Value 0 indicates the 12-o’clock direction, and 90 indicates the 3-o’clock direction.
paint Indicates the sector style. For details, see Paint.

DumpDomNode()

  1. char* OHOS::UIDumpDomTree::DumpDomNode (const char * id)

Description:

Exports information about a specified DOM node.

Parameters:

Name

Description

id Indicates the pointer to the DOM node ID.

Returns:

Returns a character string about the DOM node information. The character string memory is released by invoking cJSON_free().

DumpDomTree() [1/2]

  1. bool OHOS::UIDumpDomTree::DumpDomTree (const char * id)

Description:

Exports information about a DOM tree starting from a specified DOM node and saves the information to the default path. The default path is DEFAULT_DUMP_DOM_TREE_PATH.

Parameters:

Name

Description

id Indicates the pointer to the DOM node ID.

Returns:

Returns true if the operation is successful; returns false otherwise.

DumpDomTree() [2/2]

  1. bool OHOS::UIDumpDomTree::DumpDomTree (const char * id, const char * path )

Description:

Exports information about a DOM tree starting from a specified DOM node and saves the information to a specified path.

Parameters:

Name

Description

id Indicates the pointer to the DOM node ID.
path Indicates the pointer to the specified path.

Returns:

Returns true if the operation is successful; returns false otherwise.

Enable()

  1. void OHOS::UIButton::Enable ()

Description:

Enables this button.

EnableAutoAlign()

  1. void OHOS::UIList::EnableAutoAlign (bool state)

Description:

Sets the automatic alignment state for this list. When a scroll stops, a child view is selected and its position is automatically aligned with the preset position.

Parameters:

Name

Description

state Indicates the automatic alignment state. true indicates this state is enabled, and false indicates the opposite case.

EnableBackground()

  1. void OHOS::UIAbstractProgress::EnableBackground (bool enable)

Description:

Sets whether the background of the progress bar is visible.

Parameters:

Name

Description

enable Specifies whether the background of the progress bar is visible. true (the default value) indicates that the background is visible, and false indicates the opposite case.

EnableBottomPoint()

  1. void OHOS::UIChartDataSerial::EnableBottomPoint (bool enable)

Description:

Enables the feature of drawing the bottom point of a polyline. If there are multiple bottom points, only the first one is drawn.

Parameters:

Name

Description

enable Specifies whether to draw the bottom point. Value true means to draw the bottom point, and value false means not to draw the bottom point.

EnableGradient()

  1. void OHOS::UIChartDataSerial::EnableGradient (bool enable)

Description:

Enables the fill color of a line chart.

This function applies only to line charts. By default, the area between the polyline and the x-axis is filled. You can use SetGradientBottom to modify the filled region.

Parameters:

Name

Description

enable Specifies whether to enable the fill color. Value true means to enable the fill color, and value false means to disable the fill color. The default value is false.

EnableHeadPoint()

  1. void OHOS::UIChartDataSerial::EnableHeadPoint (bool enable)

Description:

Enables the feature of drawing the frontmost point on a polyline.

Parameters:

Name

Description

enable Specifies whether to draw the frontmost point. Value true means to draw the frontmost point, and value false means not to draw the frontmost point.

EnableReverse()

  1. void OHOS::UIChart::EnableReverse (bool enable)

Description:

Enables chart reverse.

After the chart is reversed, the x-axis aligns with the top of the chart. The pixel position corresponding to the data point remains unchanged. Complementary filling is performed on the chart (only the part that is not filled previously will be filled).

Parameters:

Name

Description

enable Specifies whether to enable chart reverse. Value true means to enable chart reverse, and value false means not to enable chart reverse. The default value is false.

EnableSecond()

  1. void OHOS::UITimePicker::EnableSecond (bool state)

Description:

Sets whether to enable seconds in the time picker.

Parameters:

Name

Description

state Specifies whether to enable seconds in the time picker. Value true means to enable seconds, and value false means to disable seconds. The default value is false.

EnableSmooth()

  1. void OHOS::UIChartDataSerial::EnableSmooth (bool smooth)

Description:

Sets whether to smooth a polyline.

This function applies only to line charts. After the smoothing, some data is discarded. Therefore, the polyline does not pass through all data points. If smooth is set to true, the filling color, top point, and bottom point of a line chart have deviations. Therefore, you are advised not to use these functions at the same time.

Parameters:

Name

Description

smooth Specifies whether to smooth a polyline. Value true means to smooth a polyline, and value false means not to smooth a polyline. The default value is false.

EnableTopPoint()

  1. void OHOS::UIChartDataSerial::EnableTopPoint (bool enable)

Description:

Enables the feature of drawing the top point of a polyline. If there are multiple top points, only the first one is drawn.

Parameters:

Name

Description

enable Specifies whether to draw the top point. Value true means to draw the top point, and value false means not to draw the top point.

End()

  1. const [ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)<T>* [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::End () const

Description:

Obtains the end node address of a linked list.

Returns:

Returns the end node address.

Event() [1/2]

  1. OHOS::Event::Event ()

Description:

A default constructor used to create an Event instance.

Event() [2/2]

  1. OHOS::Event::Event (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & curPos)

Description:

A constructor used to create an Event instance.

Parameters:

Name

Description

pos Indicates the position where the event occurs.

FindSubView()

  1. static bool OHOS::RootView::FindSubView (const [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & parentView, const [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * subView )

Description:

Checks whether the target view is one of the child views of the specified parent view.

Parameters:

Name

Description

parentView Indicates the specified parent view.
subView Indicates the target child view.

Returns:

Returns true if the target view is available; returns false otherwise.

FlexLayout()

  1. OHOS::FlexLayout::FlexLayout ()

Description:

A default constructor used to create a FlexLayout instance.

Format()

  1. virtual bool OHOS::TextFormatter::Format (int16_t value, char * outText, uint16_t textLen )

Description:

Converts the input integer into a character string for output.

Parameters:

Name

Description

value Indicates the input integer.
outText Indicates the pointer to the converted string.
textLen Indicates the length of the string.

Front()

  1. const T [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Front () const

Description:

Obtains the head node data of a linked list.

Returns:

Returns the head node data.

GetAlign()

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::UILabelButton::GetAlign () const

Description:

Obtains the alignment mode of this text.

Returns:

Returns the text alignment mode, as defined in UITextLanguageAlignment.

GetAllChildRelativeRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIViewGroup::GetAllChildRelativeRect () const

Description:

Obtains the rectangle area of a new view group after being adaptive to the size of all child views.

Returns:

Returns the rectangle area of the new view group.

GetArcTextCenter()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::UIArcLabel::GetArcTextCenter () const

Description:

Obtains the center position of this arc text.

Returns:

Returns the center position of this arc text.

GetArcTextEndAngle()

  1. int16_t OHOS::UIArcLabel::GetArcTextEndAngle () const

Description:

Obtains the end angle of this arc text.

Returns:

Returns the end angle of this arc text.

GetArcTextOrientation()

  1. [TextOrientation]($api-api-SmartVision-Devices-Graphic.md#ga0778527bee4a7ddd8d46395585a5cfb9) OHOS::UIArcLabel::GetArcTextOrientation () const

Description:

Obtains the orientation of this arc text.

Returns:

Returns the orientation of this arc text.

GetArcTextRadius()

  1. uint16_t OHOS::UIArcLabel::GetArcTextRadius () const

Description:

Obtains the radius of this arc text.

Returns:

Returns the radius of this arc text.

GetArcTextStartAngle()

  1. int16_t OHOS::UIArcLabel::GetArcTextStartAngle () const

Description:

Obtains the start angle of this arc text.

Returns:

Returns the start angle of this arc text.

GetBackgroundFontId()

  1. uint16_t OHOS::UIPicker::GetBackgroundFontId () const

Description:

Obtains the font ID of the background text.

Returns:

Returns the font ID.

GetBackgroundStyle() [1/2]

  1. const [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::UIAbstractProgress::GetBackgroundStyle () const

Description:

Obtains the background style of this progress bar.

Returns:

Returns the background style. @See SetBackgroundStyle

GetBackgroundStyle() [2/2]

  1. int64_t OHOS::UIAbstractProgress::GetBackgroundStyle (uint8_t key) const

Description:

Obtains the value of a background style of this progress bar.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetBackgroundTextColor()

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIPicker::GetBackgroundTextColor () const

Description:

Obtains the color of the background text.

Returns:

Returns the color.

GetBackgroundTransparentStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetBackgroundTransparentStyle ()

Description:

Obtains the background transparent style.

Returns:

Returns the background transparent style.

GetBezierInterpolation()

  1. static int16_t OHOS::Interpolation::GetBezierInterpolation (int16_t t, int16_t u0, int16_t u1, int16_t u2, int16_t u3 )

Description:

Obtains the value calculated by the cubic Bezier equation.

Use [0, 1024] instead of [0, 1] in the standard Bezier equation. The cubic Bezier equation is B(t) = P0*(1-t)^3 + 3*P1*t*(1-t)^2 + 3*P2*t^2*(1-t) + P3*t^3.

Parameters:

Name

Description

t Indicates the current change rate of the cubic Bezier curve, within [0, 1024].
u0 Indicates the coordinates for the start point of the cubic Bezier curve, within [0, 1024].
u1 Indicates the coordinates for the first control point of the cubic Bezier curve, within [0, 1024].
u2 Indicates the coordinates for the second control point of the cubic Bezier curve, within [0, 1024].
u3 Indicates the coordinates for the end point of the cubic Bezier curve, within [0, 1024].

Returns:

Returns the coordinates for the current change rate.

GetBlurLevel()

  1. BlurLevel OHOS::UIImageView::GetBlurLevel () const

Description:

Obtains the blur level of this image when it is rotated or scaled.

Returns:

Returns the blur level of this image, as defined in BlurLevel.

GetBottom()

  1. int16_t OHOS::Rect::GetBottom () const

Description:

Obtains the bottom boundary coordinate of the rectangle.

Returns:

Returns the bottom boundary coordinate.

GetBottomPointStyle()

  1. const [PointStyle]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial-PointStyle.md)& OHOS::UIChartDataSerial::GetBottomPointStyle () const

Description:

Obtains the style of the bottom point of a polyline.

Returns:

Returns the style of the point. For details, see PointStyle.

GetBoxRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::TransformMap::GetBoxRect () const

Description:

Obtains the minimum rectangle that can contain a polygon. All vertices of the polygon are inside this rectangle.

Returns:

Returns the minimum rectangle that can contain the polygon.

GetBrightColorStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetBrightColorStyle ()

Description:

Obtains the bright color style.

Returns:

Returns the bright color style.

GetBrightStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetBrightStyle ()

Description:

Obtains the bright style.

Returns:

Returns the bright style.

GetButtonInactivedStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetButtonInactivedStyle ()

Description:

Obtains the button inactived style.

Returns:

Returns the button inactived style.

GetButtonPressedStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetButtonPressedStyle ()

Description:

Obtains the button pressed style.

Returns:

Returns the button pressed style.

GetButtonReleasedStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetButtonReleasedStyle ()

Description:

Obtains the button released style.

Returns:

Returns the button released style.

GetButtonStyle()

  1. [ButtonStyle]($api-api-SmartVision-Devices-OHOS-ButtonStyle.md)& OHOS::Theme::GetButtonStyle ()

Description:

Obtains the style of this button.

Returns:

Returns the button style.

GetCenterPosition()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::UICircleProgress::GetCenterPosition () const

Description:

Obtains the coordinates of the center point for this circular progress bar.

The coordinates of the center point refer to the position relative to the view.

Returns:

Returns the coordinates of the center point.

See also:

SetCenterPosition

GetChildById() [1/2]

  1. virtual [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIView::GetChildById (const char * id) const

Description:

Obtains the child view of a specified ID.

Reimplemented in OHOS::UIViewGroup.

Returns:

Returns the pointer to the child view.

GetChildById() [2/2]

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIViewGroup::GetChildById (const char * id) const

Description:

Obtains the target child view with a specified ID.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

id Indicates the pointer to the ID of the target child view.

Returns:

Returns the target child view if available; returns nullptr otherwise.

GetChildrenHead()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIViewGroup::GetChildrenHead () const

Description:

Obtains the first child view in this view group.

Returns:

Returns the first child view.

GetChildrenTail()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIViewGroup::GetChildrenTail () const

Description:

Obtains the last child view in this view group.

Returns:

Returns the last child view.

GetClockWise()

  1. bool OHOS::TransformMap::GetClockWise () const

Description:

Checks whether the vertex coordinates of a polygon are clockwise.

Returns:

Returns true if the vertex coordinates are clockwise; returns false otherwise.

GetColorFromRGB()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::GetColorFromRGB (uint8_t r8, uint8_t g8, uint8_t b8 )

Description:

Obtains the color based on the RGB color value.

Parameters:

Name

Description

r8 Indicates the intensity of red.
g8 Indicates the intensity of green.
b8 Indicates the intensity of blue.

Returns:

Returns the color data generated.

GetColorFromRGBA()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::GetColorFromRGBA (uint8_t r8, uint8_t g8, uint8_t b8, uint8_t alpha )

Description:

Obtains the color based on the RGBA color value.

Parameters:

Name

Description

r8 Indicates the intensity of red.
g8 Indicates the intensity of green.
b8 Indicates the intensity of blue.
alpha Indicates the alpha, that is, how opaque each pixel is.

Returns:

Returns the color data generated.

GetContentRect() [1/2]

  1. virtual [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIView::GetContentRect ()

Description:

Obtains the content of the absolute rectangle area of the view. This area excludes padding.

Reimplemented in OHOS::UIButton.

Returns:

Returns the content of the absolute rectangle area.

GetContentRect() [2/2]

  1. virtual [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIButton::GetContentRect ()

Description:

Obtains a rectangular area that contains coordinate information.

Reimplemented from OHOS::UIView.

Returns:

Returns the rectangle area.

GetCount() [1/2]

  1. virtual uint16_t OHOS::TextAdapter::GetCount ()

Description:

Obtains the data size of the UILabel adapter.

Implements OHOS::AbstractAdapter.

Returns:

Returns the data size of the UILabel adapter.

GetCount() [2/2]

  1. virtual uint16_t OHOS::AbstractAdapter::GetCount ()

Description:

Obtains the number of adapter data items.

Implemented in OHOS::TextAdapter.

Returns:

Returns the number of adapter data items.

GetCurImageSrc()

  1. const [Image]($api-api-SmartVision-Devices-OHOS-Image.md)* OHOS::UIButton::GetCurImageSrc () const

Description:

Obtains the image for the current button state.

Returns:

Returns the image for the current button state.

GetCurrent()

  1. [Theme]($api-api-SmartVision-Devices-OHOS-Theme.md)* OHOS::ThemeManager::GetCurrent ()

Description:

Obtains the current screen theme of this application.

Returns:

Returns the current theme if available; returns nullptr otherwise.

GetCurrentHour()

  1. uint8_t OHOS::UIAbstractClock::GetCurrentHour () const

Description:

Obtains the current number of hours.

Returns:

Returns the current number of hours.

GetCurrentMinute()

  1. uint8_t OHOS::UIAbstractClock::GetCurrentMinute () const

Description:

Obtains the current number of minutes.

Returns:

Returns the current number of minutes.

GetCurrentPage()

  1. uint16_t OHOS::UISwipeView::GetCurrentPage () const

Description:

Obtains the current tab index.

Returns:

Returns the current tab index.

GetCurrentPos()

  1. const [Point]($api-api-SmartVision-Devices-OHOS-Point.md)& OHOS::Event::GetCurrentPos () const

Description:

Obtains the position where an event occurs.

Returns:

Returns the position.

GetCurrentSecond()

  1. uint8_t OHOS::UIAbstractClock::GetCurrentSecond () const

Description:

Obtains the current number of seconds.

Returns:

Returns the current number of seconds.

GetCurrentView()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UISwipeView::GetCurrentView () const

Description:

Obtains the current view.

Returns:

Returns the current view.

GetData()

  1. const T* [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::GetData () const

Description:

Obtains the 3 x 3 matrix data.

Returns:

Returns the 3 x 3 matrix data.

GetDataCount()

  1. uint16_t OHOS::UIChartDataSerial::GetDataCount () const

Description:

Obtains the number of data points available in the data set.

Returns:

Returns the number of data points.

GetDefaultStyle()

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetDefaultStyle ()

Description:

Obtains the default style.

Returns:

Returns the default style.

GetDeltaX()

  1. int16_t OHOS::DragEvent::GetDeltaX () const

Description:

Obtains the difference between the current position and the last position of the view in the x-axis.

Returns:

Returns the different in the x-aix.

GetDeltaY()

  1. int16_t OHOS::DragEvent::GetDeltaY () const

Description:

Obtains the difference between the current position and the last position of the view in the y-axis.

Returns:

Returns the different in the y-aix.

GetDirect() [1/4]

  1. [UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) OHOS::UIArcLabel::GetDirect ()

Description:

Obtains the direction of this text.

Returns:

Returns the text direction, as defined in UITextLanguageDirect.

GetDirect() [2/4]

  1. [UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) OHOS::Text::GetDirect () const

Description:

Obtains the direction of this text.

Returns:

Returns the text direction, as defined in UITextLanguageDirect.

GetDirect() [3/4]

  1. [UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) OHOS::UILabelButton::GetDirect () const

Description:

Obtains the direction of this text.

Returns:

Returns the text direction, as defined in UITextLanguageDirect.

GetDirect() [4/4]

  1. [UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) OHOS::UILabel::GetDirect () const

Description:

Obtains the direction of this text.

Returns:

Returns the text direction, as defined in UITextLanguageDirect.

GetDirection() [1/3]

  1. uint8_t OHOS::UIAbstractScroll::GetDirection () const

Description:

Obtains the scroll direction.

Returns:

Returns the scroll direction, either HORIZONTAL or VERTICAL.

GetDirection() [2/3]

  1. uint8_t OHOS::UISwipeView::GetDirection () const

Description:

Obtains the dragging direction.

Returns:

Returns the dragging direction.

GetDirection() [3/3]

  1. [Direction]($api-api-SmartVision-Devices-Graphic.md#ga4a7a2c192206c8b18379f42a5fd176eb) OHOS::UIBoxProgress::GetDirection () const

Description:

Obtains the direction of this progress bar.

Returns:

Returns the direction of this progress bar, as defined in Direction.

See also:

SetDirection

GetDisplayMode()

  1. [DisplayMode]($api-api-SmartVision-Devices-Graphic.md#gabe3b64b11e5bf5d7b54e1039e40f306b) OHOS::UIDigitalClock::GetDisplayMode () const

Description:

Obtains the display mode of this digital clock.

Returns:

Returns the display mode of this digital clock.

GetDragACCLevel()

  1. uint8_t OHOS::UIAbstractScroll::GetDragACCLevel () const

Description:

Obtains the drag acceleration.

Returns:

Returns the drag acceleration.

GetDragDirection()

  1. uint8_t OHOS::DragEvent::GetDragDirection () const

Description:

Obtains the direction in the drag event.

Returns:

Returns the direction. Available values are as follows: 0 indicates dragging from left to right. 1 indicates dragging from right to left. 2 indicates dragging from top to bottom. 3 indicates dragging from bottom to top.

GetEllipsisIndex()

  1. uint16_t OHOS::Text::GetEllipsisIndex (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & textRect, const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style )

Description:

Obtains the index of the character from where text will be replaced by ellipses based on the text rectangle and style.

Parameters:

Name

Description

textRect Indicates the text rectangle.
style Indicates the text style.

GetEndAngle()

  1. int16_t OHOS::UICircleProgress::GetEndAngle () const

Description:

Obtains the end angle.

Returns:

Returns the end angle.

See also:

SetEndAngle

GetFillColor() [1/2]

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Paint::GetFillColor () const

Description:

Obtains the fill color.

Returns:

Returns the fill color.

See also:

SetFillColor

GetFillColor() [2/2]

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIChartDataSerial::GetFillColor () const

Description:

Obtains the fill color of the data set.

Returns:

Returns the fill color.

See also:

SetFillColor

GetFontId() [1/5]

  1. uint8_t OHOS::TextAdapter::GetFontId () const

Description:

Obtains font ID.

Returns:

Returns the font ID. For details, see UITextLanguageFontId.

GetFontId() [2/5]

  1. uint8_t OHOS::Text::GetFontId () const

Description:

Obtains the font ID.

Returns:

Returns the front ID.

GetFontId() [3/5]

  1. uint8_t OHOS::UIArcLabel::GetFontId () const

Description:

Obtains the font ID composed of font name and size.

Returns:

Returns the front ID of this arc label.

GetFontId() [4/5]

  1. uint8_t OHOS::UILabelButton::GetFontId () const

Description:

Obtains the font ID.

Returns:

Returns the front ID composed of the font name and size.

GetFontId() [5/5]

  1. uint8_t OHOS::UILabel::GetFontId () const

Description:

Obtains the font ID composed of font name and size.

Returns:

Returns the front ID of this label.

GetForegroundStyle() [1/2]

  1. const [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::UIAbstractProgress::GetForegroundStyle () const

Description:

Obtains the foreground style of this progress bar.

Returns:

Returns the foreground style. @See SetForegroundStyle

GetForegroundStyle() [2/2]

  1. int64_t OHOS::UIAbstractProgress::GetForegroundStyle (uint8_t key) const

Description:

Obtains the value of a foreground style of this progress bar.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetFPS()

  1. static float OHOS::SysInfo::GetFPS ()

Description:

Obtains the FPS data.

Returns:

Returns the FPS data.

GetFPSCalculateType()

  1. [FPSCalculateType]($api-api-SmartVision-Devices-Graphic.md#ga75d850e3abff6c2f617b689a0cb9a3d1) OHOS::SysInfo::OnFPSChangedListener::GetFPSCalculateType () const

Description:

Obtains the FPS sampling type.

Returns:

Returns the FPS sampling type. For details, see FPSCalculateType.

GetHandCurrentAngle()

  1. uint16_t OHOS::UIAnalogClock::GetHandCurrentAngle ([HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf) type) const

Description:

Obtains the current rotation angle of the specified clock hand.

Parameters:

Name

Description

type Indicates the clock hand type, as enumerated in HandType.

Returns:

Returns the current rotation angle of this specified clock hand.

GetHandInitAngle()

  1. uint16_t OHOS::UIAnalogClock::GetHandInitAngle ([HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf) type) const

Description:

Obtains the initial rotation angle of the specified clock hand.

Parameters:

Name

Description

type Indicates the clock hand type, as enumerated in HandType.

Returns:

Returns the initial rotation angle of this specified clock hand.

GetHandPosition()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::UIAnalogClock::GetHandPosition ([HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf) type) const

Description:

Obtains the position of a specified clock hand.

Parameters:

Name

Description

type Indicates the clock hand type, as enumerated in HandType.

Returns:

Returns the position of this specified clock hand.

GetHandRotateCenter()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::UIAnalogClock::GetHandRotateCenter ([HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf) type) const

Description:

Obtains the rotation center of a specified clock hand.

Parameters:

Name

Description

type Indicates the clock hand type, as enumerated in HandType.

Returns:

Returns the rotation center.

GetHeader()

  1. void OHOS::Image::GetHeader ([ImageHeader]($api-api-SmartVision-Devices-OHOS-ImageHeader.md) & header) const

Description:

Obtains the basic image information, including the image format, width, and height.

Parameters:

Name

Description

header Indicates the basic image information.

GetHeadPointStyle()

  1. const [PointStyle]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial-PointStyle.md)& OHOS::UIChartDataSerial::GetHeadPointStyle () const

Description:

Obtains the style of the frontmost point on a polyline.

Returns:

Returns the style of the point. For details, see PointStyle.

GetHeight() [1/7]

  1. uint16_t OHOS::Screen::GetHeight ()

Description:

Obtains the height of this screen.

Returns:

Returns the screen height.

GetHeight() [2/7]

  1. virtual int16_t OHOS::UIView::GetHeight ()

Description:

Obtains the height for the view.

Reimplemented in OHOS::UIButton, OHOS::UILabel, OHOS::UIArcLabel, and OHOS::UIImageView.

Returns:

Returns the view height.

GetHeight() [3/7]

  1. int16_t OHOS::Rect::GetHeight () const

Description:

Obtains the rectangle height.

Returns:

Returns the rectangle height.

GetHeight() [4/7]

  1. int16_t OHOS::UIImageView::GetHeight ()

Description:

Obtains the height of this image view.

Reimplemented from OHOS::UIView.

Returns:

Returns the height of this image view.

GetHeight() [5/7]

  1. int16_t OHOS::UIArcLabel::GetHeight ()

Description:

Obtains the height of this arc text.

Reimplemented from OHOS::UIView.

Returns:

Returns the height of this arc text.

GetHeight() [6/7]

  1. int16_t OHOS::UILabel::GetHeight ()

Description:

Obtains the height of this label.

Reimplemented from OHOS::UIView.

Returns:

Returns the label height.

GetHeight() [7/7]

  1. int16_t OHOS::UIButton::GetHeight ()

Description:

Obtains the height of this image.

Reimplemented from OHOS::UIView.

Returns:

Returns the image height.

GetHideCount()

  1. uint16_t OHOS::UIChartDataSerial::GetHideCount () const

Description:

Obtains the number of hidden points in the data set.

Returns:

Returns the number of hidden points.

See also:

HidePoint

GetHideIndex()

  1. uint16_t OHOS::UIChartDataSerial::GetHideIndex () const

Description:

Obtains the index from which the data set starts to hide.

Returns:

Returns the index.

See also:

HidePoint

GetHighlightFontId()

  1. uint16_t OHOS::UIPicker::GetHighlightFontId () const

Description:

Obtains the font ID of the highlighted text.

Returns:

Returns the font ID.

GetHighlightTextColor()

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIPicker::GetHighlightTextColor () const

Description:

Obtains the color of the highlighted text.

Returns:

Returns the color of the highlighted text.

GetHorAlign() [1/3]

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::UIArcLabel::GetHorAlign () const

Description:

Obtains the horizontal alignment mode.

Returns:

Returns the horizontal alignment mode.

GetHorAlign() [2/3]

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::Text::GetHorAlign () const

Description:

Obtains the horizontal alignment mode.

Returns:

Returns the horizontal alignment mode.

GetHorAlign() [3/3]

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::UILabel::GetHorAlign () const

Description:

Obtains the horizontal alignment mode.

Returns:

Returns the horizontal alignment mode.

GetHorizontalScrollState()

  1. bool OHOS::UIScrollView::GetHorizontalScrollState () const

Description:

Checks whether a horizontal scroll is enabled.

Returns:

Returns true if a horizontal scroll is enabled; returns false otherwise.

GetImageAnimatorImageNum()

  1. uint8_t OHOS::UIImageAnimatorView::GetImageAnimatorImageNum () const

Description:

Obtains the number of images.

Returns:

Returns the number of images.

GetImageAnimatorSrc()

  1. const [ImageAnimatorInfo]($api-api-SmartVision-Devices-OHOS-ImageAnimatorInfo.md)* OHOS::UIImageAnimatorView::GetImageAnimatorSrc () const

Description:

Obtains the image array of this frame animator.

Returns:

Returns a pointer to the ImageAnimatorInfo array if the operation is successful; returns nullptr otherwise.

GetImageInfo() [1/2]

  1. const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md)* OHOS::Image::GetImageInfo () const

Description:

Obtains the image information in an array.

Returns:

Returns the pointer to the image information.

GetImageInfo() [2/2]

  1. const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md)* OHOS::UIImageView::GetImageInfo () const

Description:

获取图片信息

Returns:

图片信息

GetImageX()

  1. int16_t OHOS::UIButton::GetImageX () const

Description:

Obtains the x-coordinate of this image.

Returns:

Returns the x-coordinate of this image.

GetImageY()

  1. int16_t OHOS::UIButton::GetImageY () const

Description:

Obtains the y-coordinate of this image.

Returns:

Returns the y-coordinate of this image.

GetInstance() [1/5]

  1. static [Screen]($api-api-SmartVision-Devices-OHOS-Screen.md)& OHOS::Screen::GetInstance ()

Description:

Obtains a singleton Screen instance.

Returns:

Returns the Screen instance.

GetInstance() [2/5]

  1. static [ThemeManager]($api-api-SmartVision-Devices-OHOS-ThemeManager.md)& OHOS::ThemeManager::GetInstance ()

Description:

Obtains the singleton instance of the ThemeManager class.

Returns:

Returns the singleton instance of the ThemeManager class.

GetInstance() [3/5]

  1. static [RootView]($api-api-SmartVision-Devices-OHOS-RootView.md)* OHOS::RootView::GetInstance ()

Description:

Obtains a singleton RootView instance.

Returns:

Returns the singleton RootView instance.

GetInstance() [4/5]

  1. static [UIDumpDomTree]($api-api-SmartVision-Devices-OHOS-UIDumpDomTree.md)* OHOS::UIDumpDomTree::GetInstance ()

Description:

Obtains an instance in singleton pattern.

Returns:

Returns the function instance for exporting DOM information.

GetInstance() [5/5]

  1. static [AnimatorManager]($api-api-SmartVision-Devices-OHOS-AnimatorManager.md)* OHOS::AnimatorManager::GetInstance ()

Description:

Obtains the AnimatorManager instance.

Returns:

Returns the AnimatorManager instance.

GetInterval()

  1. virtual uint16_t OHOS::UIRepeatButton::GetInterval () const

Description:

Obtains the interval between two consecutive click events.

Returns:

Returns the interval between two consecutive click events.

GetKeyId()

  1. uint16_t OHOS::KeyEvent::GetKeyId () const

Description:

Obtains the key ID.

GetKnobStyle() [1/2]

  1. const [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::UISlider::GetKnobStyle () const

Description:

Obtains the knob style.

Returns:

Returns the knob style.

GetKnobStyle() [2/2]

  1. int64_t OHOS::UISlider::GetKnobStyle (uint8_t key) const

Description:

Obtains the value of a knob style.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetKnobWidth()

  1. int16_t OHOS::UISlider::GetKnobWidth ()

Description:

Obtains the knob width.

Returns:

Returns the knob width.

See also:

SetKnobWidth

GetLabelPosition()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::UILabelButton::GetLabelPosition () const

Description:

Obtains the position of this label relative to the button holding it.

Returns:

Returns the position of this label.

GetLabelStyle() [1/4]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetLabelStyle ()

Description:

Obtains the style of this label.

Returns:

Returns the label style.

GetLabelStyle() [2/4]

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetLabelStyle ()

Description:

Obtains the label style.

Returns:

Returns the label style.

GetLabelStyle() [3/4]

  1. const [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::UILabelButton::GetLabelStyle () const

Description:

Obtains the style of this label.

Returns:

Returns the label style.

GetLabelStyle() [4/4]

  1. int64_t OHOS::UILabelButton::GetLabelStyle (uint8_t key) const

Description:

Obtains the value of a style of this label.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetLastPoint()

  1. const [Point]($api-api-SmartVision-Devices-OHOS-Point.md)& OHOS::DragEvent::GetLastPoint () const

Description:

Obtains the coordinates of the last position in the drag event.

Returns:

Returns the coordinates of the last position.

GetLastRun()

  1. uint32_t OHOS::Task::GetLastRun () const

Description:

Obtains the end time of this task.

Returns:

Returns the end time.

GetLatestIndex()

  1. uint16_t OHOS::UIChartDataSerial::GetLatestIndex () const

Description:

Obtains the index of the frontmost point (the latest added or modified data point in a data set).

Returns:

Returns the index of the frontmost point.

GetLeft()

  1. int16_t OHOS::Rect::GetLeft () const

Description:

Obtains the left boundary coordinate of the rectangle.

Returns:

Returns the left boundary coordinate.

GetLibDsc()

  1. std::string OHOS::GetLibDsc ()

Description:

Obtains the library description of the graphics module.

Returns:

Returns the library description of the graphics module.

GetLineBreakMode()

  1. uint8_t OHOS::UILabel::GetLineBreakMode () const

Description:

Obtains the line break mode of this text.

Returns:

Returns the line break mode.

GetLineColor()

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIChartDataSerial::GetLineColor () const

Description:

Obtains the polyline color of the data set in a line chart.

Returns:

Returns the polyline color of the data set.

See also:

SetLineColor

GetLoopState()

  1. bool OHOS::UIList::GetLoopState () const

Description:

Checks whether this list is in a loop state.

Returns:

Returns if the list is in the loop state; returns false if the list is in the common state.

GetMainStyle()

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetMainStyle ()

Description:

Obtains the basic style.

Returns:

Returns the basic style.

GetMaskedRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIView::GetMaskedRect () const

Description:

Obtains the valid absolute rectangle area of the view. The valid area refers to the area where the view can be displayed. Generally, the valid area is the same as the visible view area, but they may be different in the grid layout.

Returns:

Returns the valid absolute rectangle area.

GetMaxScrollDistance()

  1. uint16_t OHOS::UIAbstractScroll::GetMaxScrollDistance () const

Description:

Obtains the maximum scroll distance after a finger lifts the screen.

Returns:

Returns the maximum scroll distance. The default value is 0, indicating that the scroll distance is not limited.

GetMixColor()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::GetMixColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) c1, [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) c2, uint8_t mix )

Description:

Mixes two colors (color 1 and color 2) based on a specified opacity.

Parameters:

Name

Description

c1 Indicates color 1.
c2 Indicates color 2.
mix Indicates the alpha, that is, how opaque each pixel is.

Returns:

Returns the color data after mixing.

GetName()

  1. const char* OHOS::UIRadioButton::GetName () const

Description:

Obtains the name of this radio button.

Returns:

Returns the name of this radio button, which is a defined character string. Radio buttons sharing the same name are in the same batch from which only one can be selected.

GetNextSibling()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIView::GetNextSibling () const

Description:

Obtains the next sibling view of the view.

Returns:

Returns the pointer to the next sibling view.

GetOnClickListener()

  1. [OnClickListener]($api-api-SmartVision-Devices-OHOS-UIView-OnClickListener.md)*& OHOS::UIView::GetOnClickListener ()

Description:

Obtains the click event listener for the view.

Returns:

Returns the click event listener.

GetOnDragListener()

  1. [OnDragListener]($api-api-SmartVision-Devices-OHOS-UIView-OnDragListener.md)*& OHOS::UIView::GetOnDragListener ()

Description:

Obtains the drag event listener for the view.

Returns:

Returns the drag event listener.

GetOnLongPressListener()

  1. [OnLongPressListener]($api-api-SmartVision-Devices-OHOS-UIView-OnLongPressListener.md)*& OHOS::UIView::GetOnLongPressListener ()

Description:

Obtains the long-press event listener for the view.

Returns:

Returns the long-press event listener.

GetOnSwipeListener()

  1. [OnSwipeListener]($api-api-SmartVision-Devices-OHOS-UISwipeView-OnSwipeListener.md)*& OHOS::UISwipeView::GetOnSwipeListener ()

Description:

Obtains the listener set for swipe events.

Returns:

Returns the swipe event listener.

GetOpacity() [1/2]

  1. uint8_t OHOS::UIDigitalClock::GetOpacity () const

Description:

Obtains the opacity of this digital clock.

Returns:

Returns the opacity of this digital clock, within [0, 255].

GetOpacity() [2/2]

  1. uint8_t OHOS::Paint::GetOpacity () const

Description:

Obtains the opacity.

Returns:

Returns the opacity.

See also:

SetOpacity

GetOrigRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIView::GetOrigRect () const

Description:

Obtains the absolute rectangle area of the view.

Returns:

Returns the absolute rectangle area.

GetParent()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIView::GetParent () const

Description:

Obtains the parent view of the view.

Returns:

Returns the pointer to the parent view.

GetPath() [1/2]

  1. const char* OHOS::Image::GetPath () const

Description:

Obtains the image path in binary.

Returns:

Returns the pointer to the image path.

GetPath() [2/2]

  1. const char* OHOS::UIImageView::GetPath () const

Description:

获取图片路径

Returns:

图片路径

GetPeakData()

  1. int16_t OHOS::UIChartDataSerial::GetPeakData () const

Description:

Obtains the Y value of the top point in a data set.

The Y value is the data added by users, not the pixel coordinate.

Returns:

Returns the Y value.

GetPeakIndex()

  1. uint16_t OHOS::UIChartDataSerial::GetPeakIndex () const

Description:

Obtains the index of the top point in the data set.

Returns:

Returns the index of the top point. If there are multiple top points, the first one is returned.

GetPeriod()

  1. uint32_t OHOS::Task::GetPeriod () const

Description:

Obtains the running period of this task.

Returns:

Returns the running period.

GetPickerBackgroundStyle() [1/2]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetPickerBackgroundStyle ()

Description:

Obtains the background style of this picker.

Returns:

Returns the background style of this picker.

GetPickerBackgroundStyle() [2/2]

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetPickerBackgroundStyle ()

Description:

Obtains the picker background style.

Returns:

Returns the picker background style.

GetPickerHighlightStyle() [1/2]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetPickerHighlightStyle ()

Description:

Obtains the highlight style of this picker.

Returns:

Returns the highlight style of this picker.

GetPickerHighlightStyle() [2/2]

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetPickerHighlightStyle ()

Description:

Obtains the picker highlight style.

Returns:

Returns the picker highlight style.

GetPivot()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::TransformMap::GetPivot () const

Description:

Obtains the pivot for the rotation or scaling operation.

Returns:

Returns the pivot.

GetPoint()

  1. bool OHOS::UIChartDataSerial::GetPoint (uint16_t index, [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & point )

Description:

Obtains the coordinates in the chart for a data point in the data set.

Parameters:

Name

Description

index Indicates the index of the data point to obtain.
point Indicates the obtained coordinates. If the data set is not added to the chart, the original value of the data point is printed.

Returns:

Returns true if the operation is successful; returns false otherwise.

GetPolygon()

  1. [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) OHOS::TransformMap::GetPolygon () const

Description:

Obtains the polygon after rectangle transformation.

Returns:

Returns the polygon.

GetPreLastPoint()

  1. const [Point]($api-api-SmartVision-Devices-OHOS-Point.md)& OHOS::DragEvent::GetPreLastPoint () const

Description:

Obtains the coordinates of the stay position before the last position in the drag event.

Returns:

Returns the coordinates of the stay position.

GetProgressBackgroundStyle() [1/2]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetProgressBackgroundStyle ()

Description:

Obtains the background style of this progress bar.

Returns:

Returns the background style of this progress bar.

GetProgressBackgroundStyle() [2/2]

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetProgressBackgroundStyle ()

Description:

Obtains the progress background style.

Returns:

Returns the progress background style.

GetProgressForegroundStyle() [1/2]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetProgressForegroundStyle ()

Description:

Obtains the foreground style of this progress bar.

Returns:

Returns the foreground style of this progress bar.

GetProgressForegroundStyle() [2/2]

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetProgressForegroundStyle ()

Description:

Obtains the progress foreground style.

Returns:

Returns the progress foreground style.

GetRadius()

  1. uint16_t OHOS::UICircleProgress::GetRadius () const

Description:

Obtains the outer radius of this circular progress bar.

Returns:

Returns the outer radius.

See also:

SetRadius

GetRangeMax()

  1. int16_t OHOS::UIAbstractProgress::GetRangeMax () const

Description:

Obtains the maximum value of this progress bar.

Returns:

Returns the maximum value of this progress bar.

See also:

SetRange | GetRangeMin

GetRangeMin()

  1. int16_t OHOS::UIAbstractProgress::GetRangeMin () const

Description:

Obtains the minimum value of this progress bar.

Returns:

Returns the minimum value of this progress bar.

See also:

SetRange | GetRangeMax

GetRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIView::GetRect () const

Description:

Obtains the absolute rectangle area of the view. When the view has deformation such as rotation, the rectangle area is the intersection set of the absolute rectangle area and deformation matrix.

Returns:

Returns the absolute rectangle area.

GetRelativeRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIView::GetRelativeRect () const

Description:

Obtains the rectangular area of the view relative to the parent view, that is, the rectangular area relative to the coordinates of the parent view.

Returns:

Returns the rectangle area relative to the parent view.

GetRepeatTimes()

  1. uint32_t OHOS::UIImageAnimatorView::GetRepeatTimes () const

Description:

Obtains the playback times.

Returns:

Returns the playback times.

See also:

SetRepeatTimes

GetRight()

  1. int16_t OHOS::Rect::GetRight () const

Description:

Obtains the right boundary coordinate of the rectangle.

Returns:

Returns the right boundary coordinate.

GetRollStartPos()

  1. int16_t OHOS::UILabel::GetRollStartPos () const

Description:

Obtains the position where this text starts to roll.

Returns:

Returns the position where this text starts to roll.

GetRunTime()

  1. uint32_t OHOS::Animator::GetRunTime () const

Description:

Obtains the running time of this animator.

Returns:

Returns the running time.

See also:

SetRunTime

GetScrollState() [1/2]

  1. uint8_t OHOS::UIScrollView::OnScrollListener::GetScrollState () const

Description:

Obtains the scroll state of this view.

Returns:

Returns the scroll state, either SCROLL_STATE_STOP or SCROLL_STATE_MOVE.

GetScrollState() [2/2]

  1. uint8_t OHOS::ListScrollListener::GetScrollState () const

Description:

Obtains the scroll state of this list.

Returns:

Returns the scroll state, either SCROLL_STATE_STOP or SCROLL_STATE_MOVE.

GetSelected()

  1. uint16_t OHOS::UIPicker::GetSelected () const

Description:

Obtains the index of the item currently selected in the picker.

Returns:

Returns the index.

GetSelectHour()

  1. const char* OHOS::UITimePicker::GetSelectHour () const

Description:

Obtains the hour currently selected in the time picker.

Returns:

Returns a string representing the selected hour, for example, 10.

GetSelectMinute()

  1. const char* OHOS::UITimePicker::GetSelectMinute () const

Description:

Obtains the minute currently selected in the time picker.

Returns:

Returns a string representing the selected minute, for example, 12.

GetSelectSecond()

  1. const char* OHOS::UITimePicker::GetSelectSecond () const

Description:

Obtains the second currently selected in the time picker.

Returns:

Returns a string representing the selected second, for example, 50.

GetSelectValue()

  1. const char* OHOS::UITimePicker::GetSelectValue ()

Description:

Obtains the time currently selected in the time picker.

Returns:

Returns a string representing the selected time. The time is in the format of “hour:minute:second”, for example, 10:12:50. The second is optional and depends on the setting of EnableSecond.

GetSelectView()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UIList::GetSelectView ()

Description:

Obtains the child view being selected at the preset position.

Returns:

Returns the child view if available; returns NULL if no child view is selected or no position is set.

GetSize()

  1. uint32_t OHOS::Rect::GetSize () const

Description:

Obtains the area of a rectangle.

Returns:

Returns the area of the rectangle.

GetSliderKnobStyle() [1/2]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetSliderKnobStyle ()

Description:

Obtains the style of this slider knob.

Returns:

Returns the style of this slider knob.

GetSliderKnobStyle() [2/2]

  1. static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetSliderKnobStyle ()

Description:

Obtains the slider knob style.

Returns:

Returns the slider knob style.

GetSrcType() [1/2]

  1. uint8_t OHOS::Image::GetSrcType () const

Description:

Obtains the image type.

Returns:

Returns IMG_SRC_VARIABLE for image information in an array; returns IMG_SRC_FILE for an image path in binary.

GetSrcType() [2/2]

  1. uint8_t OHOS::UIImageView::GetSrcType () const

Description:

获取图片类型

Returns:

图片类型

GetStartAngle()

  1. int16_t OHOS::UICircleProgress::GetStartAngle () const

Description:

Obtains the start angle.

Returns:

Returns the start angle.

See also:

SetStartAngle

GetStartIndex()

  1. uint16_t OHOS::UIList::GetStartIndex () const

Description:

Obtains the start index of this list. The default value is 0.

Returns:

Returns the start index.

GetStartPoint()

  1. const [Point]($api-api-SmartVision-Devices-OHOS-Point.md)& OHOS::DragEvent::GetStartPoint () const

Description:

Obtains the start coordinates in the drag event.

Returns:

Returns the start coordinates.

GetStartPosition()

  1. const [Point]($api-api-SmartVision-Devices-OHOS-Point.md)& OHOS::UICanvas::GetStartPosition () const

Description:

Obtains the coordinates of the start point of a line.

Returns:

Returns the coordinates of the start point.

See also:

SetStartPosition

GetState() [1/6]

  1. uint16_t OHOS::KeyEvent::GetState () const

Description:

Obtains the key state.

GetState() [2/6]

  1. uint16_t OHOS::VirtualDeviceEvent::GetState () const

Description:

Obtains the state of the virtual event.

Returns:

Returns the state.

GetState() [3/6]

  1. bool OHOS::UIToggleButton::GetState () const

Description:

Obtains the state of this toggle button.

Returns:

Returns true if the image for On is displayed; returns false if the image is displayed for Off.

GetState() [4/6]

  1. uint8_t OHOS::Animator::GetState () const

Description:

Obtains the current state of this animator.

Returns:

Returns the current animator state, which can be START, STOP, or PAUSE.

See also:

SetState

GetState() [5/6]

  1. [UICheckBoxState]($api-api-SmartVision-Devices-Graphic.md#ga15a3f0302aded0e4d1584ddc6002335d) OHOS::UICheckBox::GetState () const

Description:

Obtains the state of this check box.

Returns:

Returns the state of this check box, as defined in UICheckBoxState.

GetState() [6/6]

  1. uint8_t OHOS::UIImageAnimatorView::GetState () const

Description:

Obtains the current state of this animator.

Returns:

Returns the current state, which can be START, STOP, or PAUSE. For details, see Animator.

GetStep()

  1. uint16_t OHOS::UIAbstractProgress::GetStep () const

Description:

Obtains the current step of this progress bar.

Returns:

Returns the current step.

See also:

SetStep

GetStrokeColor()

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Paint::GetStrokeColor () const

Description:

Obtains the color of a line or border.

Returns:

Returns the line color if a line is drawn or the border color if a closed graph is drawn.

See also:

SetStrokeWidth

GetStrokeWidth()

  1. uint16_t OHOS::Paint::GetStrokeWidth () const

Description:

Obtains the width of a line or border.

Returns:

Returns the line width if a line is drawn or the border width if a closed graph is drawn.

See also:

SetStrokeWidth

GetStyle() [1/5]

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::TextAdapter::GetStyle ()

Description:

Obtains the UILabel adapter style.

Returns:

Returns the UILabel adapter style.

GetStyle() [2/5]

  1. [PaintStyle]($api-api-SmartVision-Devices-Graphic.md#ga548320a469b7862fa416af062cad5d7a) OHOS::Paint::GetStyle () const

Description:

Obtains the paint style of a closed graph.

Returns:

Returns the paint style. For details, see PaintStyle.

See also:

SetStyle

GetStyle() [3/5]

  1. int64_t OHOS::Style::GetStyle (uint8_t key) const

Description:

Obtains the value of a style.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetStyle() [4/5]

  1. virtual int64_t OHOS::UIView::GetStyle (uint8_t key) const

Description:

Obtains the value of a style.

Reimplemented in OHOS::UIButton.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetStyle() [5/5]

  1. int64_t OHOS::UIButton::GetStyle (uint8_t key) const

Description:

Obtains the value of a style.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

key Indicates the key of the style.

Returns:

Returns the value of the style.

GetStyleConst()

  1. const [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::UIView::GetStyleConst () const

Description:

Obtains the view style. This function applies to scenarios where the style does not need to be modified, which saves memory.

Returns:

Returns the view style.

GetStyleForState()

  1. int64_t OHOS::UIButton::GetStyleForState (uint8_t key, [ButtonState]($api-api-SmartVision-Devices-Graphic.md#ga188dd55c17ee44be27fa80543f13f729) state ) const

Description:

Obtains the style of a button in a specific state.

Parameters:

Name

Description

key Indicates the key of the style.
state Indicates the button state, as enumerated in ButtonState.

Returns:

Returns the style of the button in the specific state.

GetSurface()

  1. [Surface]($api-api-SmartVision-Devices-OHOS-Surface.md)* OHOS::UISurfaceView::GetSurface () const

Description:

Obtains the surface, which should be used together with the camera and video modules.

Returns:

Returns the surface.

GetSwipeACCLevel()

  1. uint8_t OHOS::UIAbstractScroll::GetSwipeACCLevel () const

Description:

Obtains the compensation distance after a finger lifts the screen.

Returns:

Returns the compensation distance.

GetTargetView() [1/2]

  1. virtual void OHOS::UIView::GetTargetView (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & point, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) ** last )

Description:

Obtains the top-level view based on specified coordinates.

Reimplemented in OHOS::UIViewGroup.

Parameters:

Name

Description

point Indicates the coordinates to specify.
last Indicates the double pointer to the view that contains the specified coordinates.

GetTargetView() [2/2]

  1. virtual void OHOS::UIViewGroup::GetTargetView (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & point, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) ** last )

Description:

Obtains the target child view that is visible and can respond to touch events based on given coordinates.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

point Indicates the given coordinates.
last Indicates the double pointer to the target view. nullptr indicates that the target view is not available.

GetText() [1/4]

  1. const char* OHOS::UILabelButton::GetText () const

Description:

Obtains the text of this label button.

Returns:

Returns the text.

GetText() [2/4]

  1. const char* OHOS::Text::GetText () const

Description:

Obtains the content of this text.

Returns:

Returns the text content.

GetText() [3/4]

  1. const char* OHOS::UIArcLabel::GetText () const

Description:

Obtains the text of this arc label.

Returns:

Returns the text.

GetText() [4/4]

  1. const char* OHOS::UILabel::GetText () const

Description:

Obtains the text of this label.

Returns:

Returns the text.

GetTextColor()

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UILabel::GetTextColor () const

Description:

Obtains the color of this text.

Returns:

Returns the text color.

GetTextHeight()

  1. uint16_t OHOS::UILabel::GetTextHeight ()

Description:

Obtains the height of this text.

Returns:

Returns the text height.

GetTextRotateDegree() [1/2]

  1. uint16_t OHOS::Text::GetTextRotateDegree () const

Description:

Obtains the number of text rotation degrees.

Returns:

Returns the number of text rotation degrees.

GetTextRotateDegree() [2/2]

  1. uint16_t OHOS::UILabel::GetTextRotateDegree () const

Description:

Obtains the number of text rotation degrees.

Returns:

Returns the number of text rotation degrees.

GetTextRotation() [1/2]

  1. LabelRotateDegree OHOS::Text::GetTextRotation () const

Description:

Obtains the clockwise rotation degree of this text.

Returns:

Returns the rotation degree, as defined in LabelRotateDegree.

GetTextRotation() [2/2]

  1. LabelRotateDegree OHOS::UILabel::GetTextRotation () const

Description:

Obtains the clockwise rotation degree of this text.

Returns:

Returns the rotation degree, as defined in LabelRotateDegree.

GetTextSize()

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::Text::GetTextSize () const

Description:

Obtains the size of this text.

Returns:

Returns the text size.

GetTextWidth()

  1. uint16_t OHOS::UILabel::GetTextWidth ()

Description:

Obtains the width of this text.

Returns:

Returns the text width.

GetTime()

  1. uint32_t OHOS::Animator::GetTime () const

Description:

Obtains the total duration of this animator.

Returns:

Returns the total duration.

See also:

SetTime

GetTimeOfPause()

  1. uint16_t OHOS::UIImageAnimatorView::GetTimeOfPause () const

Description:

Obtains the interval between two playbacks of an infinitely repeated animator.

Returns:

Returns the interval between two playbacks, in milliseconds.

See also:

SetTimeOfPause

GetTimeOfUpdate()

  1. uint16_t OHOS::UIImageAnimatorView::GetTimeOfUpdate () const

Description:

Obtains the speed of this animator.

Returns:

Returns the interval for updating images, in milliseconds.

See also:

SetTimeOfUpdate

GetTimeStamp()

  1. const TimeType& OHOS::Event::GetTimeStamp () const

Description:

Obtains the timestamp when an event occurs.

Returns:

Returns the timestamp.

GetTop()

  1. int16_t OHOS::Rect::GetTop () const

Description:

Obtains the top boundary coordinate of the rectangle.

Returns:

Returns the top boundary coordinate.

GetTopPointStyle()

  1. const [PointStyle]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial-PointStyle.md)& OHOS::UIChartDataSerial::GetTopPointStyle () const

Description:

Obtains the style of the top point of a polyline.

Returns:

Returns the style of the point. For details, see PointStyle.

GetTouchListener()

  1. [OnTouchListener]($api-api-SmartVision-Devices-OHOS-UIView-OnTouchListener.md)*& OHOS::UIView::GetTouchListener ()

Description:

Obtains the touch event listener for the view.

Returns:

Returns the touch event listener.

GetTransformAlgorithm()

  1. TransformAlgorithm OHOS::UIImageView::GetTransformAlgorithm () const

Description:

Obtains the algorithm used for image rotation and scaling.

Returns:

Returns the image transform algorithm, as defined in TransformAlgorithm.

GetTransformMap()

  1. [TransformMap]($api-api-SmartVision-Devices-OHOS-TransformMap.md)& OHOS::UIView::GetTransformMap ()

Description:

Obtains an affine transformation matrix.

Returns:

Returns the transform matrix.

GetType()

  1. uint16_t OHOS::VirtualDeviceEvent::GetType () const

Description:

Obtains the type of the virtual device.

Returns:

Returns the type.

GetValidHeight()

  1. int16_t OHOS::UIBoxProgress::GetValidHeight () const

Description:

Obtains the actual height of this progress bar.

Returns:

Returns the actual height of this progress bar.

See also:

SetValidHeight

GetValidWidth()

  1. int16_t OHOS::UIBoxProgress::GetValidWidth () const

Description:

Obtains the actual width of this progress bar.

Returns:

Returns the actual width of this progress bar.

See also:

SetValidWidth

GetValleyData()

  1. int16_t OHOS::UIChartDataSerial::GetValleyData () const

Description:

Obtains the Y value of the bottom point in a data set.

The Y value is the data added by users, not the pixel coordinate.

Returns:

Returns the Y value.

GetValleyIndex()

  1. uint16_t OHOS::UIChartDataSerial::GetValleyIndex () const

Description:

Obtains the index of the bottom point in a data set.

Returns:

Returns the index of the bottom point. If there are multiple bottom points, the first one is returned.

GetValue()

  1. int16_t OHOS::UIAbstractProgress::GetValue () const

Description:

Obtains the current value of this progress bar.

Returns:

Returns the current value of this progress bar.

See also:

SetValue

GetVerAlign() [1/2]

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::Text::GetVerAlign () const

Description:

Obtains the vertical alignment mode.

Returns:

Returns the vertical alignment mode.

GetVerAlign() [2/2]

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::UILabel::GetVerAlign () const

Description:

Obtains the vertical alignment mode.

Returns:

Returns the vertical alignment mode.

GetVersion()

  1. std::string OHOS::GetVersion ()

Description:

Obtains the version number of the graphics module.

Returns:

Returns the version number of the graphics module.

GetVertexNum()

  1. uint8_t OHOS::Polygon::GetVertexNum () const

Description:

Obtains the number of vertices of the polygon.

Returns:

Returns the number of vertices.

GetVerticalScrollState()

  1. bool OHOS::UIScrollView::GetVerticalScrollState () const

Description:

Checks whether a vertical scroll is enabled.

Returns:

Returns true if a vertical scroll is enabled, returns false otherwise.

GetView() [1/2]

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::TextAdapter::GetView ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * inView, int16_t index )

Description:

Obtains a UILabel instance to convert adapter data into another UILabel instance.

Implements OHOS::AbstractAdapter.

Parameters:

Name

Description

inView Indicates the pointer to the reusable instance. If this parameter is not NULL, a reusable UILabel instance is available. In this case, this function does not need to create a new UILabel instance, just resusing the instance specified by inView to update the inView data. If this parameter is NULL, there is no resuable UIView instance. In this case, this function needs to create a new UILabel instance.
index Indicates the adapter data index.

Returns:

Returns the address of the UILabel instance constructed by the adapter.

GetView() [2/2]

  1. virtual [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::AbstractAdapter::GetView ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * inView, int16_t index )

Description:

Obtains a UIView instance to convert adapter data into another UIView instance.

Implemented in OHOS::TextAdapter.

Parameters:

Name

Description

inView Indicates the pointer to the reusable instance. If this parameter is not NULL, a reusable UIView instance is available. In this case, this function does not need to create a new UIView instance, just reusing the instance specified by inView to update the inView data. If this parameter is NULL, there is no reusable UIView instance. In this case, this function needs to create a new UIView instance.
index Indicates the adapter data index.

Returns:

UIView Returns the pointer to the UIView instance constructed by the adapter.

GetViewByIndex()

  1. [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UISwipeView::GetViewByIndex (uint16_t index) const

Description:

Obtains a view based on its index.

Parameters:

Name

Description

Indicates the index of a view.

Returns:

Returns the view.

GetViewId()

  1. const char* OHOS::UIView::GetViewId () const

Description:

Obtains the view ID.

Returns:

Returns the pointer to the view ID.

GetViewIndex()

  1. int16_t OHOS::UIView::GetViewIndex () const

Description:

Obtains the view index.

Returns:

Returns the view index.

GetViewType() [1/31]

  1. virtual UIViewType OHOS::UIView::GetViewType () const

Description:

Obtains the view type.

Reimplemented in OHOS::UIChart, OHOS::UICanvas, OHOS::UIAnalogClock, OHOS::UIList, OHOS::UIScrollView, OHOS::RootView, OHOS::UICheckBox, OHOS::UILabel, OHOS::UIAbstractClock, OHOS::UISwipeView, OHOS::UIDialog, OHOS::UIBoxProgress, OHOS::UIImageAnimatorView, OHOS::UIButton, OHOS::UIRadioButton, OHOS::UIArcLabel, OHOS::UILabelButton, OHOS::UIToggleButton, OHOS::UIRepeatButton, OHOS::UISlider, OHOS::UIViewGroup, OHOS::UIAbstractScroll, OHOS::UIAxis, OHOS::UICircleProgress, OHOS::UIDigitalClock, OHOS::UITextureMapper, OHOS::UIAbstractProgress, OHOS::UIImageView, OHOS::UIPicker, and OHOS::UITimePicker.

Returns:

Returns the view type.

GetViewType() [2/31]

  1. UIViewType OHOS::UITimePicker::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type. For details, see UIViewType.

GetViewType() [3/31]

  1. UIViewType OHOS::UIImageView::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UITextureMapper.

Returns:

Returns UI_IMAGE_VIEW, as defined in UIViewType.

GetViewType() [4/31]

  1. UIViewType OHOS::UIPicker::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type. For details, see UIViewType.

GetViewType() [5/31]

  1. UIViewType OHOS::UIAbstractProgress::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIBoxProgress, OHOS::UISlider, and OHOS::UICircleProgress.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [6/31]

  1. UIViewType OHOS::UIDigitalClock::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIAbstractClock.

Returns:

Returns UI_DIGITAL_CLOCK, as defined in UIViewType.

GetViewType() [7/31]

  1. UIViewType OHOS::UIAxis::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type. For details, see UIViewType.

GetViewType() [8/31]

  1. UIViewType OHOS::UIAbstractScroll::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIList, OHOS::UIScrollView, and OHOS::UISwipeView.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [9/31]

  1. UIViewType OHOS::UITextureMapper::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIImageView.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [10/31]

  1. UIViewType OHOS::UICircleProgress::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIAbstractProgress.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [11/31]

  1. UIViewType OHOS::UIViewGroup::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns UI_VIEW_GROUP, as defined in UIViewType.

GetViewType() [12/31]

  1. UIViewType OHOS::UIRepeatButton::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UIButton.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [13/31]

  1. UIViewType OHOS::UISlider::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIBoxProgress.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [14/31]

  1. UIViewType OHOS::UIToggleButton::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UICheckBox.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [15/31]

  1. UIViewType OHOS::UILabelButton::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIButton.

Returns:

Returns UI_LABEL_BUTTON, as defined in UIViewType.

GetViewType() [16/31]

  1. UIViewType OHOS::UIArcLabel::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns UI_ARC_LABEL, as defined in {link UIViewType}.

GetViewType() [17/31]

  1. UIViewType OHOS::UIRadioButton::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UICheckBox.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [18/31]

  1. UIViewType OHOS::UIButton::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UILabelButton, and OHOS::UIRepeatButton.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [19/31]

  1. UIViewType OHOS::UIImageAnimatorView::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [20/31]

  1. UIViewType OHOS::UIBoxProgress::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIAbstractProgress.

Reimplemented in OHOS::UISlider.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [21/31]

  1. UIViewType OHOS::UIDialog::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [22/31]

  1. UIViewType OHOS::UISwipeView::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UIAbstractScroll.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [23/31]

  1. UIViewType OHOS::UIAbstractClock::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIAnalogClock, and OHOS::UIDigitalClock.

Returns:

Returns UI_ABSTRACT_CLOCK, as defined in UIViewType.

GetViewType() [24/31]

  1. UIViewType OHOS::UILabel::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns UI_LABEL, as defined in UIViewType.

GetViewType() [25/31]

  1. UIViewType OHOS::UICheckBox::GetViewType () const

Description:

Obtains the component type.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIRadioButton, and OHOS::UIToggleButton.

Returns:

Returns the component type, as defined in UIViewType.

GetViewType() [26/31]

  1. UIViewType OHOS::RootView::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns UI_ROOT_VIEW, as defined in UIViewType.

GetViewType() [27/31]

  1. UIViewType OHOS::UIScrollView::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIAbstractScroll.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [28/31]

  1. UIViewType OHOS::UIList::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIAbstractScroll.

Returns:

Returns the view type, as defined in UIViewType.

GetViewType() [29/31]

  1. UIViewType OHOS::UIAnalogClock::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIAbstractClock.

Returns:

Returns UI_ANALOG_CLOCK, as defined in UIViewType.

GetViewType() [30/31]

  1. UIViewType OHOS::UICanvas::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type. For details, see UIViewType.

GetViewType() [31/31]

  1. UIViewType OHOS::UIChart::GetViewType () const

Description:

Obtains the view type.

Reimplemented from OHOS::UIView.

Returns:

Returns the view type. For details, see UIViewType.

GetVisibleRect()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIView::GetVisibleRect () const

Description:

Obtains the visible absolute rectangle area of the view.

Returns:

Returns the visible absolute rectangle area.

GetWidth() [1/7]

  1. uint16_t OHOS::Screen::GetWidth ()

Description:

Obtains the width of this screen.

Returns:

Returns the screen width.

GetWidth() [2/7]

  1. virtual int16_t OHOS::UIView::GetWidth ()

Description:

Obtains the width for the view.

Reimplemented in OHOS::UIButton, OHOS::UILabel, OHOS::UIArcLabel, and OHOS::UIImageView.

Returns:

Returns the view width.

GetWidth() [3/7]

  1. int16_t OHOS::Rect::GetWidth () const

Description:

Obtains the rectangle width.

Returns:

Returns the rectangle width.

GetWidth() [4/7]

  1. int16_t OHOS::UIImageView::GetWidth ()

Description:

Obtains the width of this image view.

Reimplemented from OHOS::UIView.

Returns:

Returns the width of this image view.

GetWidth() [5/7]

  1. int16_t OHOS::UIArcLabel::GetWidth ()

Description:

Obtains the width of this arc text.

Reimplemented from OHOS::UIView.

Returns:

Returns the width of this arc text.

GetWidth() [6/7]

  1. int16_t OHOS::UILabel::GetWidth ()

Description:

Obtains the width of this label.

Reimplemented from OHOS::UIView.

Returns:

Returns the label width.

GetWidth() [7/7]

  1. int16_t OHOS::UIButton::GetWidth ()

Description:

Obtains the width of this image.

Reimplemented from OHOS::UIView.

Returns:

Returns the image width.

GetWorkMode()

  1. virtual [WorkMode]($api-api-SmartVision-Devices-Graphic.md#ga19db90932bc71e6bbced6ccf2935ac98) OHOS::UIAbstractClock::GetWorkMode () const

Description:

Obtains the working mode of this clock.

Returns:

Returns the working mode, as defined in WorkMode.

GetX() [1/2]

  1. int16_t OHOS::Rect::GetX () const

Description:

Obtains the left boundary coordinate of the rectangle.

Returns:

Returns the left boundary coordinate.

GetX() [2/2]

  1. int16_t OHOS::UIView::GetX () const

Description:

Obtains the x-coordinate for the view.

Returns:

Returns the x-coordinate.

GetXAxis()

  1. [UIXAxis]($api-api-SmartVision-Devices-OHOS-UIXAxis.md)& OHOS::UIChart::GetXAxis ()

Description:

Obtains the x-axis instance.

Returns:

Returns the x-axis instance.

GetY() [1/2]

  1. int16_t OHOS::Rect::GetY () const

Description:

Obtains the top boundary coordinate of the rectangle.

Returns:

Returns the top boundary coordinate.

GetY() [2/2]

  1. int16_t OHOS::UIView::GetY () const

Description:

Obtains the y-coordinate for the view.

Returns:

Returns the y-coordinate.

GetYAxis()

  1. [UIYAxis]($api-api-SmartVision-Devices-OHOS-UIYAxis.md)& OHOS::UIChart::GetYAxis ()

Description:

Obtains the y-axis instance.

Returns:

Returns the y-axis instance.

Gray()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Gray ()

Description:

Obtains the color data of gray.

Returns:

Returns the color data.

Green()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Green ()

Description:

Obtains the color data of green.

Returns:

Returns the color data.

GridLayout()

  1. OHOS::GridLayout::GridLayout ()

Description:

A default constructor used to create a GridLayout instance.

Hand()

  1. OHOS::UIAnalogClock::Hand::Hand ()

Description:

A default constructor used to create a Hand instance.

Head()

  1. [ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)<T>* [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Head () const

Description:

Obtains the head node address of a linked list.

Returns:

Returns the head node address.

HidePoint()

  1. void OHOS::UIChartDataSerial::HidePoint (uint16_t index, uint16_t count )

Description:

Hides some points in the data set.

This function applies only to line charts. After the points are hidden, the line connected by the points is not displayed. The top and bottom points may appear in the hidden region. If this method is enabled, you are not advised to enable the display of the top and bottom points.

Parameters:

Name

Description

index Indicates the point from which the hide starts.
count Indicates the number of points to hide.

Image()

  1. OHOS::Image::Image ()

Description:

A constructor used to create an Image instance. You can use this constructor when a component requires a map.

ImageCacheFree()

  1. void OHOS::ImageCacheFree ([ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) & info)

Description:

Releases the image cache memory.

Parameters:

Name

Description

info Indicates the image information. For details, see ImageInfo.

ImageCacheMalloc()

  1. void* OHOS::ImageCacheMalloc ([ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) & info)

Description:

Applies for the image cache memory. You can customize the memory area when loading image resources.

Parameters:

Name

Description

info Indicates the image information. For details, see ImageInfo.

IncOneSecond()

  1. void OHOS::UIAbstractClock::IncOneSecond ()

Description:

Increases the time by one second.

Insert() [1/3]

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Insert ([ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)< T > * node, T data )

Description:

Inserts data before a specified node, which follows the inserted data node.

Parameters:

Name

Description

node Indicates the pointer to the node holding the inserted data.
data Indicates the data to insert.

Insert() [2/3]

  1. virtual void OHOS::UIViewGroup::Insert ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * prevView, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * insertView )

Description:

Inserts a new child view behind the current one.

Reimplemented in OHOS::UISwipeView.

Parameters:

Name

Description

prevView Indicates the pointer to the current child view, previous to the new child view to insert.
view Indicates the pointer to the new child view to insert.

Insert() [3/3]

  1. void OHOS::UISwipeView::Insert ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * prevView, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * insertView )

Description:

Inserts a view.

Reimplemented from OHOS::UIViewGroup.

Parameters:

Name

Description

prevView Indicates the previous view.
insertView Indicates the view to insert.

Intersect() [1/2]

  1. bool OHOS::Intersect (const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & a, const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & b, [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & out )

Description:

Checks whether line segment a and line segment b intersect, and returns the intersection point (if available).

Parameters:

Name

Description

a Indicates line segment a.
b Indicates line segment b.
out Indicates the intersection point.

Returns:

Returns true if the two line segments intersect; returns false otherwise.

Intersect() [2/2]

  1. bool OHOS::Rect::Intersect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect1, const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect2 )

Description:

Checks whether two rectangles intersect.

Parameters:

Name

Description

rect1 Indicates the first rectangle to check.
rect2 Indicates the second rectangle to check.

Returns:

Returns true if the two rectangles intersect; returns false otherwise.

Invalidate()

  1. void OHOS::UIView::Invalidate ()

Description:

Refreshes the invalidated area of the view.

InvalidateRect()

  1. void OHOS::UIView::InvalidateRect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Refreshes a view in a specified invalidated area.

Parameters:

Name

Description

invalidatedArea Indicates the area to refresh.

Inverse()

  1. [Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T > [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::Inverse

Description:

Obtains the inverse matrix.

Returns:

Returns the inverse matrix.

IsContains() [1/3]

  1. bool OHOS::Rect::IsContains (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & point) const

Description:

Checks whether the rectangle contains a coordinate point.

Parameters:

Name

Description

point Indicates the coordinate point.

Returns:

Returns true if the input coordinate point is contained; returns false otherwise.

IsContains() [2/3]

  1. bool OHOS::Rect::IsContains (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & other) const

Description:

Checks whether the rectangle contains another rectangle.

Parameters:

Name

Description

other Indicates the rectangle to be used for check.

Returns:

Returns true if the input rectangle is contained; returns false otherwise.

IsContains() [3/3]

  1. bool OHOS::Rect::IsContains (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & point) const

Description:

Checks whether the rectangle contains a coordinate point.

Parameters:

Name

Description

point Indicates the coordinate point.

Returns:

Returns true if the input coordinate point is contained; returns false otherwise.

IsDraggable()

  1. bool OHOS::UIView::IsDraggable () const

Description:

Checks whether the view is draggable.

Returns:

Returns true if the view is draggable; returns false otherwise.

IsDragParentInstead()

  1. bool OHOS::UIView::IsDragParentInstead () const

Description:

Obtains whether the view transfers a drag event to the parent view for processing.

Returns:

Returns true if the view transfers the event to the parent view for processing; returns false otherwise.

IsEmpty()

  1. bool [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::IsEmpty () const

Description:

Checks whether a linked list is empty.

Returns:

Returns true if the linked list is empty; returns false otherwise.

IsExpandHeight()

  1. bool OHOS::Text::IsExpandHeight () const

Description:

Checks whether the component height adapts to this text.

Returns:

Returns true if the component height adapts to this text; returns false otherwise.

IsExpandWidth()

  1. bool OHOS::Text::IsExpandWidth () const

Description:

Checks whether the component width adapts to this text.

Returns:

Returns true if the component width adapts to this text; returns false otherwise.

IsExtends()

  1. bool OHOS::Rect::IsExtends (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & other) const

Description:

Checks whether the rectangle is adjacent to another rectangle horizontally or vertically.

Parameters:

Name

Description

other Indicates the rectangle to be used for check.

Returns:

Returns true if the rectangle is adjacent to the input rectangle; returns false otherwise.

IsGradient()

  1. bool OHOS::UIChartDataSerial::IsGradient () const

Description:

Checks whether a polyline has a fill color.

Returns:

Returns true if there is a fill color; returns false otherwise.

IsIntersect() [1/2]

  1. bool OHOS::IsIntersect (const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & a, const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & b )

Description:

Chekcs whether line segment a and line segment b intersect.

Parameters:

Name

Description

a Indicates line segment a.
b Indicates line segment b.

Returns:

Returns true if the two line segments intersect; returns false otherwise.

IsIntersect() [2/2]

  1. bool OHOS::Rect::IsIntersect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & other) const

Description:

Checks whether the rectangle intersects with another rectangle.

Parameters:

Name

Description

other Indicates the rectangle to be used for check.

Returns:

Returns true if the two rectangles intersect; returns false otherwise.

IsInvalid()

  1. bool OHOS::TransformMap::IsInvalid () const

Description:

Checks whether the TransformMap instance is invalid. When the vertices are all 0, the TransformMap is invalid.

Returns:

Returns true if TransformMap is invalid; returns false otherwise.

IsRepeat() [1/2]

  1. bool OHOS::UIImageAnimatorView::IsRepeat () const

Description:

Checks whether this animator is played for infinite times.

Returns:

Returns true if this animator is played for infinite times, returns false if the animator is played a specified number of times.

See also:

SetRepeat

IsRepeat() [2/2]

  1. bool OHOS::Animator::IsRepeat () const

Description:

Checks whether this animator is repeated.

Returns:

Returns true if the animator is repeated; returns false if the animator is played once.

IsReverse()

  1. bool OHOS::UIImageAnimatorView::IsReverse () const

Description:

Obtains the playback sequence of this animator.

Returns:

Returns true if a reverse playback is performed; returns false if a forward playback is performed.

See also:

SetReverse

IsSizeFixed()

  1. bool OHOS::UIImageAnimatorView::IsSizeFixed () const

Description:

Checks whether the image size is fixed to the view size.

Returns:

Returns true if the image size is fixed to the view size; returns false if the image size is set independently.

See also:

SetSizeFixed

IsSmooth()

  1. bool OHOS::UIChartDataSerial::IsSmooth () const

Description:

Checks whether smoothing is performed on a polyline.

Returns:

Returns true if smooth processing is performed on the polyline; returns false otherwise.

IsTouchable()

  1. bool OHOS::UIView::IsTouchable () const

Description:

Checks whether the view is touchable.

Returns:

Returns true if the view is touchable; returns false otherwise.

IsViewGroup()

  1. bool OHOS::UIView::IsViewGroup () const

Description:

Checks whether the view is a container view.

Returns:

Returns true if the view is a container view; returns false otherwise.

IsVisible()

  1. bool OHOS::UIView::IsVisible () const

Description:

Checks whether the view is visible.

Returns:

Returns true if the view is visible; returns false otherwise.

Join()

  1. void OHOS::Rect::Join (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect1, const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect2 )

Description:

Obtains the minimum rectangle that contains another two rectangles.

Parameters:

Name

Description

rect1 Indicates the first rectangle to contain.
rect2 Indicates the second rectangle to contain.

KeyEvent()

  1. OHOS::KeyEvent::KeyEvent (uint16_t keyId, uint16_t state )

Description:

A constructor used to create a KeyEvent instance.

Parameters:

Name

Description

keyId Indicates the key ID.
state Indicates the key state.

Layout()

  1. OHOS::Layout::Layout ()

Description:

A default constructor used to create a Layout instance.

LayoutBottomOfParent()

  1. void OHOS::UIView::LayoutBottomOfParent (int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code])

Description:

Lays out the view on the bottom of the parent view.

Parameters:

Name

Description

offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the top, and a negative number indicates the offset to the bottom.

LayoutBottomToSibling()

  1. void OHOS::UIView::LayoutBottomToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Lays out the view on the below of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the bottom, and a negative number indicates the offset to the top.

LayoutCenterOfParent()

  1. void OHOS::UIView::LayoutCenterOfParent (int16_t xOffSet = [/topic/body/section/screen/code
  2. {""}) 0 (code], int16_t yOffset = [/topic/body/section/screen/code
  3. {""}) 0 (code] )

Description:

Lays out the view in the center of the parent view.

Parameters:

Name

Description

xOffset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the right, and a negative number indicates the offset to the left.
yOffset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the bottom, and a negative number indicates the offset to the top.

LayoutChildren() [1/3]

  1. virtual void OHOS::GridLayout::LayoutChildren (bool needInvalidate = [/topic/body/section/screen/code
  2. {""}) false (code])

Description:

Lays out all child views according to the preset arrangement mode.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

needInvalidate Specifies whether to refresh the invalidated area after the layout is complete. Value true means to refresh the invalidated area after the layout is complete, and false means the opposite.

LayoutChildren() [2/3]

  1. virtual void OHOS::FlexLayout::LayoutChildren (bool needInvalidate = [/topic/body/section/screen/code
  2. {""}) false (code])

Description:

Lays out all child views according to the preset arrangement mode.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

needInvalidate Specifies whether to refresh the invalidated area after the layout is complete. Value true means to refresh the invalidated area after the layout is complete, and false means the opposite.

LayoutChildren() [3/3]

  1. virtual void OHOS::UIView::LayoutChildren (bool neeInvalidate = [/topic/body/section/screen/code
  2. {""}) false (code])

Description:

Lays out all child views according to the preset arrangement mode.

Reimplemented in OHOS::FlexLayout, and OHOS::GridLayout.

Parameters:

Name

Description

needInvalidate Specifies whether to refresh the invalidated area after the layout is complete. Value true means to refresh the invalidated area after the layout is complete, and false means the opposite.

LayoutLeftOfParent()

  1. void OHOS::UIView::LayoutLeftOfParent (int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code])

Description:

Lays out the view on the left of the parent view.

Parameters:

Name

Description

offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the right, and a negative number indicates the offset to the left.

LayoutLeftToSibling()

  1. void OHOS::UIView::LayoutLeftToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Lays out the view on the left of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the left, and a negative number indicates the offset to the right.

LayoutRightOfParent()

  1. void OHOS::UIView::LayoutRightOfParent (int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code])

Description:

Lays out the view on the right of the parent view.

Parameters:

Name

Description

offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the left, and a negative number indicates the offset to the right.

LayoutRightToSibling()

  1. void OHOS::UIView::LayoutRightToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Lays out the view on the right of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the x-axis after the view is placed. A positive number indicates the offset to the right, and a negative number indicates the offset to the left.

LayoutTopOfParent()

  1. void OHOS::UIView::LayoutTopOfParent (int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code])

Description:

Lays out the view on the top of the parent view.

Parameters:

Name

Description

offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the bottom, and a negative number indicates the offset to the top.

LayoutTopToSibling()

  1. void OHOS::UIView::LayoutTopToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
  2. {""}) 0 (code] )

Description:

Lays out the view on the above of a sibling view.

Parameters:

Name

Description

id Indicates the pointer to the ID of the sibling view.
offset Indicates the offset added to the y-axis after the view is placed. A positive number indicates the offset to the top, and a negative number indicates the offset to the bottom.

Lime()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Lime ()

Description:

Obtains the color data of lime.

Returns:

Returns the color data.

Line() [1/3]

  1. OHOS::Line::Line ()

Description:

The default constructor used to create a Line instance.

Line() [2/3]

  1. OHOS::Line::Line (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & a, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & b )

Description:

A constructor used to create a Line instance.

Parameters:

Name

Description

a Indicates the start point of the line.
b Indicates the end point of the line.

Line() [3/3]

  1. OHOS::Line::Line (int16_t x1, int16_t y1, int16_t x2, int16_t y2 )

Description:

A constructor used to create a Line instance.

Parameters:

Name

Description

x1 Indicates the X coordinate of the line’s start point.
y1 Indicates the Y coordinate of the line’s start point.
x2 Indicates the X coordinate of the line’s end point.
y2 Indicates the Y coordinate of the line’s end point.

LinearEaseNone()

  1. static int16_t OHOS::EasingEquation::LinearEaseNone (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Displays no linear easing effects.

t is the equation for a linear easing. The animation progresses at a constant velocity towards the end.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

LinearEaseIn | LinearEaseOut | LinearEaseInOut

List()

  1. [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::[List]($api-api-SmartVision-Devices-OHOS-List-T.md) ()

Description:

A default constructor used to create a List instance. The initial size is 0.

ListScrollListener()

  1. OHOS::ListScrollListener::ListScrollListener ()

Description:

A constructor used to create a ListScrollListener instance with the default state SCROLL_STATE_STOP.

LongPressEvent()

  1. OHOS::LongPressEvent::LongPressEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos, const TimeType & timeStamp )

Description:

A constructor used to create a LongPressEvent instance.

Parameters:

Name

Description

pos Indicates the position where the long-press event occurs.
timeStamp Indicates the time stamp when the long-press event occurs.

Magenta()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Magenta ()

Description:

Obtains the color data of magenta.

Returns:

Returns the color data.

MakeAABB()

  1. [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::Polygon::MakeAABB () const

Description:

Obtains the minimum rectangle that can contain the polygon. All vertices of the polygon are inside this rectangle.

Returns:

Returns the minimum rectangle that contains the polygon.

Maroon()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Maroon ()

Description:

Obtains the color data of maroon.

Returns:

Returns the color data.

Matrix3() [1/2]

  1. [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::[Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)

Description:

Defines a Matrix3 instance and initializes the 3 x 3 matrix data.

Matrix3() [2/2]

  1. [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::[Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md) (T m00, T m01, T m02, T m10, T m11, T m12, T m20, T m21, T m22 )

Description:

Defines a Matrix3 instance and initializes the 3 x 3 matrix data.

Parameters:

Name

Description

m00 Indicates the element in row 1 and column 1 of the matrix.
m01 Indicates the element in row 1 and column 2 of the matrix.
m02 Indicates the element in row 1 and column 3 of the matrix.
m10 Indicates the element in row 2 and column 1 of the matrix.
m11 Indicates the element in row 2 and column 2 of the matrix.
m12 Indicates the element in row 2 and column 3 of the matrix.
m20 Indicates the element in row 3 and column 1 of the matrix.
m21 Indicates the element in row 3 and column 2 of the matrix.
m22 Indicates the element in row 3 and column 3 of the matrix.

ModifyPoint()

  1. bool OHOS::UIChartDataSerial::ModifyPoint (uint16_t index, const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & point )

Description:

Modifies the value of a data point in the data set.

Parameters:

Name

Description

index Indicates the index of the data point to modify.
point Indicates the new value of the data point.

Returns:

Returns true if the operation is successful; returns false otherwise.

MoveChildByOffset() [1/4]

  1. void OHOS::UIAbstractScroll::MoveChildByOffset (int16_t offsetX, int16_t offsetY )

Description:

Moves the position of all child views.

Reimplemented from OHOS::UIViewGroup.

Reimplemented in OHOS::UISwipeView, and OHOS::UIList.

Parameters:

Name

Description

offsetX Indicates the offset distance by which a child view is moved on the x-axis.
offsetY Indicates the offset distance by which a child view is moved on the y-axis.

MoveChildByOffset() [2/4]

  1. virtual void OHOS::UIViewGroup::MoveChildByOffset (int16_t x, int16_t y )

Description:

Moves all child views.

Reimplemented in OHOS::UISwipeView, OHOS::UIList, and OHOS::UIAbstractScroll.

Parameters:

Name

Description

x Indicates the offset distance by which this view group is moved on the x-axis.
y Indicates the offset distance by which this view group is moved on the y-axis.

MoveChildByOffset() [3/4]

  1. virtual void OHOS::UIList::MoveChildByOffset (int16_t x, int16_t y )

Description:

Moves the position of all child views.

Reimplemented from OHOS::UIAbstractScroll.

Parameters:

Name

Description

offsetX Indicates the offset distance by which a child view is moved on the x-axis.
offsetY Indicates the offset distance by which a child view is moved on the y-axis.

MoveChildByOffset() [4/4]

  1. void OHOS::UISwipeView::MoveChildByOffset (int16_t offsetX, int16_t offsetY )

Description:

Moves the position of all child views.

Reimplemented from OHOS::UIAbstractScroll.

Parameters:

Name

Description

offsetX Indicates the offset distance by which a child view is moved on the x-axis.
offsetY Indicates the offset distance by which a child view is moved on the y-axis.

Navy()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Navy ()

Description:

Obtains the color data of navy.

Returns:

Returns the color data.

Next()

  1. [ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)<T>* [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Next (const [ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)< T > * node) const

Description:

Obtains the address of the node following the specified node.

Parameters:

Name

Description

node Indicates the pointer to the data node in the linked list.

Returns:

Returns the address of the node following node.

Olive()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Olive ()

Description:

Obtains the color data of olive.

Returns:

Returns the color data.

OnAnimatorStop() [1/2]

  1. virtual void OHOS::UIImageAnimatorView::AnimatorStopListener::OnAnimatorStop ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view)

Description:

Called when this animator stops.

You need to inherit from the AnimatorStopListener class and implement this function.

Parameters:

Name

Description

view Indicates the instance of this view.

OnAnimatorStop() [2/2]

  1. virtual void OHOS::UITextureMapper::AnimatorStopListener::OnAnimatorStop ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view)

Description:

Called when this animator stops. This is a pure virtual function, which needs your inheritance and implementation.

Parameters:

Name

Description

view Indicates the instance of this view.

OnCancel()

  1. virtual bool OHOS::UIView::OnTouchListener::OnCancel ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [CancelEvent]($api-api-SmartVision-Devices-OHOS-CancelEvent.md) & event )

Description:

Called when a click event on a view is canceled.

Parameters:

Name

Description

view Indicates the view on which a click event is canceled.
event Indicates the cancel event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnCancelEvent() [1/2]

  1. virtual void OHOS::UIView::OnCancelEvent (const [CancelEvent]($api-api-SmartVision-Devices-OHOS-CancelEvent.md) & event)

Description:

Called when a click event on the view is canceled.

Reimplemented in OHOS::UIButton.

Parameters:

Name

Description

event Indicates the cancel event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnCancelEvent() [2/2]

  1. void OHOS::UIButton::OnCancelEvent (const [CancelEvent]($api-api-SmartVision-Devices-OHOS-CancelEvent.md) & event)

Description:

Executes the cancel event action.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

[in] event The cancel event.

OnChange() [1/2]

  1. virtual void OHOS::UISlider::UISliderEventListener::OnChange (int16_t value)

Description:

Called when the slider is dragged or clicked. This is a virtual function, which needs your implementation.

Parameters:

Name

Description

value Indicates the current value of the slider.

OnChange() [2/2]

  1. virtual bool OHOS::UICheckBox::OnChangeListener::OnChange ([UICheckBoxState]($api-api-SmartVision-Devices-Graphic.md#ga15a3f0302aded0e4d1584ddc6002335d) state)

Description:

Called when the state of this check box is switched. This is a virtual function, which needs your implementation.

Parameters:

Name

Description

state Indicates the current state of this check box. For details, see UICheckBoxState.

OnChildChanged()

  1. virtual void OHOS::UIViewGroup::OnChildChanged ()

Description:

Performs operations needed after a child view is added or removed.

OnClick()

  1. virtual bool OHOS::UIView::OnClickListener::OnClick ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event )

Description:

Called when a view is clicked.

Parameters:

Name

Description

view Indicates the view clicked.
event Indicates the click event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnClickEvent() [1/5]

  1. virtual void OHOS::UIView::OnClickEvent (const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event)

Description:

Called when the view is clicked.

Reimplemented in OHOS::UISlider, OHOS::UICheckBox, OHOS::UIRadioButton, and OHOS::UIRepeatButton.

Parameters:

Name

Description

event Indicates the click event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnClickEvent() [2/5]

  1. void OHOS::UIRepeatButton::OnClickEvent (const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event)

Description:

The action of click event.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

[in] event click event.

OnClickEvent() [3/5]

  1. void OHOS::UIRadioButton::OnClickEvent (const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event)

Description:

Executes the click event action OnClickEvent will reverse the selected state of checkbox. Example: If the check box is selected, the checkbox status is changed to Unselected after the click action is taken.

Reimplemented from OHOS::UICheckBox.

Parameters:

Name

Description

[in] event The event that passed when OnClickEvent is invoked.

OnClickEvent() [4/5]

  1. void OHOS::UICheckBox::OnClickEvent (const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event)

Description:

Executes the click event action OnClickEvent will reverse the selected state of checkbox. Example: If the check box is selected, the checkbox status is changed to Unselected after the click action is taken.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIRadioButton.

Parameters:

Name

Description

[in] event The event that passed when OnClickEvent is invoked.

OnClickEvent() [5/5]

  1. void OHOS::UISlider::OnClickEvent (const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event)

Description:

Called when the view is clicked.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the click event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDrag()

  1. virtual bool OHOS::UIView::OnDragListener::OnDrag ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event )

Description:

Called when a view is being dragged.

Parameters:

Name

Description

view Indicates the view dragged.
event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEnd()

  1. virtual bool OHOS::UIView::OnDragListener::OnDragEnd ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event )

Description:

Called when a view stops dragging.

Parameters:

Name

Description

view Indicates the view dragged.
event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEndEvent() [1/5]

  1. virtual bool OHOS::UIView::OnDragEndEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view stops dragging.

Reimplemented in OHOS::UISwipeView, OHOS::UISlider, OHOS::UIList, and OHOS::UIScrollView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEndEvent() [2/5]

  1. bool OHOS::UIScrollView::OnDragEndEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view stops dragging.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEndEvent() [3/5]

  1. bool OHOS::UIList::OnDragEndEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view stops dragging.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEndEvent() [4/5]

  1. bool OHOS::UISlider::OnDragEndEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view stops dragging.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEndEvent() [5/5]

  1. bool OHOS::UISwipeView::OnDragEndEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view stops dragging.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEvent() [1/5]

  1. virtual bool OHOS::UIView::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view is being dragged.

Reimplemented in OHOS::UISwipeView, OHOS::UISlider, OHOS::UIList, and OHOS::UIScrollView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEvent() [2/5]

  1. bool OHOS::UIScrollView::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view is being dragged.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEvent() [3/5]

  1. bool OHOS::UIList::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view is being dragged.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEvent() [4/5]

  1. bool OHOS::UISlider::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view is being dragged.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragEvent() [5/5]

  1. void OHOS::UISwipeView::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

revice drag event, Switch to specified view when drag

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event The drag event

OnDragStart()

  1. virtual bool OHOS::UIView::OnDragListener::OnDragStart ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event )

Description:

Called when a view starts to drag.

Parameters:

Name

Description

view Indicates the view dragged.
event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDragStartEvent()

  1. virtual bool OHOS::UIView::OnDragStartEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)

Description:

Called when the view starts to drag.

Parameters:

Name

Description

event Indicates the drag event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnDraw() [1/15]

  1. virtual void OHOS::UIView::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented in OHOS::UIChart, OHOS::UICanvas, OHOS::UIArcLabel, OHOS::UIAnalogClock, OHOS::UIBoxProgress, OHOS::UISlider, OHOS::UISurfaceView, OHOS::UICheckBox, OHOS::UILabel, OHOS::UIAxis, OHOS::UIImageView, OHOS::UIButton, OHOS::UICircleProgress, and OHOS::UILabelButton.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [2/15]

  1. void OHOS::UILabelButton::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Draws a label button.

Reimplemented from OHOS::UIButton.

OnDraw() [3/15]

  1. void OHOS::UICircleProgress::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [4/15]

  1. void OHOS::UIButton::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Executes the draw action.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UILabelButton.

Parameters:

Name

Description

[in] invalidatedArea The rectangle to draw, with coordinates relative to this drawable..

OnDraw() [5/15]

  1. void OHOS::UIImageView::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Draws this image view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [6/15]

  1. void OHOS::UIAxis::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [7/15]

  1. void OHOS::UILabel::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Draws this label.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [8/15]

  1. void OHOS::UICheckBox::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Executes the draw action Ondraw invokes the rendering function provided by the underlying layer to draw pictures based on the selected status of the checkbox.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

[in] invalidatedArea The invalidated area.

OnDraw() [9/15]

  1. void OHOS::UISurfaceView::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when this view is drawn.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [10/15]

  1. void OHOS::UISlider::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented from OHOS::UIBoxProgress.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [11/15]

  1. void OHOS::UIBoxProgress::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UISlider.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [12/15]

  1. void OHOS::UIAnalogClock::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Draws an analog clock.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [13/15]

  1. virtual void OHOS::UIArcLabel::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Draws an arc text.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [14/15]

  1. virtual void OHOS::UICanvas::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnDraw() [15/15]

  1. void OHOS::UIChart::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called when a view is drawn.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnFPSChanged()

  1. virtual void OHOS::SysInfo::OnFPSChangedListener::OnFPSChanged (float newFPS)

Description:

Called when the FPS data changes.

Parameters:

Name

Description

newFPS Indicates the FPS data.

OnFPSChangedListener()

  1. OHOS::SysInfo::OnFPSChangedListener::OnFPSChangedListener ()

Description:

A constructor used to create an OnFPSChangedListener instance with the default sampling type FPS_CT_FIXED_TIME.

OnItemSelected()

  1. virtual void OHOS::ListScrollListener::OnItemSelected (int16_t index, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view )

Description:

Called when a new child view is selected at the preset position as this list scrolls. For details about how to set the position, see SetSelectPosition.

Parameters:

Name

Description

index Indicates the index of the child view being selected at the preset position. This parameter should be set to NULL_SELECT_INDEX if no child view is selected or no position is preset.
view Indicates the child view being selected at the preset position. This parameter should be set to NULL if no child view is selected or no position is preset.

OnKeyAct()

  1. virtual bool OHOS::RootView::OnKeyActListener::OnKeyAct ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [KeyEvent]($api-api-SmartVision-Devices-OHOS-KeyEvent.md) & event )

Description:

Responds to a physical key event.

Parameters:

Name

Description

view Indicates the view displayed upon a physical key event.
event Indicates the physical key event to respond to.

Returns:

Returns true if the view is normally displayed upon a physical key event; returns false otherwise.

OnKeyEvent()

  1. virtual void OHOS::RootView::OnKeyEvent (const [KeyEvent]($api-api-SmartVision-Devices-OHOS-KeyEvent.md) & event)

Description:

Executes a physical key event.

Parameters:

Name

Description

event Indicates the physical key event to execute.

OnLongPress()

  1. virtual bool OHOS::UIView::OnLongPressListener::OnLongPress ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [LongPressEvent]($api-api-SmartVision-Devices-OHOS-LongPressEvent.md) & event )

Description:

Called when a view is long pressed.

Parameters:

Name

Description

view Indicates the view long pressed.
event Indicates the long-press event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnLongPressEvent() [1/2]

  1. virtual bool OHOS::UIView::OnLongPressEvent (const [LongPressEvent]($api-api-SmartVision-Devices-OHOS-LongPressEvent.md) & event)

Description:

Called when the view is long pressed.

Reimplemented in OHOS::UIRepeatButton.

Parameters:

Name

Description

event Indicates the long-press event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnLongPressEvent() [2/2]

  1. void OHOS::UIRepeatButton::OnLongPressEvent (const [LongPressEvent]($api-api-SmartVision-Devices-OHOS-LongPressEvent.md) & event)

Description:

The action of long press event.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

[in] event long press event.

OnPickerStoped()

  1. virtual void OHOS::UIPicker::SelectedListener::OnPickerStoped ([UIPicker]($api-api-SmartVision-Devices-OHOS-UIPicker.md) & picker)

Description:

Called when an item is selected after sliding stops. This function is implemented by applications.

Parameters:

Name

Description

picker Indicates the picker instance.

OnPostDraw() [1/3]

  1. virtual void OHOS::UIView::OnPostDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called after a view is drawn.

Reimplemented in OHOS::UIAnalogClock, and OHOS::UIScrollView.

Parameters:

Name

Description

invalidatedArea Indicates the area in which the view is drawn.

OnPostDraw() [2/3]

  1. void OHOS::UIScrollView::OnPostDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called after a view is drawn.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area in which the view is drawn.

OnPostDraw() [3/3]

  1. virtual void OHOS::UIAnalogClock::OnPostDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Performs the operations needed after the drawing.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

OnPreDraw() [1/13]

  1. virtual bool OHOS::UIView::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

Reimplemented in OHOS::UIChart, OHOS::UISlider, OHOS::UISurfaceView, OHOS::UICheckBox, OHOS::UILabel, OHOS::UIAxis, OHOS::UIDialog, OHOS::UIImageView, OHOS::UIButton, OHOS::UIRadioButton, OHOS::UICircleProgress, and OHOS::UIPicker.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPreDraw() [2/13]

  1. bool OHOS::UIPicker::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPreDraw() [3/13]

  1. bool OHOS::UICircleProgress::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPreDraw() [4/13]

  1. bool OHOS::UIRadioButton::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Do something before draw, this function will be invoked mainly to check if this view need to cover invalidate area so render manager can decide which layer to draw firstly.

Reimplemented from OHOS::UICheckBox.

Parameters:

Name

Description

[in] invalidate area.

Returns:

True if need cover.

OnPreDraw() [5/13]

  1. bool OHOS::UIButton::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Do something before draw, this function will be invoked mainly to check if this view need to cover invalidate area so render manager can decide which layer to draw firstly.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

[in] invalidate area.

Returns:

True if need cover.

OnPreDraw() [6/13]

  1. bool OHOS::UIImageView::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Checks whether this image view needs to be covered to optimize the drawing process.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if this image view needs to be covered; returns false otherwise.

OnPreDraw() [7/13]

  1. bool OHOS::UIDialog::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Checks whether this label needs to be covered before drawing it.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if this label needs to be covered; returns false otherwise.

OnPreDraw() [8/13]

  1. bool OHOS::UIAxis::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPreDraw() [9/13]

  1. bool OHOS::UILabel::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Checks whether this label needs to be covered before drawing it.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if this label needs to be covered; returns false otherwise.

OnPreDraw() [10/13]

  1. bool OHOS::UICheckBox::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Do something before draw, this function will be invoked mainly to check if this view need to cover invalidate area so render manager can decide which layer to draw firstly.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIRadioButton.

Parameters:

Name

Description

[in] invalidate area.

Returns:

True if need cover.

OnPreDraw() [11/13]

  1. bool OHOS::UISurfaceView::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before this view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so that the drawing process is optimized.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPreDraw() [12/13]

  1. bool OHOS::UISlider::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPreDraw() [13/13]

  1. bool OHOS::UIChart::OnPreDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)

Description:

Called before a view is drawn. This function is used to check whether the parent view of this view needs to be redrawn so as to optimize the drawing process.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

invalidatedArea Indicates the area to draw.

Returns:

Returns true if the parent view needs to be redrawn; returns false otherwise.

OnPress()

  1. virtual bool OHOS::UIView::OnTouchListener::OnPress ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [PressEvent]($api-api-SmartVision-Devices-OHOS-PressEvent.md) & event )

Description:

Called when a view is pressed.

Parameters:

Name

Description

view Indicates the view pressed.
event Indicates the press event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnPressEvent() [1/4]

  1. virtual void OHOS::UIView::OnPressEvent (const [PressEvent]($api-api-SmartVision-Devices-OHOS-PressEvent.md) & event)

Description:

Called when the view is pressed.

Reimplemented in OHOS::UIList, OHOS::UIScrollView, and OHOS::UIButton.

Parameters:

Name

Description

event Indicates the press event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnPressEvent() [2/4]

  1. void OHOS::UIButton::OnPressEvent (const [PressEvent]($api-api-SmartVision-Devices-OHOS-PressEvent.md) & event)

Description:

Executes the press event action.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

[in] event The press event, contain press position.

OnPressEvent() [3/4]

  1. void OHOS::UIScrollView::OnPressEvent (const [PressEvent]($api-api-SmartVision-Devices-OHOS-PressEvent.md) & event)

Description:

Called when the view is pressed.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the press event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnPressEvent() [4/4]

  1. void OHOS::UIList::OnPressEvent (const [PressEvent]($api-api-SmartVision-Devices-OHOS-PressEvent.md) & event)

Description:

Called when the view is pressed.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

event Indicates the press event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnRelease() [1/2]

  1. virtual void OHOS::UISlider::UISliderEventListener::OnRelease (int16_t value)

Description:

Called when the slider is released. This is a virtual function, which needs your implementation.

Parameters:

Name

Description

value Indicates the current value of the slider.

OnRelease() [2/2]

  1. virtual bool OHOS::UIView::OnTouchListener::OnRelease ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, const [ReleaseEvent]($api-api-SmartVision-Devices-OHOS-ReleaseEvent.md) & event )

Description:

Called when a view is released.

Parameters:

Name

Description

view Indicates the view released.
event Indicates the release event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnReleaseEvent() [1/3]

  1. virtual void OHOS::UIView::OnReleaseEvent (const [ReleaseEvent]($api-api-SmartVision-Devices-OHOS-ReleaseEvent.md) & event)

Description:

Called when the view is released.

Reimplemented in OHOS::UIButton, and OHOS::UIRepeatButton.

Parameters:

Name

Description

event Indicates the release event.

Returns:

Returns true if the event is consumed; returns false otherwise. (If an event is consumed, it is not transferred to the parent view. If an event is not consumed, it is transferred to the parent view after local processing is complete.)

OnReleaseEvent() [2/3]

  1. void OHOS::UIRepeatButton::OnReleaseEvent (const [ReleaseEvent]($api-api-SmartVision-Devices-OHOS-ReleaseEvent.md) & event)

Description:

The action of release event.

Reimplemented from OHOS::UIButton.

Parameters:

Name

Description

[in] event release event.

OnReleaseEvent() [3/3]

  1. void OHOS::UIButton::OnReleaseEvent (const [ReleaseEvent]($api-api-SmartVision-Devices-OHOS-ReleaseEvent.md) & event)

Description:

Executes the press release event action.

Reimplemented from OHOS::UIView.

Reimplemented in OHOS::UIRepeatButton.

Parameters:

Name

Description

[in] event The press release event.

OnScrollEnd() [1/2]

  1. virtual void OHOS::UIScrollView::OnScrollListener::OnScrollEnd ()

Description:

Called when a scroll ends.

OnScrollEnd() [2/2]

  1. virtual void OHOS::ListScrollListener::OnScrollEnd (int16_t index, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view )

Description:

Called when a scroll ends.

Parameters:

Name

Description

index Indicates the index of the child view being selected at the preset position. This parameter should be set to NULL_SELECT_INDEX if no child view is selected or no position is preset.
view Indicates the child view being selected at the preset position. This parameter should be set to NULL if no child view is selected or no position is preset.

OnScrollListener()

  1. OHOS::UIScrollView::OnScrollListener::OnScrollListener ()

Description:

A constructor used to create an OnScrollListener instance with the default scroll state SCROLL_STATE_STOP.

OnScrollStart() [1/2]

  1. virtual void OHOS::UIScrollView::OnScrollListener::OnScrollStart ()

Description:

Called when a scroll starts.

OnScrollStart() [2/2]

  1. virtual void OHOS::ListScrollListener::OnScrollStart (int16_t index, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view )

Description:

Called when a scroll starts.

Parameters:

Name

Description

index Indicates the index of the child view being selected at the preset position. This parameter should be set to NULL_SELECT_INDEX if no child view is selected or no position is preset.
view Indicates the child view being selected at the preset position. This parameter should be set to NULL if no child view is selected or no position is preset.

OnStop()

  1. virtual void OHOS::AnimatorCallback::OnStop ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view)

Description:

Called when an animator stops. This is a pure virtual function, which needs your inheritance and implementation.

Parameters:

Name

Description

view Indicates the UIView instance, which is added from the constructor of the Animator class.

OnTimePickerStoped()

  1. virtual void OHOS::UITimePicker::SelectedListener::OnTimePickerStoped ([UITimePicker]($api-api-SmartVision-Devices-OHOS-UITimePicker.md) & picker)

Description:

Called when an item is selected after sliding stops. This function is implemented by applications.

Parameters:

Name

Description

picker Indicates the time picker instance.

OnVirtualDeviceEvent() [1/2]

  1. virtual void OHOS::RootView::OnVirtualDeviceEvent (const [VirtualDeviceEvent]($api-api-SmartVision-Devices-OHOS-VirtualDeviceEvent.md) & event)

Description:

Executes an input event triggered by a virtual device.

Parameters:

Name

Description

event Indicates the input event to respond to.

OnVirtualDeviceEvent() [2/2]

  1. virtual bool OHOS::RootView::OnVirtualDeviceEventListener::OnVirtualDeviceEvent ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) & view, [VirtualDeviceEvent]($api-api-SmartVision-Devices-OHOS-VirtualDeviceEvent.md) event )

Description:

Responds to an input event triggered by a virtual device.

Parameters:

Name

Description

view Indicates the view displayed upon an input event triggered by a virtual device.
event Indicates the input event to respond to.

Returns:

Returns true if this view is normally displayed upon an input event triggered by a virtual device; returns false otherwise.

operator delete()

  1. void OHOS::HeapBase::operator delete (void * p)

Description:

Overrides the delete function.

Parameters:

Name

Description

p Indicates the pointer to the memory to be released.

operator new()

  1. void* OHOS::HeapBase::operator new (size_t size)

Description:

Overrides the new function.

Parameters:

Name

Description

size Indicates the size of the memory to be allocated.

operator[]() [1/2]

  1. [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)<int16_t>& OHOS::Line::operator[] (uint8_t index)

Description:

Obtains the start or end point of the line based on the value of index.

Parameters:

Name

Description

index Indicates the start or end point to obtain. The value 0 indicates that the start point is to be obtained, and 1 indicates that the end point is to be obtained.

Returns:

Returns the start or end point of the line.

operator[]() [2/2]

  1. const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)<int16_t> OHOS::Line::operator[] (uint8_t index) const

Description:

Obtains the start or end point of the line based on the value of index.

Parameters:

Name

Description

index Indicates the start or end point to obtain. The value 0 indicates that the start point is to be obtained, and 1 indicates that the end point is to be obtained.

Returns:

Returns the start or end point of the line.

Orange()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Orange ()

Description:

Obtains the color data of orange.

Returns:

Returns the color data.

Paint()

  1. OHOS::Paint::Paint ()

Description:

A constructor used to create a Paint instance.

Pause() [1/2]

  1. void OHOS::Animator::Pause ()

Description:

Pauses this animator.

See also:

Resume

Pause() [2/2]

  1. void OHOS::UIImageAnimatorView::Pause ()

Description:

Pauses this animator at the current image.

See also:

Resume

Polygon() [1/3]

  1. OHOS::Polygon::Polygon ()

Description:

The default constructor used to create a Polygon instance.

Polygon() [2/3]

  1. OHOS::Polygon::Polygon (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect)

Description:

A constructor used to construct a Polygon instance based on a rectangle.

Parameters:

Name

Description

rect Indicates the rectangle used to construct the polygon.

Polygon() [3/3]

  1. OHOS::Polygon::Polygon (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > * vertexes, const uint8_t vertexNum )

Description:

A constructor used to create a Polygon instance based on the vertex coordinates and the number of coordinates.

The number of vertex coordinates cannot exceed the value of MAX_VERTEX_NUM.

Parameters:

Name

Description

vertexes Indicates the pointer to the vertex coordinates.
vertexNum Indicates the number of vertices.

PopBack()

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::PopBack ()

Description:

Pops up a data record at the end of a linked list.

PopFront()

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::PopFront ()

Description:

Pops up a data record at the start of a linked list.

PressEvent()

  1. OHOS::PressEvent::PressEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)

Description:

A constructor used to create a PressEvent instance.

Parameters:

Name

Description

pos Indicates the position where the press event occurs.

Purple()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Purple ()

Description:

Obtains the color data of purple.

Returns:

Returns the color data.

PushBack()

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::PushBack (T data)

Description:

Inserts data at the end of a linked list.

Parameters:

Name

Description

data Indicates the data to insert.

PushFront()

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::PushFront (T data)

Description:

Inserts data at the start of a linked list.

Parameters:

Name

Description

data Indicates the data to insert.

QuadEaseIn()

  1. static int16_t OHOS::EasingEquation::QuadEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in shaping like a quadratic curve.

t^2 is the equation for a quadratic easing. The animation starts slowly from zero velocity and accelerates fast towards the end. The acceleration change is similar to a quadratic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

QuadEaseOut | QuadEaseInOut

QuadEaseInOut()

  1. static int16_t OHOS::EasingEquation::QuadEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in and then out shaping like a quadratic curve.

t^2 is the equation for a quadratic easing. The animation accelerates slowly until halfway and decelerates slowly towards the end. The acceleration change is similar to a quadratic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

QuadEaseIn | QuadEaseOut

QuadEaseOut()

  1. static int16_t OHOS::EasingEquation::QuadEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases out shaping like a quadratic curve.

t^2 is the equation for a quadratic easing. The animation starts fast and decelerates slowly towards the end. The acceleration change is similar to a quadratic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

QuadEaseIn | QuadEaseInOut

QuintEaseIn()

  1. static int16_t OHOS::EasingEquation::QuintEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in shaping like a quintic curve.

t^5 is the equation for a quintic easing. The animation starts slowly from zero velocity and accelerates fast towards the end. The acceleration change is similar to a quintic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

QuintEaseOut | QuintEaseInOut

QuintEaseInOut()

  1. static int16_t OHOS::EasingEquation::QuintEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in and then out shaping like a quintic curve.

t^5 is the equation for a quintic easing. The animation accelerates slowly until halfway and decelerates slowly towards the end. The acceleration change is similar to a quintic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

QuintEaseIn | QuintEaseOut

QuintEaseOut()

  1. static int16_t OHOS::EasingEquation::QuintEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases out shaping like a quintic curve.

t^5 is the equation for a quintic easing. The animation starts fast and decelerates slowly towards the end. The acceleration change is similar to a quintic curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

QuintEaseIn | QuintEaseInOut

Rect() [1/4]

  1. OHOS::Rect::Rect ()

Description:

A constructor used to create a Rect instance.

Rect() [2/4]

  1. OHOS::Rect::Rect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) && other)

Description:

A constructor used to create a Rect instance by copying another rectangle.

Parameters:

Name

Description

other Indicates the rectangle to copy.

Rect() [3/4]

  1. OHOS::Rect::Rect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & other)

Description:

A constructor used to create a Rect instance by copying another rectangle.

Parameters:

Name

Description

other Indicates the rectangle to copy.

Rect() [4/4]

  1. OHOS::Rect::Rect (int16_t left, int16_t top, int16_t right, int16_t bottom )

Description:

A constructor used to create a Rect instance based on the coordinates of the four boundaries.

Parameters:

Name

Description

left Indicates the coordinate of the left boundary.
top Indicates the coordinate of the top boundary.
right Indicates the coordinate of the right boundary.
bottom Indicates the coordinate of the bottom boundary.

Red()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Red ()

Description:

Obtains the color data of red.

Returns:

Returns the color data.

RefreshChart() [1/3]

  1. void OHOS::UIChartPillar::RefreshChart ()

Description:

Refreshes a bar chart and redraws the dirty region.

Only the parts that need to be redrawn are refreshed, for example, new data points. This function provides better performance than Invalidate.

Implements OHOS::UIChart.

RefreshChart() [2/3]

  1. void OHOS::UIChartPolyline::RefreshChart ()

Description:

Refreshes a line chart and redraws the dirty region.

Only the parts that need to be redrawn are refreshed, for example, new data points. This function provides better performance than Invalidate.

Implements OHOS::UIChart.

RefreshChart() [3/3]

  1. virtual void OHOS::UIChart::RefreshChart ()

Description:

Refreshes a chart and redraws the dirty region.

Only the parts that need to be redrawn are refreshed, for example, new data points. This function provides better performance than Invalidate.

Implemented in OHOS::UIChartPolyline, and OHOS::UIChartPillar.

RefreshList()

  1. void OHOS::UIList::RefreshList ()

Description:

Refreshes this list. The number of child views in the current view is fixed and the positions of those reserved child views as this list scrolls remain unchanged.

RegisterFPSChangedListener()

  1. static void OHOS::SysInfo::RegisterFPSChangedListener ([OnFPSChangedListener]($api-api-SmartVision-Devices-OHOS-SysInfo-OnFPSChangedListener.md) * onFPSChangedListener)

Description:

Registers the listener for notifying the FPS changes.

Parameters:

Name

Description

onFPSChangedListener Indicates the pointer to the FPS change notification function. For details, see OnFPSChangedListener.

RegisterScrollListener()

  1. void OHOS::UIScrollView::RegisterScrollListener ([OnScrollListener]($api-api-SmartVision-Devices-OHOS-UIScrollView-OnScrollListener.md) * scrollListener)

Description:

Registers a listener that contains a callback to be invoked upon scroll state changes.

Parameters:

Name

Description

scrollListener Indicates the listener to register. For details, see OnScrollListener.

RegisterSelectedListener() [1/2]

  1. void OHOS::UIPicker::RegisterSelectedListener ([SelectedListener]($api-api-SmartVision-Devices-OHOS-UIPicker-SelectedListener.md) * pickerListener)

Description:

Registers a listener for a selected event.

Parameters:

Name

Description

pickerListener Indicates the listener for a selected event in the picker. For details, see SelectedListener.

RegisterSelectedListener() [2/2]

  1. void OHOS::UITimePicker::RegisterSelectedListener ([SelectedListener]($api-api-SmartVision-Devices-OHOS-UITimePicker-SelectedListener.md) * timePickerListener)

Description:

Registers a listener for a selected event.

Parameters:

Name

Description

timePickerListener Indicates the listener to register. For details, see SelectedListener.

ReleaseEvent()

  1. OHOS::ReleaseEvent::ReleaseEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)

Description:

A constructor used to create a ReleaseEvent instance.

Parameters:

Name

Description

pos Indicates the position where the release event occurs.

ReMeasure()

  1. virtual void OHOS::UIView::ReMeasure ()

Description:

Remeasures the view size.

Remove() [1/4]

  1. void OHOS::AnimatorManager::Remove (const [Animator]($api-api-SmartVision-Devices-OHOS-Animator.md) * animator)

Description:

Removes the Animator instance from the AnimatorManager linked list.

Parameters:

Name

Description

animator Indicates the pointer to the Animator instance to remove.

See also:

Add

Remove() [2/4]

  1. void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Remove ([ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)< T > * node)

Description:

Deletes a data node.

Parameters:

Name

Description

node Indicates the pointer to the node to delete.

Remove() [3/4]

  1. virtual void OHOS::UIViewGroup::Remove ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)

Description:

Removes a child view.

Reimplemented in OHOS::UISwipeView.

Parameters:

Name

Description

view Indicates the pointer to the child view to remove.

Remove() [4/4]

  1. virtual void OHOS::UISwipeView::Remove ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)

Description:

Deletes a view.

Reimplemented from OHOS::UIViewGroup.

Parameters:

Name

Description

view Indicates the view to delete.

RemoveAll() [1/2]

  1. virtual void OHOS::UIViewGroup::RemoveAll ()

Description:

Removes all child views.

Reimplemented in OHOS::UIList.

RemoveAll() [2/2]

  1. void OHOS::UIList::RemoveAll ()

Description:

Removes all child views.

Reimplemented from OHOS::UIViewGroup.

Reset()

  1. void OHOS::UITextureMapper::Reset ()

Description:

Displays the original image.

The configured parameters are reserved and will not be reset.

Resize() [1/3]

  1. void OHOS::Rect::Resize (int16_t width, int16_t height )

Description:

Sets the width and height of a rectangle.

Parameters:

Name

Description

width Indicates the width of the rectangle.
height Indicates the height of the rectangle.

Resize() [2/3]

  1. virtual void OHOS::UIView::Resize (int16_t width, int16_t height )

Description:

Adjusts the size of the view.

Reimplemented in OHOS::UISurfaceView.

Parameters:

Name

Description

width Indicates the new width.
height Indicates the new height.

Resize() [3/3]

  1. void OHOS::UISurfaceView::Resize (int16_t width, int16_t height )

Description:

Adjusts the size of this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the new width.
height Indicates the new height.

ResizeVisibleArea()

  1. void OHOS::UIView::ResizeVisibleArea (int16_t x, int16_t y, int16_t width, int16_t height )

Description:

Adjusts the size of the visible area. This operation may affect the final display size.

Parameters:

Name

Description

x Indicates the new x-coordinate.
y Indicates the new y-coordinate.
width Indicates the new width.
height Indicates the new height.

Resume() [1/2]

  1. void OHOS::Animator::Resume ()

Description:

Resumes this animator from where it was paused.

See also:

Pause

Resume() [2/2]

  1. void OHOS::UIImageAnimatorView::Resume ()

Description:

Resumes this animator from the current image.

See also:

Pause

Rotate() [1/5]

  1. void OHOS::Rotate (const [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & origLine, int16_t angle, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & pivot, [Line]($api-api-SmartVision-Devices-OHOS-Line.md) & out )

Description:

Rotates a line around the pivot by a certain angle.

Parameters:

Name

Description

origLine Indicates the line segment to rotate.
angle Indicates the angle to rotate.
pivot Indicates the rotation pivot.
out Indicates the line generated after rotation.

Rotate() [2/5]

  1. void OHOS::Rotate (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & origRect, int16_t angle, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & pivot, [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) & out )

Description:

Rotates a rectangle around the pivot by a certain angle.

Parameters:

Name

Description

origRect Indicates the rectangle to rotate.
angle Indicates the angle to rotate.
pivot Indicates the rotation pivot.
out Indicates the polygon generated after the rectangle is rotated.

Rotate() [3/5]

  1. void OHOS::Rotate (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & point, int16_t angle, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & pivot, [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & out )

Description:

Rotates a point around the pivot by a certain angle.

Parameters:

Name

Description

point Indicates the point to rotate.
angle Indicates the angle to rotate.
pivot Indicates the rotation pivot.
out Indicates the point generated after rotation.

Rotate() [4/5]

  1. void OHOS::TransformMap::Rotate (int16_t angle, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & pivot )

Description:

Rotates the rectangle.

Parameters:

Name

Description

angle Indicates the angle to rotate.
pivot Indicates the rotation pivot.

Rotate() [5/5]

  1. [Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T > [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::Rotate (T angle, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T > & pivot )

Description:

Obtains a rotation matrix. After a matrix is rotated, its data is shifted leftwards by 15 bits. Therefore, the result data needs to be shifted rightwards by 15 bits.

Parameters:

Name

Description

angle Indicates the angle to rotate.
pivot Indicates the rotation pivot.

Returns:

Returns the matrix after rotation.

Scale() [1/2]

  1. void OHOS::TransformMap::Scale (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< float > scale, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< int16_t > & pivot )

Description:

Scales the rectangle.

Parameters:

Name

Description

scale Indicates the scaling factors of the x-axis and y-axis.
pivot Indicates the pivot for scaling.

Scale() [2/2]

  1. [Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T > [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::Scale (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T > & scale, const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T > & fixed )

Description:

Obtains the scaling matrix. After a matrix is scaled, its data is shifted leftwards by 8 bits. Therefore, the result data needs to be shifted rightwards by 8 bits.

Parameters:

Name

Description

scale Indicates the scaling factors of the x-axis and y-axis.
fixed Indicates the fixed scaling point.

Returns:

Returns the matrix after scaling.

ScrollBy() [1/2]

  1. void OHOS::UIList::ScrollBy (int16_t distance)

Description:

Scrolls the content in this list.

Parameters:

Name

Description

distance Indicates the distance by which the content is scrolled.

ScrollBy() [2/2]

  1. void OHOS::UIScrollView::ScrollBy (int16_t xDistance, int16_t yDistance )

Description:

Scrolls the content of this view.

Parameters:

Name

Description

xDistance Indicates the offset distance by which the content is scrolled on the x-axis.
yDistance Indicates the offset distance by which the content is scrolled on the y-axis.

ScrollTo()

  1. void OHOS::UIList::ScrollTo (uint16_t index)

Description:

Scrolls to change the index of the first row or column of the current view.

Parameters:

Name

Description

index Indicates the new index of the first row or column of the current view.

SelectedListener() [1/2]

  1. OHOS::UITimePicker::SelectedListener::SelectedListener ()

Description:

A constructor used to create a SelectedListener instance.

SelectedListener() [2/2]

  1. OHOS::UIPicker::SelectedListener::SelectedListener ()

Description:

A constructor used to create a SelectedListener instance.

SetAdapter()

  1. void OHOS::UIList::SetAdapter ([AbstractAdapter]($api-api-SmartVision-Devices-OHOS-AbstractAdapter.md) * adapter)

Description:

Sets the adapter for this list. The content of this list is initialized when the adapter is set.

Parameters:

Name

Description

adapter Indicates the adapter to set. For details, see AbstractAdapter.

SetAlign() [1/4]

  1. void OHOS::UILabelButton::SetAlign ([UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) align)

Description:

Sets the alignment mode for this text.

Parameters:

Name

Description

align Indicates the text alignment mode to set, as defined in UITextLanguageAlignment.

SetAlign() [2/4]

  1. void OHOS::UIArcLabel::SetAlign ([UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) horizontalAlign)

Description:

Sets the alignment mode for this text.

Parameters:

Name

Description

horizontalAlign Indicates the horizontal alignment mode to set, which can be TEXT_ALIGNMENT_LEFT, TEXT_ALIGNMENT_CENTER, or TEXT_ALIGNMENT_RIGHT.

SetAlign() [3/4]

  1. void OHOS::Text::SetAlign ([UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) horizontalAlign, [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) verticalAlign = [/topic/body/section/screen/code
  2. {""}) TEXT_ALIGNMENT_TOP (code] )

Description:

Sets the alignment mode for this text.

Parameters:

Name

Description

horizontalAlign Indicates the horizontal alignment mode to set, which can be TEXT_ALIGNMENT_LEFT, TEXT_ALIGNMENT_CENTER, or TEXT_ALIGNMENT_RIGHT.
verticalAlign Indicates the vertical alignment mode to set, which can be TEXT_ALIGNMENT_TOP (default mode), TEXT_ALIGNMENT_CENTER, or TEXT_ALIGNMENT_BOTTOM.

SetAlign() [4/4]

  1. void OHOS::UILabel::SetAlign ([UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) horizontalAlign, [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) verticalAlign = [/topic/body/section/screen/code
  2. {""}) TEXT_ALIGNMENT_TOP (code] )

Description:

Sets the alignment mode for this text.

Parameters:

Name

Description

horizontalAlign Indicates the horizontal alignment mode to set, which can be TEXT_ALIGNMENT_LEFT, TEXT_ALIGNMENT_CENTER, or TEXT_ALIGNMENT_RIGHT.
verticalAlign Indicates the vertical alignment mode to set, which can be TEXT_ALIGNMENT_TOP (default mode), TEXT_ALIGNMENT_CENTER, or TEXT_ALIGNMENT_BOTTOM.

SetAnimatorStopListener() [1/2]

  1. void OHOS::UITextureMapper::SetAnimatorStopListener ([AnimatorStopListener]($api-api-SmartVision-Devices-OHOS-UITextureMapper-AnimatorStopListener.md) * listener)

Description:

Sets the listener for the stop of this animator.

Parameters:

Name

Description

listener Indicates the listener to set. For details, see AnimatorStopListener.

SetAnimatorStopListener() [2/2]

  1. void OHOS::UIImageAnimatorView::SetAnimatorStopListener ([AnimatorStopListener]($api-api-SmartVision-Devices-OHOS-UIImageAnimatorView-AnimatorStopListener.md) * listener)

Description:

Sets the listener for the stop of this animator.

Parameters:

Name

Description

listener Indicates the listener to set. For details, see AnimatorStopListener.

SetAnimatorTime()

  1. void OHOS::UISwipeView::SetAnimatorTime (uint16_t time)

Description:

Sets the time for the page being animated. The page will go beyond the blank during this time.

Parameters:

Name

Description

time Indicates the time of the page being animated.

SetArcTextAngle()

  1. void OHOS::UIArcLabel::SetArcTextAngle (int16_t startAngle, int16_t endAngle )

Description:

Sets the start angle and end angle for this arc text.

The angle in 12 o’clock direction is 0 degrees, and the value increases clockwise. The text direction is clockwise when the end angle is greater than the start angle, and the text direction is counterclockwise otherwise.

Parameters:

Name

Description

startAngle Indicates the start angle to set.
endAngle Indicates the end angle to set.

SetArcTextCenter()

  1. void OHOS::UIArcLabel::SetArcTextCenter (int16_t x, int16_t y )

Description:

Sets the center position for this arc text.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.

SetArcTextOrientation()

  1. void OHOS::UIArcLabel::SetArcTextOrientation ([TextOrientation]($api-api-SmartVision-Devices-Graphic.md#ga0778527bee4a7ddd8d46395585a5cfb9) orientation)

Description:

Sets the orientation for this arc text.

Parameters:

Name

Description

orientation Indicates the text orientation to set.

SetArcTextRadius()

  1. void OHOS::UIArcLabel::SetArcTextRadius (uint16_t radius)

Description:

Sets the radius for this arc text.

Parameters:

Name

Description

radius Indicates the radius to set.

SetAutoEnable()

  1. void OHOS::UIImageView::SetAutoEnable (bool enable)

Description:

Sets whether the image view size needs to be adaptive to the image size.

Parameters:

Name

Description

enable Specifies whether the image view size needs to be adaptive to the image size. true indicates that automatic adaption is enabled, and false indicates the opposite case.

SetAutoSize()

  1. void OHOS::UIViewGroup::SetAutoSize (bool state)

Description:

Sets whether the size of this view group is adaptive to that of all child views.

Parameters:

Name

Description

state Specifies whether the size of this view group is adaptive to that of all child views. true indicates automatic adaption is enabled, and false indicates the opposite case.

SetBackgroundImagePosition()

  1. void OHOS::UICircleProgress::SetBackgroundImagePosition (int16_t x, int16_t y )

Description:

Sets the coordinates of the background image for this progress bar relative to the view.

Parameters:

Name

Description

x Indicates the x-coordinate to set. The default value is 0.
y Indicates the y-coordinate to set. The default value is 0.

See also:

SetProgressImagePosition

SetBackgroundStyle() [1/2]

  1. void OHOS::UIAbstractProgress::SetBackgroundStyle (const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)

Description:

Sets the background style for this progress bar.

Parameters:

Name

Description

style Indicates the background style of the progress bar. For details, see Style.

See also:

SetForegroundStyle | GetBackgroundStyle

SetBackgroundStyle() [2/2]

  1. void OHOS::UIAbstractProgress::SetBackgroundStyle (uint8_t key, int64_t value )

Description:

Sets a background style for this progress bar.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetBackOvershoot()

  1. static void OHOS::EasingEquation::SetBackOvershoot (double overshoot)

Description:

Sets the parameter s in the equation (s+1)*t^3 - s*t^2 for a back easing.

A larger s indicates a larger degree of overshoot. The default value is 1.7. You are advised to set this parameter to a value ranging from 1 to 4. The setting takes effect for all the back-ease animations.

Parameters:

Name

Description

overshoot Indicates the overshoot s in the equation to set.

See also:

BackEaseIn | BackEaseOut | BackEaseInOut

SetBlankSize()

  1. void OHOS::UISwipeView::SetBlankSize (uint16_t size)

Description:

Sets a blank size, as defined in DEFAULT_BLANK_SIZE.

Parameters:

Name

Description

size Indicates the blank size to set.

SetBlurLevel()

  1. void OHOS::UIImageView::SetBlurLevel (BlurLevel level)

Description:

Sets the blur level for this image when it is rotated or scaled.

Parameters:

Name

Description

level Indicates the blur level to set. For details, see BlurLevel.

SetBottom()

  1. void OHOS::Rect::SetBottom (int16_t bottom)

Description:

Sets the coordinate of the bottom boundary of a rectangle.

Parameters:

Name

Description

bottom Indicates the coordinate of the bottom boundary.

SetBottomPointStyle()

  1. void OHOS::UIChartDataSerial::SetBottomPointStyle (const [PointStyle]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial-PointStyle.md) & style)

Description:

Sets the style of the bottom point of a polyline.

Parameters:

Name

Description

style Indicates the style to set. For details, see PointStyle.

SetButton()

  1. void OHOS::UIDialog::SetButton ([DialogButtonType]($api-api-SmartVision-Devices-Graphic.md#ga1bfefa0b46fd5a79a28d0c9a75114295) buttonType, const char * text, [OnClickListener]($api-api-SmartVision-Devices-OHOS-UIView-OnClickListener.md) * listener )

Description:

Sets a button for this dialog box.

Parameters:

Name

Description

buttonType Indicates the button position.
text Indicates the pointer to the button text.
listener Indicates the pointer to the listener registered for the button.

SetCapType()

  1. void OHOS::UIAbstractProgress::SetCapType ([CapType]($api-api-SmartVision-Devices-Graphic.md#ga2db3928cdf793f4950245a6841dd43d6) cap)

Description:

Sets the type of caps on the background and foreground of the progress bar.

Parameters:

Name

Description

cap Indicates the cap type. For details, see CapType.

SetCenterPosition()

  1. void OHOS::UICircleProgress::SetCenterPosition (int16_t x, int16_t y )

Description:

Sets the coordinates of the center point for this circular progress bar.

The coordinates of the center point refer to the position relative to the view.

Parameters:

Name

Description

x Indicates the x-coordinate to set. The default value is 0.
y Indicates the y-coordinate to set. The default value is 0.

See also:

GetCenterPosition

SetColor()

  1. void OHOS::UIDigitalClock::SetColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Sets the font color for this digital clock.

Parameters:

Name

Description

color Indicates the front color to set.

SetCols()

  1. void OHOS::GridLayout::SetCols (const uint16_t & cols)

Description:

Sets the number of columns in a grid.

Parameters:

Name

Description

cols Indicates the number of columns to set.

SetCurrent()

  1. void OHOS::ThemeManager::SetCurrent ([Theme]($api-api-SmartVision-Devices-OHOS-Theme.md) * theme)

Description:

Sets the current screen theme for this application.

Parameters:

Name

Description

theme Indicates the theme to set.

SetCurrentPage()

  1. void OHOS::UISwipeView::SetCurrentPage (uint16_t index, bool needAnimator = [/topic/body/section/screen/code
  2. {""}) false (code] )

Description:

Sets the index for the current tab.

Parameters:

Name

Description

index Indicates the index of a view.
needAnimator Specifies whether a flip animation is needed. false (default value) indicates a flip animation is not needed, and true indicates the opposite case.

SetData() [1/2]

  1. void OHOS::TextAdapter::SetData (int16_t start, int16_t end )

Description:

Sets continuously increasing data. For example, if you need to set data 0, 1, 2, 3, 4, use this function to set start to 0 and end to 4.

Parameters:

Name

Description

start Indicates the start value of the integer data.
end Indicates the end value of the integer data.

SetData() [2/2]

  1. void OHOS::TextAdapter::SetData ([List]($api-api-SmartVision-Devices-OHOS-List-T.md)< const char * > * data)

Description:

Sets the UILabel adapter data, which is a string linked list.

Parameters:

Name

Description

data Indicates the string linked list data.

SetDataRange() [1/3]

  1. bool OHOS::UIXAxis::SetDataRange (uint16_t min, uint16_t max )

Description:

Sets the value range of the X axis.

The maximum value must be greater than the minimum value. Otherwise, the setting fails.

Implements OHOS::UIAxis.

Parameters:

Name

Description

min Indicates the minimum value to set.
max Indicates the maximum value to set.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetDataRange() [2/3]

  1. bool OHOS::UIYAxis::SetDataRange (uint16_t min, uint16_t max )

Description:

Sets the value range of the y-axis.

The maximum value must be greater than the minimum value. Otherwise, the setting fails.

Implements OHOS::UIAxis.

Parameters:

Name

Description

min Indicates the minimum value to set.
max Indicates the maximum value to set.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetDataRange() [3/3]

  1. virtual bool OHOS::UIAxis::SetDataRange (uint16_t min, uint16_t max )

Description:

Sets the value range of a coordinate axis.

The maximum value must be greater than the minimum value. Otherwise, the setting fails.

Implemented in OHOS::UIYAxis, and OHOS::UIXAxis.

Parameters:

Name

Description

min Indicates the minimum value to set.
max Indicates the maximum value to set.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetDelayTime()

  1. void OHOS::UITextureMapper::SetDelayTime (uint16_t delayTime)

Description:

Sets the delay time for this animator, in milliseconds.

The delays of image scaling and rotation are the same and cannot be set separately.

Parameters:

Name

Description

delayTime Indicates the delay time to set.

SetDirect() [1/5]

  1. void OHOS::Text::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)

Description:

Sets the direction for this text.

Parameters:

Name

Description

direct Indicates the text direction, as defined in UITextLanguageDirect.

SetDirect() [2/5]

  1. void OHOS::UILabelButton::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)

Description:

Sets the direction for this text.

Parameters:

Name

Description

direct Indicates the text direction to set, as defined in UITextLanguageDirect.

SetDirect() [3/5]

  1. void OHOS::TextAdapter::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)

Description:

Sets the direction of the UILabel constructed by the adapter.

Parameters:

Name

Description

direct Indicates the direction of the UILabel constructed by the adapter.

SetDirect() [4/5]

  1. void OHOS::UILabel::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)

Description:

Sets the direction for this text.

Returns:

direct Returns the text direction, as defined in UITextLanguageDirect.

SetDirect() [5/5]

  1. void OHOS::UIPicker::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)

Description:

Sets the text direction.

Parameters:

Name

Description

direct Indicates the text direction to set. For details, see UITextLanguageDirect.

SetDirection() [1/2]

  1. void OHOS::UIBoxProgress::SetDirection (const [Direction]($api-api-SmartVision-Devices-Graphic.md#ga4a7a2c192206c8b18379f42a5fd176eb) & direction)

Description:

Sets the direction for this progress bar.

Parameters:

Name

Description

direction Indicates the direction to set. The default direction is from left to right. For details, see Direction.

See also:

GetDirection

SetDirection() [2/2]

  1. void OHOS::UISwipeView::SetDirection (uint8_t direction)

Description:

Sets the dragging direction.

Parameters:

Name

Description

direction Indicates the dragging direction, either HORIZONTAL or VERTICAL.

SetDisallowIntercept()

  1. void OHOS::UIViewGroup::SetDisallowIntercept (bool flag)

Description:

Sets whether this view group is intercepted upon touch events.

Parameters:

Name

Description

flag Specifies whether this view group is intercepted upon touch events. true indicates that this view group is intercepted upon touch events, and false indicates the opposite case.

SetDisplayMode()

  1. void OHOS::UIDigitalClock::SetDisplayMode ([DisplayMode]($api-api-SmartVision-Devices-Graphic.md#gabe3b64b11e5bf5d7b54e1039e40f306b) dm)

Description:

Sets the display mode for this digital clock.

Parameters:

Name

Description

dm Indicates the display mode to set.

SetDragACCLevel()

  1. void OHOS::UIAbstractScroll::SetDragACCLevel (uint16_t value)

Description:

Sets the drag acceleration.

Parameters:

Name

Description

value Indicates the drag acceleration to set. The default value is 10. A larger drag acceleration indicates a higher inertial scroll velocity.

SetDragFunc()

  1. void OHOS::UIAbstractScroll::SetDragFunc (EasingFunc func)

Description:

Sets the easing function that specifies a scroll animation after a finger lifts the screen.

Parameters:

Name

Description

func Indicates the easing function to set. The default function is EasingEquation::CubicEaseOut. For details, see EasingEquation.

SetDraggable()

  1. void OHOS::UIView::SetDraggable (bool draggable)

Description:

Sets whether the view is draggable.

Parameters:

Name

Description

draggable Specifies whether to set the view draggable. Value true means to set the view draggable, and false means the opposite.

SetDragParentInstead()

  1. void OHOS::UIView::SetDragParentInstead (bool dragParentInstead)

Description:

Sets whether to transfer the drag event to the parent view for processing when the view is being dragged.

Parameters:

Name

Description

dragParentInstead Specifies whether to transfer the event to the parent view for processing. Value true means to transfer the event to the parent view for processing, and false means the opposite.

SetDurationTime()

  1. void OHOS::UITextureMapper::SetDurationTime (uint16_t durationTime)

Description:

Sets the duration for this animator, in milliseconds.

The durations of image scaling and rotation are the same and cannot be set separately.

Parameters:

Name

Description

durationTime Indicates the duration to set.

SetEasingFunc()

  1. void OHOS::UITextureMapper::SetEasingFunc (EasingFunc easingFunc)

Description:

Sets the easing function for this animator.

The easing functions for image scaling and rotation are the same and cannot be set separately.

Parameters:

Name

Description

easingFunc Indicates the easing function to set. The animation moves at a constant velocity by default. For details, see EasingEquation.

SetEndAngle()

  1. void OHOS::UICircleProgress::SetEndAngle (int16_t endAngle)

Description:

Sets the end angle.

The 12-clock direction is 0 degrees, and the 3-clock direction is 90 degrees. If the start angle is smaller than the end angle, the progress bar is clockwise. Otherwise, the progress bar is anticlockwise. The maximum range of a progress bar is a circle. If the difference between the start angle and end angle exceeds 360 degrees, a circular progress bar is created.

Parameters:

Name

Description

endAngle Indicates the end angle to set, which can be any value represented by int16_t. The default value is 360.

See also:

GetEndAngle | SetStartAngle

SetExpandHeight()

  1. void OHOS::Text::SetExpandHeight (bool expand)

Description:

Sets whether to adapt the component height to this text.

Parameters:

Name

Description

expand Specifies whether to adapt the component height to this text. The value true indicates that the component height will adapt to this text, and false indicates not.

SetExpandWidth()

  1. void OHOS::Text::SetExpandWidth (bool expand)

Description:

Sets whether to adapt the component width to this text.

Parameters:

Name

Description

expand Specifies whether to adapt the component width to this text. The value true indicates that the component width will adapt to this text, and false indicates not.

SetFillColor() [1/2]

  1. void OHOS::Paint::SetFillColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Sets fill color.

This function is valid only for closed graphs.

Parameters:

Name

Description

color Indicates the fill color to set.

See also:

GetFillColor

SetFillColor() [2/2]

  1. void OHOS::UIChartDataSerial::SetFillColor (const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) & color)

Description:

Sets the fill color of the data set.

For a line chart, color refers to the fill color between the line and the x-axis. For a bar chart, color refers to the color of the bars.

Parameters:

Name

Description

color Indicates the fill color to set.

See also:

GetFillColor

SetFlexWrap()

  1. void OHOS::FlexLayout::SetFlexWrap (uint8_t wrap)

Description:

Sets whether to support word wrap.

Parameters:

Name

Description

wrap Indicates the word wrap attribute.

SetFont() [1/6]

  1. void OHOS::UIDigitalClock::SetFont (const char * name, uint8_t size )

Description:

Sets the dynamic font for this digital clock.

Parameters:

Name

Description

name Indicates the pointer to the font name.
size Indicates the font size to set.

SetFont() [2/6]

  1. void OHOS::Text::SetFont (const char * name, uint8_t size )

Description:

Sets the font name and size.

Parameters:

Name

Description

name Indicates the pointer to the font name.
size Indicates the font size to set.

SetFont() [3/6]

  1. void OHOS::TextAdapter::SetFont (const char * name, uint8_t size )

Description:

Sets the font.

Parameters:

Name

Description

name Indicates the pointer to the font name.
size Indicates the font size to set.

SetFont() [4/6]

  1. void OHOS::UIArcLabel::SetFont (const char * name, uint8_t size )

Description:

Sets the font for this arc label.

Parameters:

Name

Description

name Indicates the pointer to the font name.
size Indicates the font size to set.

SetFont() [5/6]

  1. void OHOS::UILabelButton::SetFont (const char * name, uint8_t size )

Description:

Sets the font for this text.

Parameters:

Name

Description

name Indicates the pointer to the font name.
size Indicates the font size to set.

SetFont() [6/6]

  1. void OHOS::UILabel::SetFont (const char * name, uint8_t size )

Description:

Sets the font for this label.

Parameters:

Name

Description

name Indicates the pointer to the font name.
size Indicates the font size to set.

SetFontId() [1/7]

  1. void OHOS::UIPicker::SetFontId (uint8_t backgroundFontId, uint8_t highlightFontId )

Description:

Sets the font IDs of dynamic text, which is the string array set through SetValues.

Parameters:

Name

Description

backgroundFontId Indicates the font ID of the background text.
highlightFontId Indicates the font ID of the highlighted text.

SetFontId() [2/7]

  1. void OHOS::UIDigitalClock::SetFontId (uint8_t fontId)

Description:

Sets the dynamic font ID for this digital clock.

Parameters:

Name

Description

fontId Indicates the dynamic font ID to set.

SetFontId() [3/7]

  1. void OHOS::TextAdapter::SetFontId (uint8_t fontId)

Description:

Sets font ID.

Parameters:

Name

Description

fontId Indicates the font ID. For details, see UITextLanguageFontId.

SetFontId() [4/7]

  1. void OHOS::Text::SetFontId (uint8_t fontId)

Description:

Sets the font ID.

Parameters:

Name

Description

fontId Indicates the font ID to set.

SetFontId() [5/7]

  1. void OHOS::UIArcLabel::SetFontId (uint8_t fontId)

Description:

Sets the font ID for this arc label.

Parameters:

Name

Description

fontId Indicates the font ID composed of font name and size.

SetFontId() [6/7]

  1. void OHOS::UILabelButton::SetFontId (uint8_t fontId)

Description:

Sets the font ID.

Parameters:

Name

Description

fontId Indicates the font ID composed of the font name and size.

SetFontId() [7/7]

  1. void OHOS::UILabel::SetFontId (uint8_t fontId)

Description:

Sets the font ID for this label.

Parameters:

Name

Description

fontId Indicates the font ID composed of font name and size.

SetForegroundStyle() [1/2]

  1. void OHOS::UIAbstractProgress::SetForegroundStyle (const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)

Description:

Sets the foreground style for this progress bar.

Parameters:

Name

Description

style Indicates the foreground style of this progress bar. For details, see Style.

See also:

SetBackgroundStyle | GetForegroundStyle

SetForegroundStyle() [2/2]

  1. void OHOS::UIAbstractProgress::SetForegroundStyle (uint8_t key, int64_t value )

Description:

Sets a foreground style for this progress bar.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetFPSCalculateType()

  1. void OHOS::SysInfo::OnFPSChangedListener::SetFPSCalculateType ([FPSCalculateType]($api-api-SmartVision-Devices-Graphic.md#ga75d850e3abff6c2f617b689a0cb9a3d1) type)

Description:

Sets the FPS sampling type.

Parameters:

Name

Description

type Indicates the FPS sampling type. For details, see FPSCalculateType.

SetGradientBottom()

  1. void OHOS::UIChartPolyline::SetGradientBottom (uint16_t bottom)

Description:

Sets the distance between the bottom edge of the fill color range and the x-axis.

This function fills in the area between the polyline and bottom of the line chart. For a chart that is not reversed, if the bottom is above the polyline, there is no filling. For a reversed chart, if the bottom is below the polyline, there is no filling.

Parameters:

Name

Description

bottom Indicates the bottom of the filling range. The value is the distance to the x-axis.

SetGradientOpacity()

  1. void OHOS::UIChartPolyline::SetGradientOpacity (uint8_t minOpa, uint8_t maxOpa )

Description:

Sets the opacity range of the fill color gradient.

This function sets the opacity range between the top point and bottom point of the line chart. The opacity of each horizontal line is calculated based on the ratio.

Parameters:

Name

Description

minOpa Indicates the opacity closest to the x-axis.
maxOpa Indicates the opacity farthest away from the x-axis.

SetHandImage()

  1. void OHOS::UIAnalogClock::SetHandImage ([HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf) type, const [UIImageView]($api-api-SmartVision-Devices-OHOS-UIImageView.md) & img, [Point]($api-api-SmartVision-Devices-OHOS-Point.md) position, [Point]($api-api-SmartVision-Devices-OHOS-Point.md) center )

Description:

Sets the image used to draw a clock hand.

Parameters:

Name

Description

type Indicates the clock hand type, as enumerated in HandType.
img Indicates the image to set.
position Indicates the start position of this image.
center Indicates the rotation center of this clock hand.

SetHandLine()

  1. void OHOS::UIAnalogClock::SetHandLine ([HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf) type, [Point]($api-api-SmartVision-Devices-OHOS-Point.md) position, [Point]($api-api-SmartVision-Devices-OHOS-Point.md) center, [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color, uint16_t width, uint16_t height, OpacityType opacity )

Description:

Sets the line used to draw a clock hand.

Parameters:

Name

Description

type Indicates the clock hand type, as enumerated in HandType.
position Indicates the position of the line endpoint close to the rotation center.
center Indicates the rotation center of this clock hand.
color Indicates the color of this line.
width Indicates the width of this line when it is 12 o’clock.
height Indicates the height of this line when it is 12 o’clock.
opacity Indicates the opacity of this line.

SetHeadPointStyle()

  1. void OHOS::UIChartDataSerial::SetHeadPointStyle (const [PointStyle]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial-PointStyle.md) & style)

Description:

Sets the style of the frontmost point on a polyline.

Parameters:

Name

Description

style Indicates the style to set. For details, see PointStyle.

SetHeight() [1/10]

  1. void OHOS::TextAdapter::SetHeight (int16_t height)

Description:

Sets the height of the UILabel constructed by the adapter.

Returns:

Returns the height of the UILabel constructed by the adapter.

SetHeight() [2/10]

  1. void OHOS::Rect::SetHeight (int16_t height)

Description:

Changes the height of the rectangle without changing the coordinate of the top boundary.

Parameters:

Name

Description

height Indicates the height of the rectangle.

SetHeight() [3/10]

  1. virtual void OHOS::UIView::SetHeight (int16_t height)

Description:

Sets the height for the view.

Reimplemented in OHOS::UIChart, OHOS::UILabel, OHOS::UIButton, OHOS::UIPicker, OHOS::UITimePicker, OHOS::UISurfaceView, and OHOS::UIBoxProgress.

Parameters:

Name

Description

height Indicates the height to set.

SetHeight() [4/10]

  1. void OHOS::UIBoxProgress::SetHeight (int16_t height)

Description:

Sets the height for this view.

The height of the view must be greater than or equal to the actual height of the progress bar to ensure a normal display. You need to call this function before calling SetValidHeight to set the actual height of the progress bar. Otherwise, the height of the progress bar is reset to height of the view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

See also:

SetWidth | SetValidWidth | SetValidHeight

SetHeight() [5/10]

  1. void OHOS::UISurfaceView::SetHeight (int16_t height)

Description:

Sets the height for this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

SetHeight() [6/10]

  1. void OHOS::UITimePicker::SetHeight (int16_t height)

Description:

Sets the height for the time picker.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

SetHeight() [7/10]

  1. void OHOS::UIPicker::SetHeight (int16_t height)

Description:

Sets the height for this component.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

SetHeight() [8/10]

  1. void OHOS::UIButton::SetHeight (int16_t height)

Description:

Sets the height for this image.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

SetHeight() [9/10]

  1. void OHOS::UILabel::SetHeight (int16_t height)

Description:

Sets the height for this label.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

SetHeight() [10/10]

  1. void OHOS::UIChart::SetHeight (int16_t height)

Description:

Sets the height for this component.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

height Indicates the height to set.

SetHorizontalScrollState()

  1. void OHOS::UIScrollView::SetHorizontalScrollState (bool state)

Description:

Sets whether a horizontal scroll is enabled.

Parameters:

Name

Description

state Specifies whether a horizontal scroll is enabled. true indicates a horizontal scroll is enabled, and false indicates the opposite case.

SetImage() [1/4]

  1. void OHOS::UISlider::SetImage (const char * backgroundImage, const char * foregroundImage, const char * knobImage )

Description:

Sets the images for this slider, including the background, foreground, and knob images.

Parameters:

Name

Description

backgroundImage Indicates the background image to set.
foregroundImage Indicates the foreground image to set.
knobImage Indicates the knob image to set.

SetImage() [2/4]

  1. void OHOS::UIAbstractProgress::SetImage (const char * foregroundImage, const char * backgroundImage = [/topic/body/section/screen/code
  2. {""}) nullptr (code] )

Description:

Sets the image for this progress bar.

The size of the image must be the same as that of the progress bar to ensure a normal display. If the value of any input parameter is nullptr, image filling is canceled. Instead, color filling will be adopted.

Parameters:

Name

Description

foregroundImage Indicates the foreground image of the progress bar. The default value is nullptr.
backgroundImage Indicates the background image of the progress bar. The default value is nullptr.

SetImage() [3/4]

  1. void OHOS::UISlider::SetImage (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * backgroundImage, const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * foregroundImage, const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * knobImage )

Description:

Sets the images as pixel maps for this slider, including the background, foreground, and knob images.

Parameters:

Name

Description

backgroundImage Indicates the background image to set.
foregroundImage Indicates the foreground image to set.
knobImage Indicates the knob image to set.

SetImage() [4/4]

  1. void OHOS::UIAbstractProgress::SetImage (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * foregroundImage, const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * backgroundImage = [/topic/body/section/screen/code
  2. {""}) nullptr (code] )

Description:

Sets the image as a pixel map for this progress bar.

The size of the image must be the same as that of the progress bar to ensure a normal display. If the value of any input parameter is nullptr, image filling is canceled. Instead, color filling will be adopted.

Parameters:

Name

Description

foregroundImage Indicates the foreground image of the progress bar. The default value is nullptr.
backgroundImage Indicates the background image of the progress bar. The default value is nullptr.

SetImageAnimatorSrc() [1/2]

  1. void OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char * imageSrc, uint8_t imageNum )

Description:

Sets the images for this animator.

Parameters:

Name

Description

imageSrc Indicates the pointer to the ImageAnimatorInfo array for storing the configured image information. The memory cannot be released before this animator stops.
imageNum Indicates the number of images.

See also:

GetImageAnimatorSrc | GetImageAnimatorImageNum

SetImageAnimatorSrc() [2/2]

  1. void OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char * imageSrc, uint8_t imageNum, uint16_t timeOfUpdate )

Description:

Sets the images and speed for this animator.

Parameters:

Name

Description

imageSrc Indicates the pointer to the ImageAnimatorInfo array for storing the configured image information. The memory cannot be released before this animator stops.
imageNum Indicates the number of images.
timeOfUpdate Indicates the interval for updating images, in milliseconds. The default value is 1.

See also:

GetTimeOfUpdate | GetImageAnimatorSrc | GetImageAnimatorImageNum

SetImagePosition()

  1. void OHOS::UIButton::SetImagePosition (const int16_t x, const int16_t y )

Description:

Sets the position for this image.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.

SetImages() [1/2]

  1. virtual void OHOS::UICheckBox::SetImages (const char * selectedImageSrc, const char * unselectedImageSrc )

Description:

Sets the images for this check box.

Parameters:

Name

Description

selectedImageSrc Indicates the image for this check box when selected.
unselectedImageSrc Indicates the image for this check box when unselected.

SetImages() [2/2]

  1. virtual void OHOS::UICheckBox::SetImages (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * selectedImageSrc, const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * unselectedImageSrc )

Description:

Sets the images for this check box.

Parameters:

Name

Description

selectedImageSrc Indicates the image for this check box when selected.
unselectedImageSrc Indicates the image for this check box when unselected.

SetImageSrc() [1/2]

  1. void OHOS::UIButton::SetImageSrc (const char * defaultImgSrc, const char * triggeredImgSrc )

Description:

Sets the image for this button.

Parameters:

Name

Description

defaultImgSrc Indicates the default image.
triggeredImgSrc Indicates the image for a button when it is triggered.

SetImageSrc() [2/2]

  1. void OHOS::UIButton::SetImageSrc (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * defaultImgSrc, const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * triggeredImgSrc )

Description:

Sets the image for this button.

Parameters:

Name

Description

defaultImgSrc Indicates the default image.
triggeredImgSrc Indicates the image for a button when it is triggered.

SetInitTime12Hour()

  1. void OHOS::UIAnalogClock::SetInitTime12Hour (uint8_t hour, uint8_t minute, uint8_t second, bool am )

Description:

Sets the initial time in the 12-hour format.

Parameters:

Name

Description

hour Indicates the hour to set.
minute Indicates the minute to set.
second Indicates the second to set.
am Specifies whether it is in the morning. true indicates that it is in the morning, and false indicates that it is in the afternoon.

SetInitTime24Hour()

  1. void OHOS::UIAnalogClock::SetInitTime24Hour (uint8_t hour, uint8_t minute, uint8_t second )

Description:

Sets the initial time in the 24-hour format.

Parameters:

Name

Description

hour Indicates the hour to set.
minute Indicates the minute to set.
second Indicates the second to set.

SetIntercept()

  1. void OHOS::UIView::SetIntercept (bool isIntercept)

Description:

Sets whether to intercept the drag event. If intercepted, the view does not transfer the drag event to the parent view after local processing.

Parameters:

Name

Description

isIntercept Specifies whether to intercept the drag event. Value true means to intercept the drag event, and false means the opposite.

SetInterval()

  1. virtual void OHOS::UIRepeatButton::SetInterval (uint16_t interval)

Description:

Sets the interval between two consecutive click events.

Parameters:

Name

Description

interval Indicates the interval to set.

SetItemHeight() [1/2]

  1. void OHOS::UITimePicker::SetItemHeight (int16_t height)

Description:

Sets the height of each item in the time picker.

Parameters:

Name

Description

height Indicates the height of each item.

SetItemHeight() [2/2]

  1. void OHOS::UIPicker::SetItemHeight (int16_t height)

Description:

Sets the height of each item in the picker.

Parameters:

Name

Description

height Indicates the height to set.

SetKnobStyle() [1/2]

  1. void OHOS::UISlider::SetKnobStyle (const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)

Description:

Sets the knob style.

Parameters:

Name

Description

style Indicates the knob style to set. For details, see Style.

See also:

GetKnobStyle

SetKnobStyle() [2/2]

  1. void OHOS::UISlider::SetKnobStyle (uint8_t key, int64_t value )

Description:

Sets a knob style.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetKnobWidth()

  1. void OHOS::UISlider::SetKnobWidth (int16_t width)

Description:

Sets the width for this knob.

The width of this knob is the same as its height. By default, the width of this knob is the same as the height of the horizontal slider or the width of the vertical slider.

Parameters:

Name

Description

width Indicates the knob width to set.

See also:

GetKnobWidth

SetLabelStyle() [1/2]

  1. void OHOS::UILabelButton::SetLabelStyle ([Style]($api-api-SmartVision-Devices-OHOS-Style.md) & labelStyle)

Description:

Sets the style for this label.

Parameters:

Name

Description

labelStyle Indicates the label style to set.

SetLabelStyle() [2/2]

  1. void OHOS::UILabelButton::SetLabelStyle (uint8_t key, int64_t value )

Description:

Sets a style for this label.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetLablePosition()

  1. void OHOS::UILabelButton::SetLablePosition (int16_t x, int16_t y )

Description:

Sets the position for this label relative to the button holding it.

Parameters:

Name

Description

x Indicates the offset distance by which this label is moved on the x-axis.
y Indicates the offset distance by which this label is moved on the y-axis.

SetLastRun()

  1. void OHOS::Task::SetLastRun (uint32_t lastRun)

Description:

Sets the end time for this task.

Parameters:

Name

Description

lastRun Indicates the end time to set.

SetLayoutDirection()

  1. void OHOS::Layout::SetLayoutDirection (const [DirectionType]($api-api-SmartVision-Devices-Codec.md#ga8ef30fa9c08e08c8706653571f9f5b81) & direction)

Description:

Sets the layout direction.

Parameters:

Name

Description

direction Indicates the direction of the layout. Available values are as follows: LAYOUT_HOR: from left to right LAYOUT_HOR_R: from right to left LAYOUT_VER: from top to bottom LAYOUT_VER_R: from bottom to top

SetLeft()

  1. void OHOS::Rect::SetLeft (int16_t left)

Description:

Sets the coordinate of the left boundary of a rectangle.

Parameters:

Name

Description

left Indicates the coordinate of the left boundary.

SetLineBreakMode() [1/2]

  1. void OHOS::UILabel::SetLineBreakMode (const uint8_t lineBreakMode)

Description:

Sets the line break mode for this text.

Parameters:

Name

Description

lineBreakMode Indicates the line break mode to set.

SetLineBreakMode() [2/2]

  1. void OHOS::TextAdapter::SetLineBreakMode (const uint8_t lineBreakMode)

Description:

Sets the LineBreakMode attribute of UILabel constructed by the adapter. For details about the values of LineBreakMode, see LINE_BREAK_ADAPT, LINE_BREAK_WRAP, LINE_BREAK_ELLIPSIS, and LINE_BREAK_MARQUEE.

Parameters:

Name

Description

lineBreakMode Indicates the LineBreakMode of UILabel.

SetLineColor() [1/3]

  1. void OHOS::UICircleProgress::SetLineColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Sets the foreground color for this progress bar.

Parameters:

Name

Description

color Indicates the foreground color to set. For details, see ColorType.

SetLineColor() [2/3]

  1. void OHOS::UIAxis::SetLineColor (const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) & color)

Description:

Sets the line color of the coordinate axis.

Parameters:

Name

Description

color Indicates the line color to set. For details, see ColorType.

SetLineColor() [3/3]

  1. void OHOS::UIChartDataSerial::SetLineColor (const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) & color)

Description:

Sets the polyline color of the data set in the line chart.

This function applies only to line charts.

Parameters:

Name

Description

color Indicates the polyline color to set.

See also:

GetLineColor

SetLoopState() [1/3]

  1. void OHOS::UISwipeView::SetLoopState (bool loop)

Description:

Sets whether the swipe view supports a cycle swipe.

Parameters:

Name

Description

loop Indicates the cycle swipe flag. true indicates the cycle swipe is supported, and false indicates the opposite case.

SetLoopState() [2/3]

  1. void OHOS::UIPicker::SetLoopState (bool state)

Description:

Sets whether a picker can slide cyclically.

Parameters:

Name

Description

state Specifies whether the picker can slide cyclically. Value true indicates that the picker can slide cyclically, and value false indicates that the picker cannot slide cyclically. The default value is false.

SetLoopState() [3/3]

  1. void OHOS::UIList::SetLoopState (bool state)

Description:

Sets the loop state for this list, in which a loop scroll is possible since the top and bottom of the list are connected together.

Parameters:

Name

Description

state Indicates the loop state to set.

SetMajorAxisAlign()

  1. void OHOS::FlexLayout::SetMajorAxisAlign (const AlignType & align)

Description:

Sets the alignment mode of the primary axis (the axis where the layout direction is located). The child views in the layout are placed in this mode in the direction of the primary axis.

Parameters:

Name

Description

align Indicates the alignment mode to set. The value can be ALIGN_START, ALIGN_END, ALIGN_CENTER, ALIGN_EVENLY, ALIGN_AROUND, or ALIGN_BETWEEN.

SetMarkNum() [1/3]

  1. void OHOS::UIXAxis::SetMarkNum (uint16_t count)

Description:

Sets the number of scales on the x-axis.

For a bar chart, the number of scales must be the same as that of bars so that each bar can be properly displayed between two scales.

Implements OHOS::UIAxis.

Parameters:

Name

Description

count Indicates the number of scales to set. The default value is 5.

SetMarkNum() [2/3]

  1. void OHOS::UIYAxis::SetMarkNum (uint16_t count)

Description:

Sets the number of scales on the Y axis.

Implements OHOS::UIAxis.

Parameters:

Name

Description

count Indicates the number of scales to set. The default value is 5.

SetMarkNum() [3/3]

  1. virtual void OHOS::UIAxis::SetMarkNum (uint16_t count)

Description:

Sets the number of scales on a coordinate axis.

For a bar chart, the number of scales must be the same as that of bars so that each bar can be properly displayed between two scales.

Implemented in OHOS::UIYAxis, and OHOS::UIXAxis.

Parameters:

Name

Description

count Indicates the number of scales to set. The default value is 5.

SetMaxDataCount()

  1. bool OHOS::UIChartDataSerial::SetMaxDataCount (uint16_t maxCount)

Description:

Sets the maximum number of data points that can be stored in a data set.

This function must be called before data is added, deleted, or modified. Otherwise, data operations will fail.

Parameters:

Name

Description

maxCount Indicates the number of data points. The default value is 0.

Returns:

Returns true if the operation is successful; returns false otherwise.

SetMaxScrollDistance()

  1. void OHOS::UIAbstractScroll::SetMaxScrollDistance (uint16_t distance)

Description:

Sets the maximum scroll distance after a finger lifts the screen.

Parameters:

Name

Description

distance Indicates the maximum scroll distance to set. The default value is 0, indicating that the scroll distance is not limited.

SetName()

  1. void OHOS::UIRadioButton::SetName (const char * name)

Description:

Sets the name for this radio button.

Parameters:

Name

Description

name Indicates the name to set, which is a character string.

SetNextSibling()

  1. void OHOS::UIView::SetNextSibling ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * sibling)

Description:

Sets the next sibling view for the view.

Parameters:

Name

Description

sibling Indicates the pointer to the next sibling view to set.

SetOnChangeListener()

  1. void OHOS::UICheckBox::SetOnChangeListener ([OnChangeListener]($api-api-SmartVision-Devices-OHOS-UICheckBox-OnChangeListener.md) * onStateChangeListener)

Description:

Sets the listener for this check box.

The listener is triggered to invoke the callback function upon click events.

Parameters:

Name

Description

listener Indicates the listener to set. For details, see OnChangeListener.

SetOnClickListener() [1/2]

  1. void OHOS::UIView::SetOnClickListener ([OnClickListener]($api-api-SmartVision-Devices-OHOS-UIView-OnClickListener.md) * onClickListener)

Description:

Sets a click event listener for the view.

Parameters:

Name

Description

onClickListener Indicates the pointer to the click event listener to set.

SetOnClickListener() [2/2]

  1. void OHOS::TextAdapter::SetOnClickListener ([UIView::OnClickListener]($api-api-SmartVision-Devices-OHOS-UIView-OnClickListener.md) * clickListener)

Description:

Sets the callback function to be invoked upon a click event.

Parameters:

Name

Description

clickListener Indicates the pointer to the callback function.

SetOnDragListener()

  1. void OHOS::UIView::SetOnDragListener ([OnDragListener]($api-api-SmartVision-Devices-OHOS-UIView-OnDragListener.md) * onDragListener)

Description:

Sets a drag event listener for the view.

Parameters:

Name

Description

onDragListener Indicates the pointer to the drag event listener to set.

SetOnKeyActListener()

  1. void OHOS::RootView::SetOnKeyActListener ([OnKeyActListener]($api-api-SmartVision-Devices-OHOS-RootView-OnKeyActListener.md) * onKeyActListener)

Description:

Sets the listener that contains a callback to be invoked upon a physical key event.

Parameters:

Name

Description

onKeyActListener Indicates the pointer to the listener to set.

SetOnLongPressListener()

  1. void OHOS::UIView::SetOnLongPressListener ([OnLongPressListener]($api-api-SmartVision-Devices-OHOS-UIView-OnLongPressListener.md) * onLongPressListener)

Description:

Sets a long-press event listener for the view.

Parameters:

Name

Description

onLongPressListener Indicates the pointer to the long-press event listener to set.

SetOnSwipeListener()

  1. void OHOS::UISwipeView::SetOnSwipeListener ([OnSwipeListener]($api-api-SmartVision-Devices-OHOS-UISwipeView-OnSwipeListener.md) * onSwipeListener)

Description:

Sets the listener that contains a callback to be invoked upon a swipe event.

Parameters:

Name

Description

onSwipeListener Indicates the listener to set.

SetOnTouchListener()

  1. void OHOS::UIView::SetOnTouchListener ([OnTouchListener]($api-api-SmartVision-Devices-OHOS-UIView-OnTouchListener.md) * onTouchListener)

Description:

Sets a touch event listener for the view.

Parameters:

Name

Description

onTouchListener Indicates the pointer to the touch event listener to set.

SetOnVirtualDeviceEventListener()

  1. void OHOS::RootView::SetOnVirtualDeviceEventListener ([OnVirtualDeviceEventListener]($api-api-SmartVision-Devices-OHOS-RootView-OnVirtualDeviceEventListener.md) * onVirtualDeviceEventListener)

Description:

Sets a listener for monitoring the input events of a virtual device.

Parameters:

Name

Description

onVirtualDeviceEventListener Indicates the pointer to the listener to set.

SetOpacity() [1/2]

  1. void OHOS::UIDigitalClock::SetOpacity (uint8_t opacity)

Description:

Sets the opacity for this digital clock.

Parameters:

Name

Description

opacity Indicates the opacity of this digital clock. The value ranges from 0 (transparency) to 255 (opacity).

SetOpacity() [2/2]

  1. void OHOS::Paint::SetOpacity (uint8_t opacity)

Description:

Sets the opacity.

The setting takes effect for the entire graph, including the border, line color, and fill color.

Parameters:

Name

Description

opacity Indicates the opacity. The value range is [0, 255].

See also:

GetOpacity

SetParent()

  1. void OHOS::UIView::SetParent ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * parent)

Description:

Sets the parent view for the view.

Parameters:

Name

Description

parent Indicates the pointer to the parent view to set.

SetPeriod()

  1. void OHOS::Task::SetPeriod (uint32_t period)

Description:

Sets the running period for this task.

Parameters:

Name

Description

period Indicates the running period to set.

SetPivot()

  1. void OHOS::UITextureMapper::SetPivot (int16_t x, int16_t y )

Description:

Sets the coordinates of the rotation and scaling pivots for this image.

The coordinates represent the position relative to this image. For example, setting the x-coordinate and y-coordinate of the rotation or scaling center to the half of the image width and height respectively means the rotation or scaling is going to be performed around the center of this image.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.

SetPolygon()

  1. void OHOS::TransformMap::SetPolygon (const [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) & polygon)

Description:

Sets a polygon after rectangle transformation.

Parameters:

Name

Description

polygon Indicates the polygon to set.

SetPosition() [1/7]

  1. void OHOS::Rect::SetPosition (int16_t x, int16_t y )

Description:

Changes the coordinates of the left and top boundaries of the rectangle without changing the rectangle width and height.

Parameters:

Name

Description

x Indicates the coordinate of the left boundary.
y Indicates the coordinate of the top boundary.

SetPosition() [2/7]

  1. virtual void OHOS::UIView::SetPosition (int16_t x, int16_t y )

Description:

Sets the position for the view.

Reimplemented in OHOS::UIAnalogClock, and OHOS::UISurfaceView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.

SetPosition() [3/7]

  1. void OHOS::UISurfaceView::SetPosition (int16_t x, int16_t y )

Description:

Sets the position for this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.

SetPosition() [4/7]

  1. void OHOS::UIAnalogClock::SetPosition (int16_t x, int16_t y )

Description:

Sets the position for this analog clock.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.

SetPosition() [5/7]

  1. virtual void OHOS::UIView::SetPosition (int16_t x, int16_t y, int16_t width, int16_t height )

Description:

Adjusts the position and size of the view.

Reimplemented in OHOS::UIAnalogClock, and OHOS::UISurfaceView.

Parameters:

Name

Description

x Indicates the new x-coordinate.
y Indicates the new y-coordinate.
width Indicates the new width.
height Indicates the new height.

SetPosition() [6/7]

  1. void OHOS::UISurfaceView::SetPosition (int16_t x, int16_t y, int16_t width, int16_t height )

Description:

Sets the position and size for this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.
width Indicates the width to set.
height Indicates the height to set.

SetPosition() [7/7]

  1. void OHOS::UIAnalogClock::SetPosition (int16_t x, int16_t y, int16_t width, int16_t height )

Description:

Sets the position and size for this analog clock.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.
y Indicates the y-coordinate to set.
width Indicates the width to set.
height Indicates the height to set.

SetPreLastPoint()

  1. void OHOS::DragEvent::SetPreLastPoint (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & preLastPos)

Description:

Sets the coordinates of the stay position before the last position in the drag event.

Parameters:

Name

Description

preLastPos Indicates the coordinates of the stay position to set.

SetProgressImagePosition()

  1. void OHOS::UICircleProgress::SetProgressImagePosition (int16_t x, int16_t y )

Description:

Sets the coordinates of the foreground image for this progress bar relative to the view.

Parameters:

Name

Description

x Indicates the x-coordinate to set. The default value is 0.
y Indicates the y-coordinate to set. The default value is 0.

See also:

SetBackgroundImagePosition

SetRadius()

  1. void OHOS::UICircleProgress::SetRadius (uint16_t radius)

Description:

Sets the outer radius for this circular progress bar.

Parameters:

Name

Description

radius Indicates the outer radius to set.

See also:

GetRadius

SetRange()

  1. void OHOS::UIAbstractProgress::SetRange (int16_t rangeMax, int16_t rangeMin )

Description:

Sets the range for this progress bar.

rangeMin and rangeMax can be any value represented by int16_t. rangeMax must be greater than or equal to rangeMin. Otherwise, the setting does not take effect and the original value is used.

Parameters:

Name

Description

rangeMax Indicates the maximum value of this progress bar. The default value is 100.
rangeMin Indicates the minimum value of this progress bar. The default value is 0.

See also:

GetRangeMin | GetRangeMax

SetReboundSize()

  1. void OHOS::UIAbstractScroll::SetReboundSize (uint16_t size)

Description:

Sets the rebound size, which is the distance a knob moves after being released when it reaches the end of a scrollbar.

Parameters:

Name

Description

size Indicates the rebound size to set.

SetRect()

  1. void OHOS::Rect::SetRect (int16_t left, int16_t top, int16_t right, int16_t bottom )

Description:

Sets the coordinates of the four boundaries of a rectangle.

Parameters:

Name

Description

left Indicates the coordinate of the left boundary.
top Indicates the coordinate of the top boundary.
right Indicates the coordinate of the right boundary.
bottom Indicates the coordinate of the bottom boundary.

SetRepeat()

  1. void OHOS::UIImageAnimatorView::SetRepeat (bool repeat)

Description:

Sets whether to play this animator for infinite times.

Parameters:

Name

Description

repeat Specifies whether the animator is played for infinite times. true (default value) indicates the animator is played for infinite times, and false indicates the animator is played a specified number of times.

See also:

IsRepeat

SetRepeatTimes()

  1. void OHOS::UIImageAnimatorView::SetRepeatTimes (uint32_t times)

Description:

Sets the playback times for this animator.

This function takes effect only when repeat is set to false in SetRepeat.

Parameters:

Name

Description

times Indicates the playback times to set. The default value is 1.

See also:

GetRepeatTimes

SetReverse()

  1. void OHOS::UIImageAnimatorView::SetReverse (bool reverse)

Description:

Sets the playback sequence for this animator.

Parameters:

Name

Description

reverse Indicates the playback sequence to set. true indicates a reverse playback and false (default value) indicates a forward playback.

See also:

IsReverse

SetRight()

  1. void OHOS::Rect::SetRight (int16_t right)

Description:

Sets the coordinate of the right boundary of a rectangle.

Parameters:

Name

Description

right Indicates the coordinate of the right boundary.

SetRollSpeed()

  1. void OHOS::UILabel::SetRollSpeed (uint16_t speed)

Description:

Sets the scroll speed for this text.

Parameters:

Name

Description

speed Indicates the scroll speed to set.

SetRollStartPos()

  1. void OHOS::UILabel::SetRollStartPos (int16_t pos)

Description:

Sets the position where this text starts to roll.

Parameters:

Name

Description

pos Indicates the position to set.

SetRotateEnd()

  1. void OHOS::UITextureMapper::SetRotateEnd (int16_t end)

Description:

Sets the end angle of rotation for this image.

Parameters:

Name

Description

end Indicates the end angle of rotation to set. The default value is 0.

SetRotateStart()

  1. void OHOS::UITextureMapper::SetRotateStart (int16_t start)

Description:

Sets the start angle of rotation for this image.

By default, the image starts to rotate from the current angle of this stopped animator.

Parameters:

Name

Description

start Indicates the start angle to set. The default value is 0.

SetRows()

  1. void OHOS::GridLayout::SetRows (const uint16_t & rows)

Description:

Sets the number of rows in a grid.

Parameters:

Name

Description

rows Indicates the number of rows to set.

SetRunTime()

  1. void OHOS::Animator::SetRunTime (uint32_t runTime)

Description:

Sets the running time for this animator.

Parameters:

Name

Description

runTime Indicates the running time to set, in milliseconds.

See also:

GetRunTime

SetScaleEnd()

  1. void OHOS::UITextureMapper::SetScaleEnd (float end)

Description:

Sets the end ratio for scaling this image.

Parameters:

Name

Description

end Indicates the end ratio to set. The default value is 1.

SetScaleStart()

  1. void OHOS::UITextureMapper::SetScaleStart (float start)

Description:

Sets the start ratio for scaling this image.

By default, the image starts to scale from the current ratio of this stopped animator. The X and Y directions are scaled at the same ratio. Single-direction scaling is not supported.

Parameters:

Name

Description

start Indicates the start ratio to set. The default value is 1.

SetScrollbarWidth()

  1. void OHOS::UIScrollView::SetScrollbarWidth (uint8_t width)

Description:

Sets the width for this scroll bar.

Parameters:

Name

Description

width Indicates the width to set. The default value is DEFAULT_BAR_WIDTH.

SetScrollBlankSize()

  1. void OHOS::UIAbstractScroll::SetScrollBlankSize (uint16_t size)

Description:

Sets the blank size for this scroll view.

Parameters:

Name

Description

value Indicates the blank size to set. The default value is 0. Taking a vertical scroll as an example, the value 0 indicates that the head node can only scroll downwards the top of the view and the tail node scroll upwards the bottom; the value 10 indicates that the head node can continue scrolling down by 10 pixels after it reaches the top of the view.

SetScrollStateListener()

  1. void OHOS::UIList::SetScrollStateListener ([ListScrollListener]($api-api-SmartVision-Devices-OHOS-ListScrollListener.md) * scrollListener)

Description:

Sets the listener that contains a callback to be invoked when a child view is selected as this list scrolls.

Parameters:

Name

Description

scrollListener Indicates the listener to set.

SetSecondaryAxisAlign()

  1. void OHOS::FlexLayout::SetSecondaryAxisAlign (const AlignType & align)

Description:

Sets the alignment mode of the secondary axis (the axis perpendicular to the set layout direction).

Parameters:

Name

Description

align Indicates the alignment mode to set. The value can be ALIGN_START, ALIGN_CENTER, or ALIGN_END.

SetSelected() [1/2]

  1. bool OHOS::UITimePicker::SetSelected (const char * value)

Description:

Sets the time currently selected in the time picker.

Parameters:

Name

Description

value Indicates the pointer to the selected time, which is in the format of “hour:minute:second”, for example, 10:12:50. The second is optional and depends on the setting of EnableSecond. The time must be a valid value. For example, the hour value must range from 0 to 23.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetSelected() [2/2]

  1. bool OHOS::UIPicker::SetSelected (uint16_t index)

Description:

Sets the index of the item currently selected in the picker.

Parameters:

Name

Description

index Indicates the index to set.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetSelectPosition()

  1. void OHOS::UIList::SetSelectPosition (uint16_t position)

Description:

Sets the position where a child view is selected as this list scrolls.

When a child view is selected at the specified position, the callback ListScrollListener is invoked. You can implement the zoom-in and color-change effects in the callback.

Parameters:

Name

Description

position Indicates the position to set. The default value is 0, indicating that no position is set.

SetSizeFixed()

  1. void OHOS::UIImageAnimatorView::SetSizeFixed (bool fixed)

Description:

Sets whether the image size is fixed to the view size.

Parameters:

Name

Description

fixed Specifies whether the image size is fixed to the view size. The value true indicates the size of the image is the same as that of the view, and false indicates the position and size of this image need to be set in the ImageAnimatorInfo structure.

See also:

IsSizeFixed

SetSliderColor()

  1. void OHOS::UISlider::SetSliderColor (const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) backgroundColor, const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) foregroundColor, const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) knobColor )

Description:

Sets the colors for this slider, including the background, foreground, and knob colors.

Parameters:

Name

Description

backgroundColor Indicates the background color to set.
foregroundColor Indicates the foreground color to set.
knobColor Indicates the knob color to set.

SetSliderEventListener()

  1. void OHOS::UISlider::SetSliderEventListener ([UISliderEventListener]($api-api-SmartVision-Devices-OHOS-UISlider-UISliderEventListener.md) * listener)

Description:

Sets the listener for a slider change.

When a user drags or clicks the slider, listening is triggered and the OnChange callback is invoked. When a user releases the slider, the OnRelease callback is invoked.

Parameters:

Name

Description

listener Indicates the listener to set. For details, see UISliderEventListener.

SetSliderRadius()

  1. void OHOS::UISlider::SetSliderRadius (int16_t backgroundRadius, int16_t foregroundRadius, int16_t knobRadius )

Description:

Sets the corner radiuses for this slider, including the background, foreground, and knob corner radiuses.

Parameters:

Name

Description

backgroundRadius Indicates the background corner radius to set.
foregroundRadius Indicates the foreground corner radius to set.
knobRadius Indicates the knob corner radius to set.

SetSrc() [1/4]

  1. bool OHOS::Image::SetSrc (const char * src)

Description:

Sets the image path.

Parameters:

Name

Description

src Indicates the pointer to image path in the format of ..\xxx\xxx\xxx.bin.

Returns:

Returns true if the operation is successful; returns false if the operation fails.

SetSrc() [2/4]

  1. void OHOS::UIImageView::SetSrc (const char * src)

Description:

Sets the image path.

Parameters:

Name

Description

src Indicates the pointer to the image path represented by a string.

SetSrc() [3/4]

  1. bool OHOS::Image::SetSrc (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * src)

Description:

Sets the image information.

Parameters:

Name

Description

src Indicates the pointer to the image information.

Returns:

Returns true if the operation is successful; returns false if the operation fails.

SetSrc() [4/4]

  1. void OHOS::UIImageView::SetSrc (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * src)

Description:

Sets the image information.

Parameters:

Name

Description

src Indicates the pointer to the image information. For details, see ImageInfo.

SetStartAngle()

  1. void OHOS::UICircleProgress::SetStartAngle (int16_t startAngle)

Description:

Sets the start angle.

The 12-clock direction is 0 degrees, and the 3-clock direction is 90 degrees. If the start angle is smaller than the end angle, the progress bar is clockwise. Otherwise, the progress bar is anticlockwise. The maximum range of a progress bar is a circle. If the difference between the start angle and end angle exceeds 360 degrees, a circular progress bar is created.

Parameters:

Name

Description

startAngle Indicates the start angle to set, which can be any value represented by int16_t. The default value is 0.

See also:

GetStartAngle | SetEndAngle

SetStartIndex()

  1. void OHOS::UIList::SetStartIndex (uint16_t index)

Description:

Sets the start index for this list.

Parameters:

Name

Description

index Indicates the start index to set. The default value is 0.

SetStartPosition()

  1. void OHOS::UICanvas::SetStartPosition (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & startPoint)

Description:

Sets the coordinates of the start point for drawing a line. For example, if startPoint is set to {50, 50}, the line is drawn from this set of coordinates on the canvas.

Parameters:

Name

Description

startPoint Indicates the coordinates of the start point.

See also:

GetStartPosition

SetState() [1/3]

  1. void OHOS::UIToggleButton::SetState (bool state)

Description:

Sets the state for this toggle button.

Parameters:

Name

Description

state Indicates the state of this toggle button. The value true indicates the image displayed for On, and false indicates the image displayed for Off. If this function is not called, the image is displayed for Off.

SetState() [2/3]

  1. void OHOS::UICheckBox::SetState ([UICheckBoxState]($api-api-SmartVision-Devices-Graphic.md#ga15a3f0302aded0e4d1584ddc6002335d) state)

Description:

Sets the state for this check box.

Parameters:

Name

Description

state Indicates the state of this check box. For details, see UICheckBoxState.

SetState() [3/3]

  1. void OHOS::Animator::SetState (uint8_t state)

Description:

Sets the current state for this animator.

Parameters:

Name

Description

state Indicates the current animator state to set, which can be STOP, START, or PAUSE.

See also:

GetState

SetStateForStyle()

  1. void OHOS::UIButton::SetStateForStyle ([ButtonState]($api-api-SmartVision-Devices-Graphic.md#ga188dd55c17ee44be27fa80543f13f729) state)

Description:

Sets the state for a button. After the setting, calling SetStyle will change the style of this button, but not its state.

Parameters:

Name

Description

state Indicates the button state, as enumerated in ButtonState.

SetStep()

  1. void OHOS::UIAbstractProgress::SetStep (uint16_t step)

Description:

Sets the step for this progress bar.

The step is used to control the update frequency of the progress bar. When the value change exceeds the step, the progress bar is redrawn. For example, when the step is set to 10 and the current progress value is 5, the progress bar will not be redrawn if the progress value becomes 14, but will be redrawn if the progress value becomes 15. In addition, when its current value changes to be the maximum or minimum value, the progress bar is redrawn regardless of the step you set.

Parameters:

Name

Description

step Indicates the step to set. The default value is 1.

See also:

GetStep

SetStrokeColor()

  1. void OHOS::Paint::SetStrokeColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Sets the color of a line or border.

Parameters:

Name

Description

color Indicates the line color when a line is drawn or the border color when a closed graph is drawn.

See also:

GetStrokeColor

SetStrokeWidth()

  1. void OHOS::Paint::SetStrokeWidth (uint16_t width)

Description:

Sets the width of a line or border.

Parameters:

Name

Description

width Indicates the line width when a line is drawn or the border width when a closed graph is drawn. The width is extended to both sides.

See also:

GetStrokeWidth

SetStyle() [1/5]

  1. void OHOS::Paint::SetStyle ([PaintStyle]($api-api-SmartVision-Devices-Graphic.md#ga548320a469b7862fa416af062cad5d7a) style)

Description:

Sets the paint style of a closed graph.

Parameters:

Name

Description

style Indicates the paint style. Stroke and fill are set by default. For details, see PaintStyle.

See also:

GetStyle

SetStyle() [2/5]

  1. virtual void OHOS::UIView::SetStyle ([Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)

Description:

Sets the view style.

Parameters:

Name

Description

style Indicates the view style.

SetStyle() [3/5]

  1. void OHOS::Style::SetStyle (uint8_t key, int64_t value )

Description:

Sets a style.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetStyle() [4/5]

  1. virtual void OHOS::UIView::SetStyle (uint8_t key, int64_t value )

Description:

Sets a style.

Reimplemented in OHOS::UIButton.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetStyle() [5/5]

  1. void OHOS::UIButton::SetStyle (uint8_t key, int64_t value )

Description:

Sets a style.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.

SetStyleForState()

  1. void OHOS::UIButton::SetStyleForState (uint8_t key, int64_t value, [ButtonState]($api-api-SmartVision-Devices-Graphic.md#ga188dd55c17ee44be27fa80543f13f729) state )

Description:

Sets the style for a button in a specific state.

Parameters:

Name

Description

key Indicates the key of the style to set.
value Indicates the value matching the key.
state Indicates the button state, as enumerated in ButtonState.

SetSwipeACCLevel()

  1. void OHOS::UIAbstractScroll::SetSwipeACCLevel (uint16_t value)

Description:

Sets the compensation distance after a finger lifts the screen.

Parameters:

Name

Description

value Indicates the compensation distance to set. The default value is 0.

SetText() [1/5]

  1. void OHOS::UILabelButton::SetText (const char * text)

Description:

Sets the text for this label button.

Parameters:

Name

Description

text Indicates the pointer to the text.

SetText() [2/5]

  1. void OHOS::Text::SetText (const char * text)

Description:

Sets the content for this text.

Parameters:

Name

Description

text Indicates the pointer to the text content.

SetText() [3/5]

  1. void OHOS::UIDialog::SetText (const char * text)

Description:

Sets the text for this dialog box.

Parameters:

Name

Description

text Indicates the pointer to the text.

SetText() [4/5]

  1. void OHOS::UIArcLabel::SetText (const char * text)

Description:

Sets the text content for this arc label.

Parameters:

Name

Description

text Indicates the pointer to the text content.

SetText() [5/5]

  1. void OHOS::UILabel::SetText (const char * text)

Description:

Sets the text content for this label.

Parameters:

Name

Description

text Indicates the pointer to the text content.

SetTextColor() [1/3]

  1. void OHOS::UIPicker::SetTextColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) backgroundColor, [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) highlightColor )

Description:

Sets the text color.

Parameters:

Name

Description

backgroundColor Indicates the color of the background text.
highlightColor Indicates the color of the highlighted text.

SetTextColor() [2/3]

  1. void OHOS::UILabel::SetTextColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Sets the color for this text.

Parameters:

Name

Description

color Indicates the text color to set.

SetTextColor() [3/3]

  1. void OHOS::UILabelButton::SetTextColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)

Description:

Sets the color for this text.

Parameters:

Name

Description

color Indicates the text color to set.

SetTextFormatter() [1/2]

  1. void OHOS::TextAdapter::SetTextFormatter ([TextFormatter]($api-api-SmartVision-Devices-OHOS-TextFormatter.md) * formatter)

Description:

Sets the text formatter.

Parameters:

Name

Description

formatter Indicates the pointer to the text formatter. For details, see TextFormatter.

SetTextFormatter() [2/2]

  1. void OHOS::UIPicker::SetTextFormatter ([TextFormatter]($api-api-SmartVision-Devices-OHOS-TextFormatter.md) * formatter)

Description:

Sets the text formatter.

Parameters:

Name

Description

formatter Indicates the pointer to the text formatter. For details, see TextFormatter.

SetTextRotation() [1/2]

  1. void OHOS::Text::SetTextRotation (LabelRotateDegree angle)

Description:

Sets the clockwise rotation angle for this text.

Parameters:

Name

Description

angle Indicates the rotation angle to set. The value can be DEGREE_0, DEGREE_90, DEGREE_180, or DEGREE_270, as defined in LabelRotateDegree.

SetTextRotation() [2/2]

  1. void OHOS::UILabel::SetTextRotation (LabelRotateDegree angle)

Description:

Sets the clockwise rotation angle for this text.

Parameters:

Name

Description

angle Indicates the rotation angle to set. The value can be DEGREE_0, DEGREE_90, DEGREE_180, or DEGREE_270, as defined in LabelRotateDegree.

SetTextStyle()

  1. void OHOS::UITimePicker::SetTextStyle (uint8_t backgroundFontId, uint8_t highlightFontId, [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) backgroundColor, [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) highlightColor )

Description:

Sets the text format in the time picker, including the font ID and color.

Parameters:

Name

Description

backgroundFontId Indicates the font ID of the background text.
highlightFontId Indicates the font ID of the highlighted text.
backgroundColor Indicates the color of the background text.
highlightColor Indicates the color of the highlighted text.

SetThrowDrag()

  1. void OHOS::UIAbstractScroll::SetThrowDrag (bool throwDrag)

Description:

Sets whether to continue scrolling after a finger lifts the screen.

Parameters:

Name

Description

throwDrag Specifies whether to continue scrolling after a finger lifts the screen. true indicates the scroll continues, and false indicates the scroll stops immediately after a finger lifts.

SetTime()

  1. void OHOS::Animator::SetTime (uint32_t time)

Description:

Sets the total duration for this animator.

Parameters:

Name

Description

time Indicates the total duration to set, in milliseconds.

See also:

GetTime

SetTime12Hour()

  1. void OHOS::UIAbstractClock::SetTime12Hour (uint8_t hour, uint8_t minute, uint8_t second, bool am )

Description:

Sets the time in 12-hour format.

Parameters:

Name

Description

hour Indicates the hour to set, within [0, 11] after the modulo operation.
minute Indicates the minute to set, within [0, 59] after the modulo operation.
second Indicates the second to set, within [0, 59] after the modulo operation.
am Specifies whether it is in the morning. true indicates that it is in the morning, and false indicates that it is in the afternoon.

SetTime24Hour()

  1. void OHOS::UIAbstractClock::SetTime24Hour (uint8_t hour, uint8_t minute, uint8_t second )

Description:

Sets the time in 24-hour format.

Parameters:

Name

Description

hour Indicates the hour to set, within [0, 23] after the modulo operation.
minute Indicates the minute to set, within [0, 59] after the modulo operation.
second Indicates the second to set, within [0, 59] after the modulo operation.

SetTimeOfPause()

  1. void OHOS::UIImageAnimatorView::SetTimeOfPause (uint16_t timeOfPause)

Description:

Sets the interval between two playbacks of an infinitely repeated animator.

Parameters:

Name

Description

timeOfPause Indicates the interval between two playbacks of an infinitely repeated animator, in milliseconds. The default value is 0, indicating that there is no interval.

See also:

GetTimeOfPause

SetTimeOfUpdate()

  1. void OHOS::UIImageAnimatorView::SetTimeOfUpdate (uint16_t timeOfUpdate)

Description:

Sets the speed for this animator.

Parameters:

Name

Description

timeOfUpdate Indicates the interval for updating images, in milliseconds. The default value is 1.

See also:

GetTimeOfUpdate

SetTimeStamp()

  1. void OHOS::Event::SetTimeStamp (const TimeType & timeStamp)

Description:

Sets the timestamp when an event occurs.

Parameters:

Name

Description

timeStamp Indicates the timestamp of the event to set.

SetTitle()

  1. void OHOS::UIDialog::SetTitle (const char * title)

Description:

Sets the title for this dialog box.

Parameters:

Name

Description

title Indicates the pointer to the title.

SetTop()

  1. void OHOS::Rect::SetTop (int16_t top)

Description:

Sets the coordinate of the top boundary of a rectangle.

Parameters:

Name

Description

top Indicates the coordinate of the top boundary.

SetTopPointStyle()

  1. void OHOS::UIChartDataSerial::SetTopPointStyle (const [PointStyle]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial-PointStyle.md) & style)

Description:

Sets the style of the top point of a polyline.

Parameters:

Name

Description

style Indicates the style to set. For details, see PointStyle.

SetTouchable()

  1. void OHOS::UIView::SetTouchable (bool touch)

Description:

Sets whether the view is touchable.

Parameters:

Name

Description

touchable Specifies whether to set the view touchable. Value true means to set the view touchable, and false means the opposite.

SetTransformAlgorithm()

  1. void OHOS::UIImageView::SetTransformAlgorithm (TransformAlgorithm algorithm)

Description:

Sets the algorithm used for image rotation and scaling.

Parameters:

Name

Description

algorithm Indicates the image transformation algorithm. For details, see TransformAlgorithm.

SetTransformMap()

  1. void OHOS::UIView::SetTransformMap (const [TransformMap]($api-api-SmartVision-Devices-OHOS-TransformMap.md) & transMap)

Description:

Sets the affine transformation matrix.

Parameters:

Name

Description

transMap Indicates the transformation matrix.

SetValidHeight()

  1. void OHOS::UIBoxProgress::SetValidHeight (int16_t height)

Description:

Sets the actual height for this progress bar.

The progress bar is centered in the view after the setting. By default, the height of the progress bar is the same as that of the view. If the height of the progress bar is greater than that of the view, the excess part cannot be displayed.

Parameters:

Name

Description

height Indicates the actual height to set.

See also:

GetValidHeight

SetValidWidth()

  1. void OHOS::UIBoxProgress::SetValidWidth (int16_t width)

Description:

Sets the actual width for this progress bar.

The progress bar is centered in the view after the setting. By default, the width of the progress bar is the same as that of the view. If the width of the progress bar is greater than that of the view, the excess part cannot be displayed.

Parameters:

Name

Description

width Indicates the actual width of this progress bar.

See also:

GetValidWidth

SetValue()

  1. void OHOS::UIAbstractProgress::SetValue (int16_t value)

Description:

Sets the current value for this progress bar.

Parameters:

Name

Description

value Indicates the current value of this progress bar, within [rangeMin, rangeMax] specified by SetRange. If the value is less than rangeMin, rangeMin is used; if the value is greater than rangeMax, rangeMax is used.

See also:

SetRange | GetValue

SetValues() [1/2]

  1. bool OHOS::UIPicker::SetValues (const char * value[], uint16_t count )

Description:

Sets dynamic text data in the picker by using a string array.

Parameters:

Name

Description

value[] Indicates the array of text data.
count Indicates the array size.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetValues() [2/2]

  1. bool OHOS::UIPicker::SetValues (int16_t start, int16_t end )

Description:

Sets the numeric data in the picker by using a given numeric range.

All integers in the range are automatically generated based on the start value and end value and placed in the picker in sequence. The start value must be smaller or equal to the end value.

Parameters:

Name

Description

start Indicates the start integer.
end Indicates the end integer.

Returns:

Returns true if the setting is successful; returns false otherwise.

SetVertexNum()

  1. void OHOS::Polygon::SetVertexNum (uint8_t vertexNum)

Description:

Sets the number of vertices of a polygon.

Parameters:

Name

Description

vertexNum Indicates the number of vertices.

SetVerticalScrollState()

  1. void OHOS::UIScrollView::SetVerticalScrollState (bool state)

Description:

Sets whether a vertical scroll is enabled.

Parameters:

Name

Description

state Specifies whether a vertical scroll is enabled. true indicates a vertical scroll is enabled, and false indicates the opposite case.

SetViewId()

  1. void OHOS::UIView::SetViewId (const char * id)

Description:

Sets the view ID.

Parameters:

Name

Description

id Indicates the pointer to the view ID.

SetViewIndex()

  1. void OHOS::UIView::SetViewIndex (int16_t index)

Description:

Sets the view index.

Parameters:

Name

Description

index Indicates the view index to set.

SetVisible() [1/3]

  1. virtual void OHOS::UIView::SetVisible (bool visible)

Description:

Sets whether the view is visible.

Reimplemented in OHOS::UISurfaceView, and OHOS::UIDialog.

Parameters:

Name

Description

visible Specifies whether to set the view visible. Value true means to set the view visible, and false means the opposite.

SetVisible() [2/3]

  1. void OHOS::UIDialog::SetVisible (bool visible)

Description:

Sets whether a dialog box is visible.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

visible Specifies whether a dialog box is visible. The value true means visible, and false means invisible.

SetVisible() [3/3]

  1. void OHOS::UISurfaceView::SetVisible (bool visible)

Description:

Sets whether this view is visible.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

visible Specifies whether this view is visible. true indicates this view is visible, and false indicates the opposite case.

SetWidth() [1/10]

  1. void OHOS::TextAdapter::SetWidth (int16_t width)

Description:

Sets the width of UILabel constructed by the adapter.

Returns:

Returns the width of UILabel.

SetWidth() [2/10]

  1. void OHOS::Rect::SetWidth (int16_t width)

Description:

Changes the width of the rectangle without changing the coordinate of the left boundary.

Parameters:

Name

Description

width Indicates the width of the rectangle.

SetWidth() [3/10]

  1. virtual void OHOS::UIView::SetWidth (int16_t width)

Description:

Sets the width for the view.

Reimplemented in OHOS::UIChart, OHOS::UILabel, OHOS::UIButton, OHOS::UIPicker, OHOS::UITimePicker, OHOS::UISurfaceView, and OHOS::UIBoxProgress.

Parameters:

Name

Description

width Indicates the width to set.

SetWidth() [4/10]

  1. void OHOS::UIBoxProgress::SetWidth (int16_t width)

Description:

Sets the width for the view holding this progress bar.

The width of the view must be greater than or equal to the actual width of the progress bar to ensure a normal display. You need to call this function before calling SetValidWidth to set the actual width of the progress bar. Otherwise, the width of the progress bar is reset to width of the view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width of the view.

See also:

SetHeight | SetValidWidth | SetValidHeight

SetWidth() [5/10]

  1. void OHOS::UISurfaceView::SetWidth (int16_t width)

Description:

Sets the width for this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width to set.

SetWidth() [6/10]

  1. void OHOS::UITimePicker::SetWidth (int16_t width)

Description:

Sets the width for the time picker.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width to set.

SetWidth() [7/10]

  1. void OHOS::UIPicker::SetWidth (int16_t width)

Description:

Sets the width for this component.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width to set.

SetWidth() [8/10]

  1. void OHOS::UIButton::SetWidth (int16_t width)

Description:

Sets the width for this image.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width to set.

SetWidth() [9/10]

  1. void OHOS::UILabel::SetWidth (int16_t width)

Description:

Sets the width for this label.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width to set.

SetWidth() [10/10]

  1. void OHOS::UIChart::SetWidth (int16_t width)

Description:

Sets the width for this component.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

width Indicates the width to set.

SetWorkMode() [1/2]

  1. virtual void OHOS::UIAbstractClock::SetWorkMode ([WorkMode]($api-api-SmartVision-Devices-Graphic.md#ga19db90932bc71e6bbced6ccf2935ac98) newMode)

Description:

Sets the working mode for this clock.

Reimplemented in OHOS::UIAnalogClock.

Parameters:

Name

Description

newMode Indicates the working mode to set. For details, see WorkMode.

SetWorkMode() [2/2]

  1. void OHOS::UIAnalogClock::SetWorkMode ([WorkMode]($api-api-SmartVision-Devices-Graphic.md#ga19db90932bc71e6bbced6ccf2935ac98) newMode)

Description:

Sets the working mode for this analog clock.

Reimplemented from OHOS::UIAbstractClock.

Parameters:

Name

Description

newMode Indicates the working mode to set. For details, see WorkMode.

SetX() [1/3]

  1. void OHOS::Rect::SetX (int16_t x)

Description:

Changes the left boundary coordinate of the rectangle without changing the rectangle width.

Parameters:

Name

Description

x Indicates the coordinate of the left boundary.

SetX() [2/3]

  1. virtual void OHOS::UIView::SetX (int16_t x)

Description:

Sets the x-coordinate for the view.

Reimplemented in OHOS::UISurfaceView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.

SetX() [3/3]

  1. void OHOS::UISurfaceView::SetX (int16_t x)

Description:

Sets the x-coordinate for this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

x Indicates the x-coordinate to set.

SetXScrollBarVisible()

  1. void OHOS::UIScrollView::SetXScrollBarVisible (bool state)

Description:

Sets whether the horizontal scroll bar is visible.

Parameters:

Name

Description

state Specifies whether the horizontal scroll bar is visible. true indicates the horizontal scroll bar is visible, and false indicates the opposite case.

SetY() [1/3]

  1. void OHOS::Rect::SetY (int16_t y)

Description:

Changes the top boundary coordinate of the rectangle without changing the rectangle height.

Parameters:

Name

Description

y Indicates the coordinate of the top boundary.

SetY() [2/3]

  1. virtual void OHOS::UIView::SetY (int16_t y)

Description:

Sets the y-coordinate for the view.

Reimplemented in OHOS::UISurfaceView.

Parameters:

Name

Description

y Indicates the y-coordinate to set.

SetY() [3/3]

  1. void OHOS::UISurfaceView::SetY (int16_t y)

Description:

Sets the y-coordinate for this view.

Reimplemented from OHOS::UIView.

Parameters:

Name

Description

y Indicates the y-coordinate to set.

SetYScrollBarVisible()

  1. void OHOS::UIScrollView::SetYScrollBarVisible (bool state)

Description:

Sets whether the vertical scroll bar is visible.

Parameters:

Name

Description

state Specifies whether this vertical scroll bar is visible. true indicates the horizontal scroll bar is visible, and false indicates the opposite case.

Silver()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Silver ()

Description:

Obtains the color data of silver.

Returns:

Returns the color data.

SineEaseIn()

  1. static int16_t OHOS::EasingEquation::SineEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in shaping like a sinusoidal curve.

sin(t) is the equation for a sinusoidal easing. The animation starts slowly from zero velocity and accelerates fast towards the end. The acceleration change is similar to a sinusoidal curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

SineEaseOut | SineEaseInOut

SineEaseInOut()

  1. static int16_t OHOS::EasingEquation::SineEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases in and then out shaping like a sinusoidal curve.

sin(t) is the equation for a sinusoidal easing. The animation accelerates slowly until halfway and decelerates slowly towards the end. The acceleration change is similar to a sinusoidal curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

SineEaseIn | SineEaseOut

SineEaseOut()

  1. static int16_t OHOS::EasingEquation::SineEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime )

Description:

Eases out shaping like a sinusoidal curve.

sin(t) is the equation for a sinusoidal easing. The animation starts fast and decelerates slowly towards the end. The acceleration change is similar to a sinusoidal curve.

Parameters:

Name

Description

startPos Indicates the start value of this animation.
endPos Indicates the end value of this animation.
curTime Indicates the current time of this animation.
durationTime Indicates the total duration of this animation.

Returns:

Returns the value for the current time.

See also:

SineEaseIn | SineEaseInOut

Size()

  1. uint16_t [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Size () const

Description:

Obtains the size of a linked list.

Returns:

Returns the size of the linked list.

Start() [1/3]

  1. void OHOS::UITextureMapper::Start ()

Description:

Starts this animator.

Start() [2/3]

  1. void OHOS::Animator::Start ()

Description:

Starts this animator.

See also:

Stop

Start() [3/3]

  1. void OHOS::UIImageAnimatorView::Start ()

Description:

Starts this animator.

The forward playback starts from the first image and the reverse playback starts from the last image.

See also:

Stop

Stop() [1/2]

  1. void OHOS::Animator::Stop ()

Description:

Stops this animator.

See also:

Start

Stop() [2/2]

  1. void OHOS::UIImageAnimatorView::Stop (bool needReset = [/topic/body/section/screen/code
  2. {""}) true (code])

Description:

Stops this animator.

Parameters:

Name

Description

needReset Specifies whether the animator needs to be reset to the original one. true (default value) indicates the original image is displayed, and false indicates the current image is displayed.

See also:

Start

Style()

  1. OHOS::Style::Style ()

Description:

A constructor used to create a Style instance.

StyleDefault()

  1. OHOS::StyleDefault::StyleDefault ()

Description:

A constructor used to create a StyleDefault instance.

SuthHodgClip()

  1. [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) OHOS::SuthHodgClip (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & clipRect, const [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) & polygon )

Description:

Implements Sutherland-Hodgman, an algorithm used for clipping polygons.

Parameters:

Name

Description

clipRect Indicates the rectangle used for clipping the polygon.
polygon Indicates the polygon to clip.

Returns:

Returns the polygon after clipping.

Tail()

  1. [ListNode]($api-api-SmartVision-Devices-OHOS-ListNode-T.md)<T>* [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Tail () const

Description:

Obtains the tail node address of a linked list.

Returns:

Returns the tail node address.

Task()

  1. OHOS::Task::Task (uint32_t period)

Description:

A constructor used to create a Task instance with the specified running period.

Parameters:

Name

Description

period Indicates the running period of this task.

Teal()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Teal ()

Description:

Obtains the color data of teal.

Returns:

Returns the color data.

Text()

  1. OHOS::Text::Text ()

Description:

A constructor used to create a Text instance.

TextAdapter()

  1. OHOS::TextAdapter::TextAdapter ()

Description:

A constructor used to create a UILabel instance.

Theme()

  1. OHOS::Theme::Theme ()

Description:

A constructor used to create a Theme instance.

TransformMap() [1/2]

  1. OHOS::TransformMap::TransformMap ()

Description:

The default constructor used to create a TransformMap instance.

TransformMap() [2/2]

  1. OHOS::TransformMap::TransformMap (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect)

Description:

A constructor used to create a TransformMap instance.

Parameters:

Name

Description

rect Indicates the rectangle to transform.

Translate()

  1. [Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T > [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::Translate (const [Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T > & trans)

Description:

Obtains a matrix translation.

Parameters:

Name

Description

trans Indicates the distances to translate along the x-axis and y-axis.

Returns:

Returns the matrix after translation.

TranslateToPixel() [1/3]

  1. void OHOS::UIXAxis::TranslateToPixel (int16_t & value)

Description:

Translates data into the x coordinate of a pixel.

This function calculates the position of the corresponding pixel (relative position in the chart) based on the value of value and the data range of the x-axis.

Implements OHOS::UIAxis.

Parameters:

Name

Description

value Indicates the current value. The x coordinate obtained after translation is also printed using this parameter.

TranslateToPixel() [2/3]

  1. void OHOS::UIYAxis::TranslateToPixel (int16_t & value)

Description:

Translates data into the y coordinate of a pixel.

Calculates the position of the corresponding pixel (relative position in the chart) based on the value of value and the data range of the Y axis.

Implements OHOS::UIAxis.

Parameters:

Name

Description

value Indicates the current value. The y coordinate obtained after translation is also printed using this parameter.

TranslateToPixel() [3/3]

  1. virtual void OHOS::UIAxis::TranslateToPixel (int16_t & value)

Description:

Translates data into pixel coordinates.

This function calculates the relative position of a pixel in the corresponding UIChart based on the value of value and the data range of the coordinate axis.

Implemented in OHOS::UIYAxis, and OHOS::UIXAxis.

Parameters:

Name

Description

value Indicates the current value. The coordinate value obtained after translation is also printed using this parameter.

UIAbstractClock() [1/2]

  1. OHOS::UIAbstractClock::UIAbstractClock ()

Description:

A default constructor used to create a UIAbstractClock instance.

UIAbstractClock() [2/2]

  1. OHOS::UIAbstractClock::UIAbstractClock (uint8_t hour, uint8_t minute, uint8_t second )

Description:

A constructor used to create a UIAbstractClock instance with time elements (hour, minute and second).

Parameters:

Name

Description

hour Indicates the hour.
minute Indicates the minute.
second Indicates the second.

UIAbstractProgress()

  1. OHOS::UIAbstractProgress::UIAbstractProgress ()

Description:

A constructor used to create a UIAbstractProgress instance.

UIAbstractScroll()

  1. OHOS::UIAbstractScroll::UIAbstractScroll ()

Description:

A constructor used to create a UIAbstractScroll instance.

UIAnalogClock()

  1. OHOS::UIAnalogClock::UIAnalogClock ()

Description:

A default constructor used to create a UIAnalogClock instance.

UIArcLabel()

  1. OHOS::UIArcLabel::UIArcLabel ()

Description:

A default constructor used to create a UIArcLabel instance.

UIAxis()

  1. OHOS::UIAxis::UIAxis ()

Description:

A constructor used to create a UIAxis instance.

UIBoxProgress()

  1. OHOS::UIBoxProgress::UIBoxProgress ()

Description:

A constructor used to create a UIBoxProgress instance.

UIButton() [1/2]

  1. OHOS::UIButton::UIButton ()

Description:

A constructor used to create a UIButton instance.

UIButton() [2/2]

  1. OHOS::UIButton::UIButton (const char * id)

Description:

A constructor used to create a UIButton instance based on the button ID.

Buttons sharing the same ID are in the same batch.

Parameters:

Name

Description

id Indicates the button ID.

UICanvas()

  1. OHOS::UICanvas::UICanvas ()

Description:

A constructor used to create a UICanvas instance.

UIChart()

  1. OHOS::UIChart::UIChart ()

Description:

A constructor used to create a UIChart instance.

UIChartDataSerial()

  1. OHOS::UIChartDataSerial::UIChartDataSerial ()

Description:

A constructor used to create a UIChartDataSerial instance.

UIChartPillar()

  1. OHOS::UIChartPillar::UIChartPillar ()

Description:

A constructor used to create a UIChartPillar instance.

UIChartPolyline()

  1. OHOS::UIChartPolyline::UIChartPolyline ()

Description:

A constructor used to create a UIChartPolyline instance.

UICheckBox()

  1. OHOS::UICheckBox::UICheckBox ()

Description:

A constructor used to create a UICheckBox instance.

UICircleProgress()

  1. OHOS::UICircleProgress::UICircleProgress ()

Description:

A constructor used to create a UICircleProgress instance.

UIDialog()

  1. OHOS::UIDialog::UIDialog ()

Description:

A constructor used to create a UIDialog instance.

UIDigitalClock()

  1. OHOS::UIDigitalClock::UIDigitalClock ()

Description:

A default constructor used to create a UIDigitalClock instance.

UIFree()

  1. void OHOS::UIFree (void * buffer)

Description:

Releases memory for the graphics module. You can implement this function to override the free and delete functions.

Parameters:

Name

Description

buffer Indicates the pointer to the memory to be released.

UIImageAnimatorView()

  1. OHOS::UIImageAnimatorView::UIImageAnimatorView ()

Description:

A constructor used to create a UIImageAnimatorView instance.

UIImageView()

  1. OHOS::UIImageView::UIImageView ()

Description:

A default constructor used to create a UIImageView instance.

UILabel()

  1. OHOS::UILabel::UILabel ()

Description:

A constructor used to create a UILabel instance.

UILabelButton()

  1. OHOS::UILabelButton::UILabelButton ()

Description:

A constructor used to create a UILabelButton instance.

UIList() [1/2]

  1. OHOS::UIList::UIList ()

Description:

A constructor used to create a UIList instance in the vertical direction.

UIList() [2/2]

  1. OHOS::UIList::UIList (uint8_t direction)

Description:

A constructor used to create a UIList instance in the specified direction.

Parameters:

Name

Description

direction Indicates the UIList direction, either HORIZONTAL or VERTICAL.

UIMalloc()

  1. void* OHOS::UIMalloc (uint32_t size)

Description:

Applies for memory for the graphics module. You can implement this function to override the malloc and new functions.

Parameters:

Name

Description

size Indicates the size of the memory to apply for.

UIPicker()

  1. OHOS::UIPicker::UIPicker ()

Description:

A constructor used to create a UIPicker instance.

UIRadioButton()

  1. OHOS::UIRadioButton::UIRadioButton ()

Description:

A constructor used to create a UIRadioButton instance.

UIRepeatButton()

  1. OHOS::UIRepeatButton::UIRepeatButton ()

Description:

A constructor used to create a UIRepeatButton instance.

UIScrollView()

  1. OHOS::UIScrollView::UIScrollView ()

Description:

A constructor used to create a UIScrollView instance, with both horizontal and vertical scrolls supported.

UISlider()

  1. OHOS::UISlider::UISlider ()

Description:

A constructor used to create a UISlider instance.

UISurfaceView()

  1. OHOS::UISurfaceView::UISurfaceView ()

Description:

A constructor used to create a UISurfaceView instance.

UISwipeView()

  1. OHOS::UISwipeView::UISwipeView (uint8_t direction = [/topic/body/section/screen/code
  2. {""}) [HORIZONTAL]($api-api-SmartVision-Devices-Graphic.md#ga34dfbde0fad8baade31c02d9e8dd5026) (code])

Description:

A constructor used to create a UISwipeView instance.

UITextureMapper()

  1. OHOS::UITextureMapper::UITextureMapper ()

Description:

A constructor used to create a UITextureMapper instance.

UITimePicker()

  1. OHOS::UITimePicker::UITimePicker ()

Description:

A constructor used to create a UITimePicker instance.

UIToggleButton()

  1. OHOS::UIToggleButton::UIToggleButton ()

Description:

A constructor used to create a UIToggleButton instance.

UIView() [1/2]

  1. OHOS::UIView::UIView ()

Description:

A default constructor used to create an UIView instance.

UIView() [2/2]

  1. OHOS::UIView::UIView (const char * id)

Description:

A constructor used to create an UIView instance.

Parameters:

Name

Description

id Indicates the pointer to the view ID.

UIViewGroup()

  1. OHOS::UIViewGroup::UIViewGroup ()

Description:

A default constructor used to create a UIViewGroup instance.

UIXAxis()

  1. OHOS::UIXAxis::UIXAxis ()

Description:

A constructor used to create a UIXAxis instance.

UIYAxis()

  1. OHOS::UIYAxis::UIYAxis ()

Description:

A constructor used to create a UIYAxis instance.

UpdateClock() [1/3]

  1. virtual void OHOS::UIAbstractClock::UpdateClock (bool clockInit)

Description:

Updates this clock.

Reimplemented in OHOS::UIAnalogClock, and OHOS::UIDigitalClock.

Parameters:

Name

Description

clockInit Specifies whether it is the first initialization. true indicates it is the first initialization, and false indicates the opposite case.

UpdateClock() [2/3]

  1. void OHOS::UIDigitalClock::UpdateClock (bool clockInit)

Description:

Updates this digital clock.

Reimplemented from OHOS::UIAbstractClock.

Parameters:

Name

Description

clockInit Specifies whether the first initialization. true indicates the first initialization, and false indicates the opposite case.

UpdateClock() [3/3]

  1. void OHOS::UIAnalogClock::UpdateClock (bool clockInit)

Description:

Updates the time of this analog clock.

Reimplemented from OHOS::UIAbstractClock.

Parameters:

Name

Description

clockInit Specifies whether it is the first initialization. true indicates it is the first initialization, and false indicates the opposite case.

Vector2() [1/2]

  1. [OHOS::Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T >::[Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md) ()

Description:

A constructor used to create a Vector2 instance.

Vector2() [2/2]

  1. [OHOS::Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T >::[Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md) (T x, T y )

Description:

A constructor used to create a Vector2 instance based on the X and Y coordinates.

Parameters:

Name

Description

x Indicates the X coordinate.
y Indicates the Y coordinate.

Vector3() [1/2]

  1. [OHOS::Vector3]($api-api-SmartVision-Devices-OHOS-Vector3-T.md)< T >::[Vector3]($api-api-SmartVision-Devices-OHOS-Vector3-T.md) ()

Description:

A constructor used to create a Vector3 instance.

Vector3() [2/2]

  1. [OHOS::Vector3]($api-api-SmartVision-Devices-OHOS-Vector3-T.md)< T >::[Vector3]($api-api-SmartVision-Devices-OHOS-Vector3-T.md) (T x, T y, T z )

Description:

Defines a Vector3 instance and initializes the values of x, y, and z.

Parameters:

Name

Description

x Indicates the X coordinate.
y Indicates the Y coordinate.
z Indicates the Z coordinate.

VirtualDeviceEvent()

  1. OHOS::VirtualDeviceEvent::VirtualDeviceEvent (uint16_t type, uint16_t value )

Description:

A constructor used to create a VirtualDeviceEvent instance.

Parameters:

Name

Description

type Indicates the virtual device type. The options are AOD and PRIVATE.
value Indicates the virtual event value.

White()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::White ()

Description:

Obtains the color data of white.

Returns:

Returns the color data.

Yellow()

  1. static [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Color::Yellow ()

Description:

Obtains the color data of yellow.

Returns:

Returns the color data.

~AbstractAdapter()

  1. virtual OHOS::AbstractAdapter::~AbstractAdapter ()

Description:

A destructor used to delete the AbstractAdapter instance.

~Animator()

  1. virtual OHOS::Animator::~Animator ()

Description:

A destructor used to delete the Animator instance.

~AnimatorCallback()

  1. virtual OHOS::AnimatorCallback::~AnimatorCallback ()

Description:

A default destructor used to delete an AnimatorCallback instance.

~AnimatorStopListener() [1/2]

  1. virtual OHOS::UITextureMapper::AnimatorStopListener::~AnimatorStopListener ()

Description:

A destructor used to delete an AnimatorStopListener instance.

~AnimatorStopListener() [2/2]

  1. virtual OHOS::UIImageAnimatorView::AnimatorStopListener::~AnimatorStopListener ()

Description:

A destructor used to delete an AnimatorStopListener instance.

~CancelEvent()

  1. virtual OHOS::CancelEvent::~CancelEvent ()

Description:

A destructor used to delete the CancelEvent instance.

~ClickEvent()

  1. virtual OHOS::ClickEvent::~ClickEvent ()

Description:

A destructor used to delete the ClickEvent instance.

~DragEvent()

  1. virtual OHOS::DragEvent::~DragEvent ()

Description:

A destructor used to delete the DragEvent instance.

~Event()

  1. virtual OHOS::Event::~Event ()

Description:

A destructor used to delete the Event instance.

~FlexLayout()

  1. virtual OHOS::FlexLayout::~FlexLayout ()

Description:

A destructor used to delete the FlexLayout instance.

~GridLayout()

  1. virtual OHOS::GridLayout::~GridLayout ()

Description:

A destructor used to delete the GridLayout instance.

~Hand()

  1. virtual OHOS::UIAnalogClock::Hand::~Hand ()

Description:

A destructor used to delete the Hand instance.

~Image()

  1. virtual OHOS::Image::~Image ()

Description:

A destructor used to delete the Image instance.

~KeyEvent()

  1. OHOS::KeyEvent::~KeyEvent ()

Description:

A destructor used to delete the KeyEvent instance.

~Layout()

  1. virtual OHOS::Layout::~Layout ()

Description:

A destructor used to delete the Layout instance.

~Line()

  1. OHOS::Line::~Line ()

Description:

A destructor used to delete the Line instance.

~List()

  1. virtual [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::~[List]($api-api-SmartVision-Devices-OHOS-List-T.md) ()

Description:

A destructor used to delete the List instance.

~ListScrollListener()

  1. virtual OHOS::ListScrollListener::~ListScrollListener ()

Description:

A destructor used to delete the ListScrollListener instance.

~LongPressEvent()

  1. virtual OHOS::LongPressEvent::~LongPressEvent ()

Description:

A destructor used to delete the LongPressEvent instance.

~Matrix3()

  1. [OHOS::Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md)< T >::~[Matrix3]($api-api-SmartVision-Devices-OHOS-Matrix3-T.md) ()

Description:

A destructor used to delete the Matrix3 instance.

~OnChangeListener()

  1. virtual OHOS::UICheckBox::OnChangeListener::~OnChangeListener ()

Description:

A destructor used to delete the OnChangeListener instance.

~OnClickListener()

  1. virtual OHOS::UIView::OnClickListener::~OnClickListener ()

Description:

A destructor used to delete the OnClickListener instance.

~OnDragListener()

  1. virtual OHOS::UIView::OnDragListener::~OnDragListener ()

Description:

A destructor used to delete the OnDragListener instance.

~OnFPSChangedListener()

  1. virtual OHOS::SysInfo::OnFPSChangedListener::~OnFPSChangedListener ()

Description:

A destructor used to delete the OnFPSChangedListener instance.

~OnLongPressListener()

  1. virtual OHOS::UIView::OnLongPressListener::~OnLongPressListener ()

Description:

A destructor used to delete the OnLongPressListener instance.

~OnScrollListener()

  1. virtual OHOS::UIScrollView::OnScrollListener::~OnScrollListener ()

Description:

A destructor used to delete the OnScrollListener instance.

~OnTouchListener()

  1. virtual OHOS::UIView::OnTouchListener::~OnTouchListener ()

Description:

A destructor used to delete the OnTouchListener instance.

~Paint()

  1. virtual OHOS::Paint::~Paint ()

Description:

A destructor used to delete the Paint instance.

~Polygon()

  1. OHOS::Polygon::~Polygon ()

Description:

A destructor used to delete the Polygon instance.

~PressEvent()

  1. virtual OHOS::PressEvent::~PressEvent ()

Description:

A destructor used to delete the PressEvent instance.

~Rect()

  1. OHOS::Rect::~Rect ()

Description:

A destructor used to delete the Rect instance.

~ReleaseEvent()

  1. virtual OHOS::ReleaseEvent::~ReleaseEvent ()

Description:

A destructor used to delete the ReleaseEvent instance.

~SelectedListener() [1/2]

  1. OHOS::UITimePicker::SelectedListener::~SelectedListener ()

Description:

A destructor used to delete the SelectedListener instance.

~SelectedListener() [2/2]

  1. virtual OHOS::UIPicker::SelectedListener::~SelectedListener ()

Description:

A destructor used to delete the SelectedListener instance.

~Style()

  1. virtual OHOS::Style::~Style ()

Description:

A destructor used to delete the Style instance.

~StyleDefault()

  1. OHOS::StyleDefault::~StyleDefault ()

Description:

A destructor used to delete the StyleDefault instance.

~Text()

  1. virtual OHOS::Text::~Text ()

Description:

A destructor used to delete the Text instance.

~TextAdapter()

  1. virtual OHOS::TextAdapter::~TextAdapter ()

Description:

A destructor used to delete the UILabel instance.

~Theme()

  1. virtual OHOS::Theme::~Theme ()

Description:

A destructor used to delete the Theme instance.

~TransformMap()

  1. OHOS::TransformMap::~TransformMap ()

Description:

A destructor used to delete the TransformMap instance.

~UIAbstractClock()

  1. virtual OHOS::UIAbstractClock::~UIAbstractClock ()

Description:

A destructor used to delete the UIAbstractClock instance.

~UIAbstractProgress()

  1. virtual OHOS::UIAbstractProgress::~UIAbstractProgress ()

Description:

A destructor used to delete the UIAbstractProgress instance.

~UIAbstractScroll()

  1. virtual OHOS::UIAbstractScroll::~UIAbstractScroll ()

Description:

A destructor used to delete the UIAbstractScroll instance.

~UIAnalogClock()

  1. virtual OHOS::UIAnalogClock::~UIAnalogClock ()

Description:

A destructor used to delete the UIAnalogClock instance.

~UIArcLabel()

  1. virtual OHOS::UIArcLabel::~UIArcLabel ()

Description:

A destructor used to delete the UIArcLabel instance.

~UIAxis()

  1. virtual OHOS::UIAxis::~UIAxis ()

Description:

A destructor used to delete the UIAxis instance.

~UIBoxProgress()

  1. virtual OHOS::UIBoxProgress::~UIBoxProgress ()

Description:

A destructor used to delete the UIBoxProgress instance.

~UIButton()

  1. virtual OHOS::UIButton::~UIButton ()

Description:

A destructor used to delete the UIButton instance.

~UICanvas()

  1. virtual OHOS::UICanvas::~UICanvas ()

Description:

A destructor used to delete the UICanvas instance.

~UIChart()

  1. virtual OHOS::UIChart::~UIChart ()

Description:

A destructor used to delete the UIChart instance.

~UIChartDataSerial()

  1. virtual OHOS::UIChartDataSerial::~UIChartDataSerial ()

Description:

A destructor used to delete the UIChartDataSerial instance.

~UIChartPillar()

  1. virtual OHOS::UIChartPillar::~UIChartPillar ()

Description:

A destructor used to delete the UIChartPillar instance.

~UIChartPolyline()

  1. virtual OHOS::UIChartPolyline::~UIChartPolyline ()

Description:

A destructor used to delete the UIChartPolyline instance.

~UICheckBox()

  1. virtual OHOS::UICheckBox::~UICheckBox ()

Description:

A destructor used to delete the UICheckBox instance.

~UICircleProgress()

  1. virtual OHOS::UICircleProgress::~UICircleProgress ()

Description:

A destructor used to delete the UICircleProgress instance.

~UIDialog()

  1. virtual OHOS::UIDialog::~UIDialog ()

Description:

A destructor used to delete the UIDialog instance.

~UIDigitalClock()

  1. virtual OHOS::UIDigitalClock::~UIDigitalClock ()

Description:

A destructor used to delete the UIDigitalClock instance.

~UIImageAnimatorView()

  1. virtual OHOS::UIImageAnimatorView::~UIImageAnimatorView ()

Description:

A destructor used to delete the UIImageAnimatorView instance.

~UIImageView()

  1. virtual OHOS::UIImageView::~UIImageView ()

Description:

A destructor used to delete the UIImageView instance.

~UILabel()

  1. virtual OHOS::UILabel::~UILabel ()

Description:

A destructor used to delete the UILabel instance.

~UILabelButton()

  1. virtual OHOS::UILabelButton::~UILabelButton ()

Description:

A destructor used to delete the UILabelButton instance.

~UIList()

  1. virtual OHOS::UIList::~UIList ()

Description:

A destructor used to delete the UIList instance.

~UIPicker()

  1. virtual OHOS::UIPicker::~UIPicker ()

Description:

A destructor used to delete the UIPicker instance.

~UIRadioButton()

  1. virtual OHOS::UIRadioButton::~UIRadioButton ()

Description:

A destructor used to delete the UIRadioButton instance.

~UIRepeatButton()

  1. virtual OHOS::UIRepeatButton::~UIRepeatButton ()

Description:

A destructor used to delete the UIRepeatButton instance.

~UIScrollView()

  1. virtual OHOS::UIScrollView::~UIScrollView ()

Description:

A destructor used to delete the UIScrollView instance.

~UISlider()

  1. virtual OHOS::UISlider::~UISlider ()

Description:

A destructor used to delete the UISlider instance.

~UISliderEventListener()

  1. virtual OHOS::UISlider::UISliderEventListener::~UISliderEventListener ()

Description:

A destructor used to delete the UISliderEventListener instance.

~UISurfaceView()

  1. OHOS::UISurfaceView::~UISurfaceView ()

Description:

A destructor used to delete the UISurfaceView instance.

~UISwipeView()

  1. virtual OHOS::UISwipeView::~UISwipeView ()

Description:

A destructor used to delete the UISwipeView instance.

~UITextureMapper()

  1. virtual OHOS::UITextureMapper::~UITextureMapper ()

Description:

A destructor used to delete the UITextureMapper instance.

~UITimePicker()

  1. virtual OHOS::UITimePicker::~UITimePicker ()

Description:

A destructor used to delete the UITimePicker instance.

~UIToggleButton()

  1. virtual OHOS::UIToggleButton::~UIToggleButton ()

Description:

A destructor used to delete the UIToggleButton instance.

~UIView()

  1. virtual OHOS::UIView::~UIView ()

Description:

A destructor used to delete the UIView instance.

~UIViewGroup()

  1. virtual OHOS::UIViewGroup::~UIViewGroup ()

Description:

A destructor used to delete the UIViewGroup instance.

~UIXAxis()

  1. virtual OHOS::UIXAxis::~UIXAxis ()

Description:

A destructor used to delete the UIXAxis instance.

~UIYAxis()

  1. virtual OHOS::UIYAxis::~UIYAxis ()

Description:

A destructor used to delete the UIYAxis instance.

~Vector2()

  1. [OHOS::Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md)< T >::~[Vector2]($api-api-SmartVision-Devices-OHOS-Vector2-T.md) ()

Description:

A destructor used to delete the Vector2 instance.

~Vector3()

  1. [OHOS::Vector3]($api-api-SmartVision-Devices-OHOS-Vector3-T.md)< T >::~[Vector3]($api-api-SmartVision-Devices-OHOS-Vector3-T.md) ()

Description:

A destructor used to delete the Vector3 instance.

~VirtualDeviceEvent()

  1. OHOS::VirtualDeviceEvent::~VirtualDeviceEvent ()

Description:

A destructor used to delete the VirtualDeviceEvent instance.

Variable Documentation

align

  1. [UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::UICanvas::FontStyle::align

Description:

Text alignment mode. For details, see UITextLanguageAlignment.

alpha [1/2]

  1. uint8_t OHOS::Color32::alpha

Description:

Alpha (how opaque each pixel is)

alpha [2/2]

  1. uint8_t { ... } ::alpha

Description:

Alpha (how opaque each pixel is)

ANIMATOR_TIME

  1. constexpr static uint16_t OHOS::UISwipeView::ANIMATOR_TIME = 12

Description:

Indicates that the animation duration is 12 ticks.

blue [1/5]

  1. uint16_t { ... } ::blue

Description:

Blue

blue [2/5]

  1. uint16_t OHOS::Color16::blue

Description:

Blue

blue [3/5]

  1. uint8_t OHOS::Color24::blue

Description:

Blue

blue [4/5]

  1. uint8_t OHOS::Color32::blue

Description:

Blue

blue [5/5]

  1. uint8_t { ... } ::blue

Description:

Blue

CIRCLE_IN_DEGREE

  1. constexpr uint16_t OHOS::CIRCLE_IN_DEGREE = 360

Description:

A full rotation: 360 degrees

colorMode

  1. uint32_t OHOS::ImageHeader::colorMode

Description:

Color format, which is used to match image type. This variable is important.

data

  1. const uint8_t* OHOS::ImageInfo::data

Description:

Pixel color data of pixelmap images

dataSize

  1. uint32_t OHOS::ImageInfo::dataSize

Description:

Size of the image data (in bytes)

DEFAULT_BLANK_SIZE

  1. constexpr static uint16_t OHOS::UISwipeView::DEFAULT_BLANK_SIZE = 30

Description:

Indicates the maximum distance between the first and the last tab when the current view is not in a cycle swipe mode. The page can be rebound after the setting.

direct

  1. [UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) OHOS::UICanvas::FontStyle::direct

Description:

Text direction. For details, see UITextLanguageDirect.

fillColor

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIChartDataSerial::PointStyle::fillColor

Description:

Fill color

fontName

  1. const char* OHOS::UICanvas::FontStyle::fontName

Description:

Font name

fontSize

  1. uint8_t OHOS::UICanvas::FontStyle::fontSize

Description:

Font size

full [1/2]

  1. uint16_t OHOS::Color16::full

Description:

Full RGB data

full [2/2]

  1. uint32_t OHOS::Color32::full

Description:

Full RGB data

green [1/5]

  1. uint16_t { ... } ::green

Description:

Green

green [2/5]

  1. uint16_t OHOS::Color16::green

Description:

Green

green [3/5]

  1. uint8_t OHOS::Color24::green

Description:

Green

green [4/5]

  1. uint8_t { ... } ::green

Description:

Green

green [5/5]

  1. uint8_t OHOS::Color32::green

Description:

Green

header

  1. [ImageHeader]($api-api-SmartVision-Devices-OHOS-ImageHeader.md) OHOS::ImageInfo::header

Description:

Image head node information. For details, see ImageHeader.

height [1/2]

  1. uint16_t OHOS::ImageHeader::height

Description:

Image height

height [2/2]

  1. int16_t OHOS::ImageAnimatorInfo::height

Description:

Image height

HORIZONTAL

  1. constexpr uint8_t OHOS::UISwipeView::HORIZONTAL = 0

Description:

Indicates the horizontal direction.

imageInfo

  1. const char* OHOS::ImageAnimatorInfo::imageInfo

Description:

Image path or pointer to the ImageInfo structure

inactive

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md) OHOS::ButtonStyle::inactive

Description:

Style when inactive

letterSpace

  1. int16_t OHOS::UICanvas::FontStyle::letterSpace

Description:

Letter-spacing

MAX_VERTEX_NUM

  1. const uint8_t OHOS::Polygon::MAX_VERTEX_NUM = 8

Description:

Maximum number of vertices in a polygon

pos

  1. [Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::ImageAnimatorInfo::pos

Description:

Image start position, relative to this view

pressed

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md) OHOS::ButtonStyle::pressed

Description:

Style when pressed

QUARTER_IN_DEGREE

  1. constexpr uint16_t OHOS::QUARTER_IN_DEGREE = 90

Description:

A quarter of a rotation: 90 degrees

radius

  1. uint16_t OHOS::UIChartDataSerial::PointStyle::radius

Description:

Inner radius

red [1/5]

  1. uint16_t OHOS::Color16::red

Description:

Red

red [2/5]

  1. uint16_t { ... } ::red

Description:

Red

red [3/5]

  1. uint8_t OHOS::Color24::red

Description:

Red

red [4/5]

  1. uint8_t OHOS::Color32::red

Description:

Red

red [5/5]

  1. uint8_t { ... } ::red

Description:

Red

released

  1. [Style]($api-api-SmartVision-Devices-OHOS-Style.md) OHOS::ButtonStyle::released

Description:

Style when released

SEMICIRCLE_IN_DEGREE

  1. constexpr uint16_t OHOS::SEMICIRCLE_IN_DEGREE = 180

Description:

A half of a rotation: 180 degrees

STOP_DISTANCE

  1. constexpr static uint16_t OHOS::UISwipeView::STOP_DISTANCE = 5

Description:

Indicates the maximum distance of an invalid dragging. Dragging is not triggered if the distance is less than this value.

strokeColor

  1. [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIChartDataSerial::PointStyle::strokeColor

Description:

Border color

strokeWidth

  1. uint16_t OHOS::UIChartDataSerial::PointStyle::strokeWidth

Description:

Border width, which extends outwards from the inner radius

TEXT_ELLIPSIS_END_INV

  1. constexpr uint16_t OHOS::Text::TEXT_ELLIPSIS_END_INV = 0xFFFF

Description:

Invalid value for the ellipsis position

THREE_QUARTER_IN_DEGREE

  1. constexpr uint16_t OHOS::THREE_QUARTER_IN_DEGREE = 270

Description:

Three fourths of a rotation: 270 degrees

UI_PI

  1. constexpr double OHOS::UI_PI = 3.14159265358979

Description:

Pi value

userData

  1. void* OHOS::ImageInfo::userData

Description:

User-defined data

VERTICAL

  1. constexpr uint8_t OHOS::UISwipeView::VERTICAL = 1

Description:

Indicates the vertical direction.

width [1/2]

uint16_t OHOS::ImageHeader::width

Description:

Image width

width [2/2]

int16_t OHOS::ImageAnimatorInfo::width

Description:

Image width

x

int16_t OHOS::Point::x

Description:

X coordinate

y

int16_t OHOS::Point::y

Description:

Y coordinate