Graphic
Since:
1.0
Version:
1.0
Summary
Files
Data Structures
Defines functions for specifying the velocity of an animation. |
|
Converts colors in different formats and defines common colors. |
|
Represents basic image attributes, including the image type and path. |
|
Represents the class of the graphics module. This class provides functions for setting the running period and time of a task. |
|
Represents the base class of , providing the text attribute setting and text drawing capabilities for components that require font display. |
|
Defines the base class for adapters. You can derive based on actual requirements and use the GetView() and functions to implement adapters of different data types. For details, see TextAdapter. |
|
Listens for the input events triggered by a virtual device other than human touching or physical pressing. |
|
Defines the functions related to a root view which contains its child views and represents the root node in a tree structure. |
|
Defines a text formatter. You can inherit this class and implement the function. |
|
Defines a text adapter, which implements instance construction and supports text data and continuous integer data. |
|
An abstract class that contains functions for converting units of time (hour, minute, and second), setting and obtaining the time. |
|
Represents the abstract base class which provides functions related to the progress bar. |
|
Defines the attributes of a scroll, including the scroll direction, blank size of a scroll view, velocity and effects of a scroll animation. |
|
Defines the basic attributes of the analog clock hands. This is an inner class of UIAbstractClock. |
|
Stores the attribute information about this arc text to draw. |
|
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 . |
|
Defines the unique attributes and functions for the x-axis. This class is used in . |
|
Defines the unique attributes and functions for the y-axis. This class is used in . |
|
Defines a canvas, which is used to draw multiple types of 2D graphs. |
|
Defines the style for the top, bottom, and frontmost points in a line chart. |
|
Defines a data set and provides functions such as adding and deleting data points. |
|
Defines the chart class and provides functions such as adding and deleting data sets to display a chart. |
|
Represents a listener that contains a callback to be invoked when this animator stops. |
|
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. |
|
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}. |
|
Represents a scrollable list which is used with the adapter 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. |
|
Defines the listener used by a picker. This listener is triggered when an item is selected after sliding stops. |
|
Defines a picker. Multiple texts or numbers can be put into a sliding list for selection. The selected text or numbers are highlighted. |
|
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. |
|
Supports horizontal or vertical scroll of child views. This class is inherited from UIAbstractScroll. |
|
Represents a surface view that interacts with the multimedia to achieve camera preview and video playback. |
|
Represents a listener that contains a callback to be invoked when this animator stops. |
|
Defines the listener used by the time picker. This listener is triggered when an item is selected after sliding stops. |
|
Defines the time picker. The time is in the format of “hour:minute” or “hour:minute:second”. The selected time is highlighted. |
|
Defines a click event listener. You need to register this listener with the view to listen to click events. |
|
Defines a long-press event listener. You need to register this listener with the view to listen to long-press events. |
|
Defines a drag event listener. You need to register this listener with the view to listen to drag events. |
|
Defines a touch event listener. You need to register this listener with the view to listen to touch events. |
|
Defines the base class of a view, providing basic view attributes and operations. All views are derived from this class. |
|
Provides functions for exporting information about a specified DOM node or information about the DOM tree starting from a specified DOM node. |
|
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. |
|
Defines a click event, which indicates that a finger is pressed on the screen and then lifted within 1 second. |
|
Defines a drag event, which indicates a certain movement (more than 10 pixels) after a view is pressed. |
|
Defines the base class of a user input event and provides functions to record information such as the event position and timestamp. |
|
Defines a key event, which indicates that a physical button is pressed or released. |
|
Defines a long-press event, which indicates that the finger is not raised or moved within 1 second after a view is pressed. |
|
Defines a touch event, which indicates that the touchscreen or mouse is pressed. |
|
Defines a release event, which indicates that the touchscreen or mouse is released. |
|
Defines a virtual device event, which is used to receive a customized input event and call back the listening function registered. |
|
Defines a polygon, including vertex coordinates and the maximum number of vertices (defined by ). |
|
Defines the two-dimensional vector, and provides basic mathematical operations such as vector assignment, scalar product, cross product, addition, and subtraction. |
|
Defines the 3-dimensional vector, and provides basic operators such as [] and ==. |
|
Defines the base class, overriding the new and delete functions. |
|
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. |
|
Defines a grid layout container. You can perform simple grid layout on child views that the container holds. |
|
Defines the base class of the layout, which indicates the basic data types and operations that may be used in the layout. |
|
Stores linked list data and contains pointers to the previous node and the next node. |
|
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. |
|
Defines a rectangle, including the position data of the four boundaries of the rectangle, and provides functions for rectangle inclusion, intersection, and aggregation. |
|
Defines the basic attributes and functions of a style. You can use this class to set different styles. |
|
Obtains the system information. Currently, the FPS information can be obtained. To enable the FPS feature, enable the ENABLE_FPS_SUPPORT macro. |
|
Defines the theme class used to define the functions related to the styles of different components. |
|
Declares the singleton class used to manage the current screen theme of an application. |
|
Macros
DMA2D hardware acceleration, which does not take effect on other platforms. |
|
DMA2D hardware acceleration for font rendering, which does not take effect on other platforms. |
|
Advanced algorithm for line breaks, which is disabled by default on other platforms. |
|
Multi-window, which is enabled by default on other platforms. |
|
Display buffer for rendering data refresh, which is disabled by default on other platforms. |
|
Vector type font,which is enabled by default on other platforms. |
|
Graphics rendering hardware acceleration, which is enabled by default. |
|
Memory hook, which is enabled by default. The system memory allocation is taken over after it is enabled. |
|
Function for monitoring the image refresh frame rate, which is disabled by default. |
|
Rectangle anti-aliasing, which is disabled by default. |
|
Font color mode, which is disabled by default. After it is enabled, the font color mode is set to 4 to accelerate font rendering. |
|
Log function of a graphics subsystem, which is disabled by default. |
|
Function for receiving input events in screen-off mode, which is disabled by default. |
|
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. |
|
Defines the color depth of graphics rendering. The default value is 32 bits. The value can be 16 or 32. |
|
Typedefs
OHOS::EasingFunc) (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
Enumerations
Functions
(UIView view)=0 |
Called when each frame starts. This is a pure virtual function, which needs your inheritance and implementation. |
(UIView &view) |
Called when an animator stops. This is a pure virtual function, which needs your inheritance and implementation. |
A default destructor used to delete an AnimatorCallback instance. |
|
A default constructor used to create an Animator instance. |
|
(AnimatorCallback callback, view, uint32_t time, bool repeat) |
|
OHOS::Animator::GetState () const |
|
OHOS::Animator::GetTime () const |
|
(uint32_t time) |
|
OHOS::Animator::SetRunTime (uint32_t runTime) |
|
Obtains the AnimatorManager instance. |
|
(Animator animator) |
Adds the instance to the AnimatorManager linked list for management, so that the Run function of the class is called once for each frame. |
OHOS::AnimatorManager::Remove (const animator) |
Removes the Animator instance from the linked list. |
OHOS::EasingEquation::SetBackOvershoot (double overshoot) |
Sets the parameter s in the equation (s+1)t^3 - st^2 for a back easing. |
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::BackEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::CircEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::CircEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::CubicEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::LinearEaseNone (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::QuadEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::QuintEaseIn (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::QuintEaseInOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::EasingEquation::SineEaseOut (int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
(int16_t startPos, int16_t endPos, uint16_t curTime, uint16_t durationTime) |
|
OHOS::Interpolation::GetBezierInterpolation (int16_t t, int16_t u0, int16_t u1, int16_t u2, int16_t u3) |
|
(ColorType c1, c2, uint8_t mix) |
static ColorType Mixes two colors (color 1 and color 2) based on a specified opacity. |
static ColorType |
|
static ColorType |
|
(ColorType color) |
|
(Color16 color, uint8_t alpha) |
Converts color data with the 16-bit color depth into the RGBA8888 format. |
(Color32 color) |
Converts color data from the RGBA8888 format into the RGB565 format. |
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
static ColorType |
|
A constructor used to create an Image instance. You can use this constructor when a component requires a map. |
|
A destructor used to delete the Image instance. |
|
const ImageInfo |
|
OHOS::Image::GetHeader ( &header) const |
Obtains the basic image information, including the image format, width, and height. |
OHOS::Image::GetSrcType () const |
|
OHOS::Image::SetSrc (const src) |
|
Obtains a singleton Screen instance. |
|
OHOS::Task::Task (uint32_t period) |
A constructor used to create a instance with the specified running period. |
A destructor used to delete the Task instance. |
|
OHOS::Task::SetLastRun (uint32_t lastRun) |
|
OHOS::Task::GetLastRun () const |
|
A constructor used to create a Text instance. |
|
A destructor used to delete the Text instance. |
|
OHOS::Text::GetText () const |
|
OHOS::Text::SetFontId (uint8_t fontId) |
|
OHOS::Text::SetDirect ( direct) |
|
OHOS::Text::GetDirect () const |
|
OHOS::Text::SetAlign ( horizontalAlign, UITextLanguageAlignment verticalAlign=TEXT_ALIGNMENT_TOP) |
|
OHOS::Text::GetTextRotation () const |
|
OHOS::Text::GetTextSize () const |
|
OHOS::Text::SetExpandWidth (bool expand) |
|
OHOS::Text::SetExpandHeight (bool expand) |
|
OHOS::Text::GetEllipsisIndex (const &textRect, const Style &style) |
Obtains the index of the character from where text will be replaced by ellipses based on the text rectangle and style. |
A constructor used to create an AbstractAdapter instance. |
|
A destructor used to delete the AbstractAdapter instance. |
|
OHOS::AbstractAdapter::GetView ( inView, int16_t index)=0 |
Obtains a UIView instance to convert adapter data into another instance. |
Obtains a singleton RootView instance. |
|
(UIView &view, const &event)=0 |
|
OHOS::RootView::GetViewType () const override |
|
(const KeyEvent &event) |
|
(OnKeyActListener onKeyActListener) |
Sets the listener that contains a callback to be invoked upon a physical key event. |
OHOS::RootView::OnVirtualDeviceEventListener::OnVirtualDeviceEvent ( &view, VirtualDeviceEvent event)=0 |
|
(const VirtualDeviceEvent &event) |
|
(OnVirtualDeviceEventListener onVirtualDeviceEventListener) |
Sets a listener for monitoring the input events of a virtual device. |
Clears the listener for monitoring the input events of a virtual device. |
|
OHOS::RootView::FindSubView (const &parentView, const UIView subView) |
Checks whether the target view is one of the child views of the specified parent view. |
Converts the input integer into a character string for output. |
|
OHOS::TextAdapter::GetView ( inView, int16_t index) override |
Obtains a UILabel instance to convert adapter data into another instance. |
OHOS::TextAdapter::SetData (< const char > data) |
Sets the UILabel adapter data, which is a string linked list. |
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) |
|
OHOS::TextAdapter::SetFont (const char name, uint8_t size) |
|
Style & |
|
OHOS::TextAdapter::GetCount () override |
|
OHOS::TextAdapter::SetWidth (int16_t width) |
|
OHOS::TextAdapter::SetDirect ( direct) |
Sets the direction of the UILabel constructed by the adapter. |
Sets the height of the UILabel constructed by the adapter. |
|
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. |
|
(UIView::OnClickListener clickListener) |
Sets the callback function to be invoked upon a click event. |
(TextFormatter formatter) |
|
A default constructor used to create a UIAbstractClock instance. |
|
A constructor used to create a UIAbstractClock instance with time elements (hour, minute and second). |
|
A destructor used to delete the UIAbstractClock instance. |
|
OHOS::UIAbstractClock::SetTime24Hour (uint8_t hour, uint8_t minute, uint8_t second) |
|
OHOS::UIAbstractClock::UpdateClock (bool clockInit) |
|
(WorkMode newMode) |
|
virtual WorkMode |
|
A constructor used to create a UIAbstractProgress instance. |
|
A destructor used to delete the UIAbstractProgress instance. |
|
OHOS::UIAbstractProgress::EnableBackground (bool enable) |
|
OHOS::UIAbstractProgress::GetValue () const |
|
OHOS::UIAbstractProgress::SetImage (const char foregroundImage, const char backgroundImage=nullptr) |
|
(const ImageInfo foregroundImage, const backgroundImage=nullptr) |
|
OHOS::UIAbstractProgress::SetStep (uint16_t step) |
|
OHOS::UIAbstractProgress::SetBackgroundStyle (const &style) |
|
OHOS::UIAbstractProgress::SetBackgroundStyle (uint8_t key, int64_t value) |
|
const Style & |
|
Obtains the value of a background style of this progress bar. |
|
OHOS::UIAbstractProgress::SetForegroundStyle (const &style) |
|
OHOS::UIAbstractProgress::SetForegroundStyle (uint8_t key, int64_t value) |
|
const Style & |
|
Obtains the value of a foreground style of this progress bar. |
|
Sets the type of caps on the background and foreground of the progress bar. |
|
OHOS::UIAbstractScroll::GetViewType () const override |
|
OHOS::UIAbstractScroll::SetScrollBlankSize (uint16_t size) |
|
Sets the maximum scroll distance after a finger lifts the screen. |
|
OHOS::UIAbstractScroll::SetReboundSize (uint16_t size) |
Sets the rebound size, which is the distance a knob moves after being released when it reaches the end of a scrollbar. |
Obtains the maximum scroll distance after a finger lifts the screen. |
|
OHOS::UIAbstractScroll::SetDragFunc (EasingFunc func) |
Sets the easing function that specifies a scroll animation after a finger lifts the screen. |
Sets whether to continue scrolling after a finger lifts the screen. |
|
OHOS::UIAbstractScroll::MoveChildByOffset (int16_t offsetX, int16_t offsetY) override |
|
Sets the compensation distance after a finger lifts the screen. |
|
Obtains the compensation distance after a finger lifts the screen. |
|
A default constructor used to create a UIAnalogClock instance. |
|
A destructor used to delete the UIAnalogClock instance. |
|
A default constructor used to create a Hand instance. |
|
A destructor used to delete the Hand instance. |
|
OHOS::UIAnalogClock::SetHandImage ( type, const UIImageView &img, position, Point center) |
|
(HandType type, position, Point center, color, uint16_t width, uint16_t height, OpacityType opacity) |
|
OHOS::UIAnalogClock::GetHandRotateCenter ( type) const |
|
(HandType type) const |
|
OHOS::UIAnalogClock::GetHandInitAngle ( type) const |
Obtains the initial rotation angle of the specified clock hand. |
OHOS::UIAnalogClock::GetHandCurrentAngle ( type) const |
Obtains the current rotation angle of the specified clock hand. |
OHOS::UIAnalogClock::SetInitTime24Hour (uint8_t hour, uint8_t minute, uint8_t second) |
|
OHOS::UIAnalogClock::OnDraw (const &invalidatedArea) override |
|
OHOS::UIAnalogClock::OnPostDraw (const &invalidatedArea) override |
|
OHOS::UIAnalogClock::SetPosition (int16_t x, int16_t y) override |
|
(int16_t x, int16_t y, int16_t width, int16_t height) override |
|
OHOS::UIAnalogClock::SetWorkMode ( newMode) override |
|
OHOS::UIAnalogClock::UpdateClock (bool clockInit) override |
|
A default constructor used to create a UIArcLabel instance. |
|
A destructor used to delete the UIArcLabel instance. |
|
OHOS::UIArcLabel::GetWidth () override |
|
OHOS::UIArcLabel::SetText (const char text) |
|
OHOS::UIArcLabel::SetAlign ( horizontalAlign) |
|
OHOS::UIArcLabel::GetHorAlign () const |
|
OHOS::UIArcLabel::SetFontId (uint8_t fontId) |
|
OHOS::UIArcLabel::SetFont (const char name, uint8_t size) |
|
OHOS::UIArcLabel::GetArcTextCenter () const |
|
OHOS::UIArcLabel::SetArcTextRadius (uint16_t radius) |
|
OHOS::UIArcLabel::SetArcTextAngle (int16_t startAngle, int16_t endAngle) |
|
OHOS::UIArcLabel::GetArcTextEndAngle () const |
|
(TextOrientation orientation) |
|
(const Rect &invalidatedArea) override |
|
A constructor used to create a UIAxis instance. |
|
A destructor used to delete the UIAxis instance. |
|
OHOS::UIAxis::SetDataRange (uint16_t min, uint16_t max)=0 |
|
OHOS::UIAxis::SetLineColor (const &color) |
|
OHOS::UIAxis::OnDraw (const &invalidatedArea) override |
|
OHOS::UIAxis::OnPreDraw (const &invalidatedArea) override |
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 |
|
A constructor used to create a UIXAxis instance. |
|
A destructor used to delete the UIXAxis instance. |
|
OHOS::UIXAxis::SetDataRange (uint16_t min, uint16_t max) override |
|
OHOS::UIYAxis::TranslateToPixel (int16_t &value) override |
|
OHOS::UIYAxis::SetMarkNum (uint16_t count) override |
|
A constructor used to create a UIBoxProgress instance. |
|
A destructor used to delete the UIBoxProgress instance. |
|
OHOS::UIBoxProgress::SetWidth (int16_t width) override |
|
OHOS::UIBoxProgress::SetDirection (const &direction) |
|
OHOS::UIBoxProgress::GetDirection () const |
|
OHOS::UIBoxProgress::SetValidWidth (int16_t width) |
|
OHOS::UIBoxProgress::SetValidHeight (int16_t height) |
|
OHOS::UIBoxProgress::OnDraw (const &invalidatedArea) override |
|
OHOS::UIButton::UIButton (const char id) |
A constructor used to create a instance based on the button ID. |
OHOS::UIButton::GetViewType () const override |
|
(const Rect &invalidatedArea) override |
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. |
(const Rect &invalidatedArea) override |
|
(const PressEvent &event) override |
|
(const ReleaseEvent &event) override |
|
(const CancelEvent &event) override |
|
OHOS::UIButton::SetImageSrc (const defaultImgSrc, const ImageInfo triggeredImgSrc) |
|
OHOS::UIButton::GetImageX () const |
|
OHOS::UIButton::GetCurImageSrc () const |
|
OHOS::UIButton::GetWidth () override |
|
OHOS::UIButton::SetWidth (int16_t width) override |
|
OHOS::UIButton::GetContentRect () override |
Obtains a rectangular area that contains coordinate information. |
OHOS::UIButton::GetStyle (uint8_t key) const override |
|
OHOS::UIButton::GetStyleForState (uint8_t key, state) const |
|
OHOS::UIButton::SetStyleForState (uint8_t key, int64_t value, state) |
|
OHOS::UIButton::SetStateForStyle ( state) |
Sets the state for a button. After the setting, calling SetStyle will change the style of this button, but not its state. |
A constructor used to create a Paint instance. |
|
A destructor used to delete the Paint instance. |
|
(PaintStyle style) |
|
OHOS::Paint::GetStrokeWidth () const |
|
(ColorType color) |
|
(ColorType color) |
|
OHOS::Paint::GetOpacity () const |
|
A constructor used to create a UICanvas instance. |
|
A destructor used to delete the UICanvas instance. |
|
(const Point &startPoint) |
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. |
const Point & |
|
(const Point &endPoint, const &paint) |
|
OHOS::UICanvas::DrawLine (const &startPoint, const Point &endPoint, const &paint) |
Draws a straight line from the coordinates of the start point. |
OHOS::UICanvas::DrawCurve (const &control1, const Point &control2, const &endPoint, const Paint &paint) |
|
(const Point &startPoint, const &control1, const Point &control2, const &endPoint, const Paint &paint) |
Draws a cubic Bezier curve from the start point coordinates. |
(const Point &startPoint, int16_t height, int16_t width, const &paint) |
|
OHOS::UICanvas::DrawCircle (const ¢er, uint16_t radius, const Paint &paint) |
|
(const Point ¢er, uint16_t radius, int16_t startAngle, int16_t endAngle, const &paint) |
|
OHOS::UICanvas::DrawArc (const ¢er, uint16_t radius, int16_t startAngle, int16_t endAngle, const Paint &paint) |
|
(const Point &startPoint, const char image, const &paint) |
|
OHOS::UICanvas::DrawLabel (const &startPoint, const char text, uint16_t maxWidth, const FontStyle &fontStyle, const &paint) |
|
OHOS::UICanvas::OnDraw (const &invalidatedArea) override |
|
OHOS::UIChartDataSerial::SetMaxDataCount (uint16_t maxCount) |
Sets the maximum number of data points that can be stored in a data set. |
(uint16_t index, const &point) |
|
OHOS::UIChartDataSerial::GetPoint (uint16_t , Point &point) |
Obtains the coordinates in the chart for a data point in the data set. |
(const Point data, uint16_t count) |
|
Obtains the number of data points available in the data set. |
|
OHOS::UIChartDataSerial::IsSmooth () const |
|
OHOS::UIChartDataSerial::IsGradient () const |
|
Obtains the index of the frontmost point (the latest added or modified data point in a data set). |
|
OHOS::UIChartDataSerial::GetPeakData () const |
|
OHOS::UIChartDataSerial::SetFillColor (const &color) |
|
OHOS::UIChartDataSerial::SetLineColor (const &color) |
|
OHOS::UIChartDataSerial::HidePoint (uint16_t , uint16_t count) |
|
OHOS::UIChartDataSerial::SetHeadPointStyle (const &style) |
|
OHOS::UIChartDataSerial::SetTopPointStyle (const &style) |
|
OHOS::UIChartDataSerial::SetBottomPointStyle (const &style) |
|
OHOS::UIChartDataSerial::EnableHeadPoint (bool enable) |
Enables the feature of drawing the frontmost point on a polyline. |
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) |
Enables the feature of drawing the bottom point of a polyline. If there are multiple bottom points, only the first one is drawn. |
A constructor used to create a UIChart instance. |
|
A destructor used to delete the UIChart instance. |
|
OHOS::UIChart::SetHeight (int16_t height) override |
|
OHOS::UIChart::OnPreDraw (const &invalidatedArea) override |
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 &invalidatedArea) override |
|
OHOS::UIChart::AddDataSerial ( dataSerial) |
|
OHOS::UIChart::DeleteDataSerial ( dataSerial) |
|
OHOS::UIChart::EnableReverse (bool enable) |
|
A constructor used to create a UIChartPillar instance. |
|
A destructor used to delete the UIChartPillar instance. |
|
OHOS::UIChartPolyline::RefreshChart () override |
|
OHOS::UIChartPolyline::SetGradientBottom (uint16_t bottom) |
Sets the distance between the bottom edge of the fill color range and the x-axis. |
A constructor used to create a UICheckBox instance. |
|
A destructor used to delete the UICheckBox instance. |
|
(UICheckBoxState state)=0 |
Called when the state of this check box is switched. This is a virtual function, which needs your implementation. |
A destructor used to delete the OnChangeListener instance. |
|
OHOS::UICheckBox::SetOnChangeListener ( onStateChangeListener) |
|
OHOS::UICheckBox::OnPreDraw (const &invalidatedArea) override |
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 &invalidatedArea) override |
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 &event) override |
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) |
|
(const ImageInfo selectedImageSrc, const unselectedImageSrc) |
|
OHOS::UICheckBox::GetState () const |
|
OHOS::UICheckBox::SetState ( state) |
|
OHOS::UICircleProgress::GetViewType () const override |
|
(const Rect &invalidatedArea) override |
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. |
(const Rect &invalidatedArea) override |
|
Sets the coordinates of the center point for this circular progress bar. |
|
Obtains the coordinates of the center point for this circular progress bar. |
|
OHOS::UICircleProgress::SetRadius (uint16_t radius) |
|
OHOS::UICircleProgress::SetStartAngle (int16_t startAngle) |
|
OHOS::UICircleProgress::SetEndAngle (int16_t endAngle) |
|
OHOS::UICircleProgress::SetProgressImagePosition (int16_t x, int16_t y) |
Sets the coordinates of the foreground image for this progress bar relative to the view. |
Sets the coordinates of the background image for this progress bar relative to the view. |
|
OHOS::UICircleProgress::SetLineColor ( color) |
|
OHOS::UIDialog::GetViewType () const override |
|
OHOS::UIDialog::SetText (const char text) |
|
(const Rect &invalidatedArea) override |
Checks whether this label needs to be covered before drawing it. |
(DialogButtonType buttonType, const char text, listener) |
|
OHOS::UIDialog::SetVisible (bool visible) override |
|
A default constructor used to create a UIDigitalClock instance. |
|
A destructor used to delete the UIDigitalClock instance. |
|
OHOS::UIDigitalClock::SetFontId (uint8_t fontId) |
|
OHOS::UIDigitalClock::SetColor ( color) |
|
OHOS::UIDigitalClock::GetDisplayMode () const |
|
OHOS::UIDigitalClock::DisplayLeadingZero (bool displayLeadingZero) |
Sets whether to add 0 before the hour of this digital clock. |
OHOS::UIDigitalClock::GetOpacity () const |
|
OHOS::UIImageAnimatorView::GetViewType () const override |
|
(const char imageSrc, uint8_t imageNum, uint16_t timeOfUpdate) |
|
OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char imageSrc, uint8_t imageNum) |
|
Sets the interval between two playbacks of an infinitely repeated animator. |
|
Obtains the interval between two playbacks of an infinitely repeated animator. |
|
const ImageAnimatorInfo |
|
OHOS::UIImageAnimatorView::SetSizeFixed (bool fixed) |
|
OHOS::UIImageAnimatorView::SetRepeat (bool repeat) |
|
OHOS::UIImageAnimatorView::SetRepeatTimes (uint32_t ) |
|
OHOS::UIImageAnimatorView::SetReverse (bool reverse) |
|
OHOS::UIImageAnimatorView::AnimatorStopListener::~AnimatorStopListener () |
|
OHOS::UIImageAnimatorView::AnimatorStopListener::OnAnimatorStop ( &view) |
|
OHOS::UIImageAnimatorView::SetAnimatorStopListener ( listener) |
|
OHOS::UIImageView::GetViewType () const override |
|
OHOS::UIImageView::GetHeight () override |
|
(const Rect &invalidatedArea) override |
Checks whether this image view needs to be covered to optimize the drawing process. |
(const Rect &invalidatedArea) override |
|
OHOS::UIImageView::SetSrc (const src) |
|
OHOS::UIImageView::SetAutoEnable (bool enable) |
Sets whether the image view size needs to be adaptive to the image size. |
Sets the blur level for this image when it is rotated or scaled. |
|
OHOS::UIImageView::GetBlurLevel () const |
Obtains the blur level of this image when it is rotated or scaled. |
OHOS::UIImageView::GetImageInfo () const |
|
OHOS::UIImageView::GetSrcType () const |
|
A constructor used to create a UILabel instance. |
|
A destructor used to delete the UILabel instance. |
|
OHOS::UILabel::GetWidth () override |
|
OHOS::UILabel::OnPreDraw (const &invalidatedArea) override |
Checks whether this label needs to be covered before drawing it. |
OHOS::UILabel::OnDraw (const &invalidatedArea) override |
|
OHOS::UILabel::SetText (const char text) |
|
OHOS::UILabel::SetLineBreakMode (const uint8_t lineBreakMode) |
|
OHOS::UILabel::SetTextColor ( color) |
|
OHOS::UILabel::GetTextColor () const |
|
OHOS::UILabel::SetAlign ( horizontalAlign, UITextLanguageAlignment verticalAlign=TEXT_ALIGNMENT_TOP) |
|
(UITextLanguageDirect direct) |
|
OHOS::UILabel::GetFontId () const |
|
OHOS::UILabel::SetRollSpeed (uint16_t speed) |
|
OHOS::UILabel::GetRollStartPos () const |
|
OHOS::UILabel::SetHeight (int16_t height) override |
|
OHOS::UILabel::GetTextRotation () const |
|
OHOS::UILabelButton::OnDraw (const &invalidatedArea) override |
|
OHOS::UILabelButton::GetViewType () const override |
|
OHOS::UILabelButton::GetText () const |
|
Sets the position for this label relative to the button holding it. |
|
Obtains the position of this label relative to the button holding it. |
|
OHOS::UILabelButton::SetAlign ( align) |
|
OHOS::UILabelButton::GetAlign () const |
|
OHOS::UILabelButton::SetDirect ( direct) |
|
OHOS::UILabelButton::GetDirect () const |
|
OHOS::UILabelButton::SetLabelStyle ( &labelStyle) |
|
OHOS::UILabelButton::SetLabelStyle (uint8_t key, int64_t value) |
|
const Style & |
|
OHOS::UILabelButton::SetTextColor ( color) |
|
OHOS::UILabelButton::SetFont (const char name, uint8_t size) |
|
OHOS::UILabelButton::GetFontId () const |
|
A constructor used to create a ListScrollListener instance with the default state SCROLL_STATE_STOP. |
|
A destructor used to delete the ListScrollListener instance. |
|
(int16_t index, view) |
|
OHOS::ListScrollListener::OnScrollEnd (int16_t , UIView view) |
|
(int16_t index, view) |
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. |
A constructor used to create a UIList instance in the vertical direction. |
|
A constructor used to create a UIList instance in the specified direction. |
|
A destructor used to delete the UIList instance. |
|
OHOS::UIList::OnDragEvent (const &event) override |
|
OHOS::UIList::OnDragEndEvent (const &event) override |
|
OHOS::UIList::OnPressEvent (const &event) override |
|
OHOS::UIList::SetAdapter ( adapter) |
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 |
|
(uint16_t index) |
Scrolls to change the index of the first row or column of the current view. |
OHOS::UIList::SetStartIndex (uint16_t ) |
|
OHOS::UIList::GetStartIndex () const |
Obtains the start index of this list. The default value is 0. |
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 |
|
Sets the position where a child view is selected as this list scrolls. |
|
Obtains the child view being selected at the preset position. |
|
OHOS::UIList::SetScrollStateListener ( scrollListener) |
Sets the listener that contains a callback to be invoked when a child view is selected as this list scrolls. |
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. |
|
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 |
|
A constructor used to create a UIPicker instance. |
|
A destructor used to delete the UIPicker instance. |
|
OHOS::UIPicker::OnPreDraw (const &invalidatedArea) override |
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) |
Sets dynamic text data in the picker by using a string array. |
Sets the numeric data in the picker by using a given numeric range. |
|
Sets the font IDs of dynamic text, which is the string array set through SetValues. |
|
OHOS::UIPicker::GetHighlightFontId () const |
|
(ColorType backgroundColor, highlightColor) |
|
OHOS::UIPicker::SetSelected (uint16_t ) |
Sets the index of the item currently selected in the picker. |
OHOS::UIPicker::GetSelected () const |
Obtains the index of the item currently selected in the picker. |
OHOS::UIPicker::SetWidth (int16_t width) override |
|
OHOS::UIPicker::SetLoopState (bool state) |
|
A constructor used to create a SelectedListener instance. |
|
A destructor used to delete the SelectedListener instance. |
|
(UIPicker &picker) |
Called when an item is selected after sliding stops. This function is implemented by applications. |
(SelectedListener pickerListener) |
|
(UITextLanguageDirect direct) |
|
(TextFormatter formatter) |
|
A constructor used to create a UIRadioButton instance. |
|
A destructor used to delete the UIRadioButton instance. |
|
OHOS::UIRadioButton::OnPreDraw (const &invalidatedArea) override |
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 &event) override |
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) |
|
OHOS::UIRepeatButton::GetViewType () const override |
|
OHOS::UIRepeatButton::GetInterval () const |
|
(const ClickEvent &event) override |
|
(const ReleaseEvent &event) override |
|
(const LongPressEvent &event) override |
|
A constructor used to create an OnScrollListener instance with the default scroll state SCROLL_STATE_STOP. |
|
A destructor used to delete the OnScrollListener instance. |
|
A constructor used to create a instance, with both horizontal and vertical scrolls supported. |
|
OHOS::UIScrollView::GetViewType () const override |
|
(const Rect &invalidatedArea) override |
|
(const DragEvent &event) override |
|
(const DragEvent &event) override |
|
(const PressEvent &event) override |
|
OHOS::UIScrollView::SetScrollbarWidth (uint8_t width) |
|
OHOS::UIScrollView::SetYScrollBarVisible (bool state) |
|
(OnScrollListener scrollListener) |
Registers a listener that contains a callback to be invoked upon scroll state changes. |
A constructor used to create a UISlider instance. |
|
A destructor used to delete the UISlider instance. |
|
OHOS::UISlider::SetKnobWidth (int16_t width) |
|
OHOS::UISlider::SetImage (const backgroundImage, const ImageInfo foregroundImage, const knobImage) |
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) |
Sets the images for this slider, including the background, foreground, and knob images. |
(const ColorType backgroundColor, const foregroundColor, const ColorType knobColor) |
Sets the colors for this slider, including the background, foreground, and knob colors. |
(int16_t backgroundRadius, int16_t foregroundRadius, int16_t knobRadius) |
Sets the corner radiuses for this slider, including the background, foreground, and knob corner radiuses. |
OHOS::UISlider::SetKnobStyle (const &style) |
|
OHOS::UISlider::SetKnobStyle (uint8_t key, int64_t value) |
|
const Style & |
|
OHOS::UISlider::OnClickEvent (const &event) override |
|
OHOS::UISlider::OnDragEvent (const &event) override |
|
OHOS::UISlider::OnDragEndEvent (const &event) override |
|
OHOS::UISlider::OnPreDraw (const &invalidatedArea) override |
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 &invalidatedArea) override |
|
OHOS::UISlider::UISliderEventListener::~UISliderEventListener () |
|
OHOS::UISlider::UISliderEventListener::OnChange (int16_t value) |
Called when the slider is dragged or clicked. This is a virtual function, which needs your implementation. |
Called when the slider is released. This is a virtual function, which needs your implementation. |
|
OHOS::UISlider::SetSliderEventListener ( listener) |
|
OHOS::UISurfaceView::GetSurface () const |
Obtains the surface, which should be used together with the camera and video modules. |
OHOS::UISurfaceView::SetPosition (int16_t x, int16_t y) override |
|
(int16_t x, int16_t y, int16_t width, int16_t height) override |
|
OHOS::UISurfaceView::Resize (int16_t width, int16_t height) override |
|
OHOS::UISurfaceView::SetY (int16_t y) override |
|
OHOS::UISurfaceView::SetHeight (int16_t height) override |
|
OHOS::UISurfaceView::OnPreDraw (const &invalidatedArea) override |
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 &invalidatedArea) override |
|
OHOS::UISwipeView::UISwipeView (uint8_t direction=) |
A constructor used to create a UISwipeView instance. |
A destructor used to delete the UISwipeView instance. |
|
OHOS::UISwipeView::SetDirection (uint8_t direction) |
|
OHOS::UISwipeView::Add ( view) override |
|
OHOS::UISwipeView::Insert ( prevView, UIView insertView) override |
|
(UIView view) override |
|
(uint16_t index, bool needAnimator=false) |
|
OHOS::UISwipeView::GetCurrentView () const |
|
OHOS::UISwipeView::SetBlankSize (uint16_t size) |
|
OHOS::UISwipeView::OnDragEvent (const &event) override |
|
OHOS::UISwipeView::OnDragEndEvent (const &event) override |
|
OHOS::UISwipeView::SetAnimatorTime (uint16_t ) |
Sets the time for the page being animated. The page will go beyond the blank during this time. |
OHOS::UISwipeView::SetLoopState (bool loop) |
|
(uint16_t index) const |
|
OHOS::UISwipeView::SetOnSwipeListener ( onSwipeListener) |
Sets the listener that contains a callback to be invoked upon a swipe event. |
OHOS::UISwipeView::MoveChildByOffset (int16_t xOffset, int16_t yOffset) override |
|
A constructor used to create a UITextureMapper instance. |
|
A destructor used to delete the UITextureMapper instance. |
|
OHOS::UITextureMapper::SetRotateEnd (int16_t end) |
|
OHOS::UITextureMapper::SetScaleEnd (float end) |
|
OHOS::UITextureMapper::SetDelayTime (uint16_t delayTime) |
|
OHOS::UITextureMapper::SetPivot (int16_t x, int16_t y) |
Sets the coordinates of the rotation and scaling pivots for this image. |
A destructor used to delete an AnimatorStopListener instance. |
|
(UIView &view)=0 |
Called when this animator stops. This is a pure virtual function, which needs your inheritance and implementation. |
(AnimatorStopListener listener) |
|
A constructor used to create a UITimePicker instance. |
|
A destructor used to delete the UITimePicker instance. |
|
OHOS::UITimePicker::SetSelected (const char value) |
|
OHOS::UITimePicker::GetSelectHour () const |
|
OHOS::UITimePicker::GetSelectSecond () const |
|
OHOS::UITimePicker::EnableSecond (bool state) |
|
(uint8_t backgroundFontId, uint8_t highlightFontId, ColorType backgroundColor, highlightColor) |
Sets the text format in the time picker, including the font ID and color. |
OHOS::UITimePicker::SetWidth (int16_t width) override |
|
OHOS::UITimePicker::SelectedListener::OnTimePickerStoped ( &picker) |
Called when an item is selected after sliding stops. This function is implemented by applications. |
OHOS::UITimePicker::RegisterSelectedListener ( timePickerListener) |
|
OHOS::UIToggleButton::GetViewType () const override |
|
OHOS::UIToggleButton::GetState () const |
|
(UIView &view, const &event) |
|
OHOS::UIView::OnLongPressListener::OnLongPress ( &view, const LongPressEvent &event) |
|
A destructor used to delete the OnLongPressListener instance. |
|
(UIView &view, const &event) |
|
OHOS::UIView::OnDragListener::OnDrag ( &view, const DragEvent &event) |
|
(UIView &view, const &event) |
|
OHOS::UIView::OnTouchListener::OnPress ( &view, const PressEvent &event) |
|
(UIView &view, const &event) |
|
OHOS::UIView::OnTouchListener::OnCancel ( &view, const CancelEvent &event) |
|
A destructor used to delete the OnTouchListener instance. |
|
A default constructor used to create an UIView instance. |
|
A constructor used to create an UIView instance. |
|
A destructor used to delete the UIView instance. |
|
(const Rect &invalidatedArea) |
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. |
(const Rect &invalidatedArea) |
|
(const Rect &invalidatedArea) |
|
(const Rect &invalidatedArea) |
|
(const LongPressEvent &event) |
|
(const DragEvent &event) |
|
(const DragEvent &event) |
|
(const DragEvent &event) |
|
(const ClickEvent &event) |
|
(const PressEvent &event) |
|
(const ReleaseEvent &event) |
|
(const CancelEvent &event) |
|
(OnDragListener onDragListener) |
|
(OnClickListener onClickListener) |
|
(OnLongPressListener onLongPressListener) |
|
(OnTouchListener onTouchListener) |
|
(const Point &point, last) |
|
OHOS::UIView::SetParent ( parent) |
|
OHOS::UIView::GetParent () const |
|
OHOS::UIView::SetNextSibling ( sibling) |
|
OHOS::UIView::GetNextSibling () const |
|
OHOS::UIView::SetVisible (bool visible) |
|
OHOS::UIView::SetTouchable (bool touch) |
|
OHOS::UIView::SetDraggable (bool draggable) |
|
OHOS::UIView::SetDragParentInstead (bool dragParentInstead) |
Sets whether to transfer the drag event to the parent view for processing when the view is being dragged. |
Obtains whether the view transfers a drag event to the parent view for processing. |
|
OHOS::UIView::GetRect () const |
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 |
|
OHOS::UIView::GetMaskedRect () const |
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 |
|
Obtains the content of the absolute rectangle area of the view. This area excludes padding. |
|
OHOS::UIView::GetRelativeRect () const |
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) |
Adjusts the size of the visible area. This operation may affect the final display size. |
OHOS::UIView::SetX (int16_t x) |
|
OHOS::UIView::SetY (int16_t y) |
|
OHOS::UIView::SetPosition (int16_t x, int16_t y) |
|
OHOS::UIView::IsViewGroup () const |
|
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 &transMap) |
|
OHOS::UIView::GetChildById (const char id) const |
|
OHOS::UIView::SetViewId (const char id) |
|
OHOS::UIView::SetViewIndex (int16_t ) |
|
OHOS::UIView::GetViewIndex () const |
|
OHOS::UIView::LayoutChildren (bool neeInvalidate=false) |
Lays out all child views according to the preset arrangement mode. |
OHOS::UIView::LayoutLeftOfParent (int16_t offset=0) |
|
OHOS::UIView::LayoutTopOfParent (int16_t offset=0) |
|
OHOS::UIView::AlignLeftToSibling (const char id, int16_t offset=0) |
|
OHOS::UIView::AlignTopToSibling (const char id, int16_t offset=0) |
|
OHOS::UIView::AlignHorCenterToSibling (const char id, int16_t offset=0) |
Aligns the view with the center of a sibling view in the x-axis. |
Aligns the view with the center of a sibling view in the y-axis. |
|
OHOS::UIView::LayoutLeftToSibling (const char id, int16_t offset=0) |
|
OHOS::UIView::LayoutTopToSibling (const char id, int16_t offset=0) |
|
OHOS::UIView::SetStyle ( &style) |
|
OHOS::UIView::SetStyle (uint8_t key, int64_t value) |
|
OHOS::UIView::GetStyleConst () const |
Obtains the view style. This function applies to scenarios where the style does not need to be modified, which saves memory. |
OHOS::UIViewGroup::GetViewType () const override |
|
(UIView view) |
|
(UIView prevView, insertView) |
|
OHOS::UIViewGroup::Remove ( view) |
|
(const Point &point, last) override |
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) |
|
Sets whether this view group is intercepted upon touch events. |
|
OHOS::UIViewGroup::GetChildById (const char id) const override |
|
OHOS::UIViewGroup::SetAutoSize (bool state) |
Sets whether the size of this view group is adaptive to that of all child views. |
Obtains the rectangle area of a new view group after being adaptive to the size of all child views. |
|
Performs operations needed after a child view is added or removed. |
|
OHOS::UIDumpDomTree::DumpDomTree (const char id, const char path) |
Exports information about a DOM tree starting from a specified DOM node and saves the information to a specified path. |
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) |
|
(const Point &pos) |
|
OHOS::ClickEvent::ClickEvent (const &pos) |
A constructor used to create a ClickEvent instance. |
A destructor used to delete the ClickEvent instance. |
|
(const Point &newPos, const &lastPos, const Point &totalLen) |
|
OHOS::DragEvent::GetLastPoint () const |
Obtains the coordinates of the last position in the drag event. |
OHOS::DragEvent::GetStartPoint () const |
|
OHOS::DragEvent::SetPreLastPoint (const &preLastPos) |
Sets the coordinates of the stay position before the last position in the drag event. |
OHOS::DragEvent::GetPreLastPoint () const |
Obtains the coordinates of the stay position before the last position in the drag event. |
OHOS::DragEvent::GetDragDirection () const |
|
Obtains the difference between the current position and the last position of the view in the x-axis. |
|
OHOS::DragEvent::GetDeltaY () const |
Obtains the difference between the current position and the last position of the view in the y-axis. |
A default constructor used to create an Event instance. |
|
(const Point &curPos) |
|
OHOS::Event::GetCurrentPos () const |
|
OHOS::Event::GetTimeStamp () const |
|
OHOS::KeyEvent::KeyEvent (uint16_t keyId, uint16_t state) |
|
OHOS::KeyEvent::GetKeyId () const |
|
OHOS::LongPressEvent::LongPressEvent (const &pos, const TimeType &timeStamp) |
A constructor used to create a LongPressEvent instance. |
A destructor used to delete the LongPressEvent instance. |
|
(const Point &pos) |
|
OHOS::ReleaseEvent::ReleaseEvent (const &pos) |
A constructor used to create a ReleaseEvent instance. |
A destructor used to delete the ReleaseEvent instance. |
|
A constructor used to create a VirtualDeviceEvent instance. |
|
A destructor used to delete the VirtualDeviceEvent instance. |
|
OHOS::VirtualDeviceEvent::GetState () const |
|
The default constructor used to create a Line instance. |
|
(const Vector2< int16_t > &a, const < int16_t > &b) |
A constructor used to create a Line instance. |
(int16_t x1, int16_t y1, int16_t x2, int16_t y2) |
|
OHOS::Line::operator[] (uint8_t ) |
Vector2< int16_t > & Obtains the start or end point of the line based on the value of index. |
(uint8_t index) const |
Obtains the start or end point of the line based on the value of index. |
OHOS::Polygon::Polygon (const &rect) |
A constructor used to construct a Polygon instance based on a rectangle. |
(const Vector2< int16_t > vertexes, const uint8_t vertexNum) |
A constructor used to create a instance based on the vertex coordinates and the number of coordinates. |
OHOS::Polygon::MakeAABB () const |
Obtains the minimum rectangle that can contain the polygon. All vertices of the polygon are inside this rectangle. |
OHOS::Polygon::GetVertexNum () const |
|
OHOS::Intersect (const &a, const Line &b, < int16_t > &out) |
Checks whether line segment a and line segment b intersect, and returns the intersection point (if available). |
OHOS::IsIntersect (const &a, const Line &b) |
|
(Polygon &poly, const &line) |
|
OHOS::SuthHodgClip (const &clipRect, const Polygon &polygon) |
Implements Sutherland-Hodgman, an algorithm used for clipping polygons. |
OHOS::Clip (const &line, const Polygon &poly, < int16_t > pOut, uint8_t pNum) |
Clips a polygon by using a line segment and obtains the intersections. |
OHOS::Vector2< T >::Vector2 (T x, T y) |
A constructor used to create a instance based on the X and Y coordinates. |
OHOS::Vector2< T >::Dot (const < T > &other) const |
Calculates the scalar product of the two-dimensional vector and another two-dimensional vector. |
OHOS::Vector2< T >::Cross (const < T > &other) const |
Calculates the cross product of the two-dimensional vector and another two-dimensional vector. |
OHOS::Vector3< T >::Vector3 (T x, T y, T z) |
Defines a instance and initializes the values of x, y, and z. |
OHOS::Matrix3< T >::Matrix3 (T m00, T m01, T m02, T m10, T m11, T m12, T m20, T m21, T m22) |
|
OHOS::Matrix3< T >::GetData () const |
|
OHOS::Matrix3< T >::Inverse () const |
|
OHOS::Matrix3< T >::Rotate (T angle, const < 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. |
(const Vector2< T > &scale, const < 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. |
(const Vector2< T > &trans) |
|
OHOS::HeapBase::operator new (size_t size) |
|
OHOS::FlexLayout::SetMajorAxisAlign (const AlignType &align) |
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. |
Sets the alignment mode of the secondary axis (the axis perpendicular to the set layout direction). |
|
OHOS::FlexLayout::SetFlexWrap (uint8_t wrap) |
|
Lays out all child views according to the preset arrangement mode. |
|
OHOS::GridLayout::SetRows (const uint16_t &rows) |
|
OHOS::GridLayout::LayoutChildren (bool needInvalidate=false) override |
Lays out all child views according to the preset arrangement mode. |
A default constructor used to create a Layout instance. |
|
A destructor used to delete the Layout instance. |
|
(const DirectionType &direction) |
|
A default constructor used to create a List instance. The initial size is 0. |
|
A destructor used to delete the List instance. |
|
OHOS::List< T >::Back () const |
|
OHOS::List< T >::PushFront (T data) |
|
(ListNode< T > node, T data) |
Inserts data before a specified node, which follows the inserted data node. |
(ListNode< T > node) |
|
OHOS::List< T >::Head () const |
|
OHOS::List< T >::Tail () const |
|
OHOS::List< T >::Begin () const |
|
OHOS::List< T >::End () const |
|
OHOS::List< T >::Next (const < T > node) const |
ListNode< T > Obtains the address of the node following the specified node. |
OHOS::List< T >::Size () const |
|
(ImageInfo &info) |
Applies for the image cache memory. You can customize the memory area when loading image resources. |
(ImageInfo &info) |
|
Applies for memory for the graphics module. You can implement this function to override the malloc and new functions. |
|
OHOS::UIFree (void buffer) |
Releases memory for the graphics module. You can implement this function to override the free and delete functions. |
A constructor used to create a Rect instance. |
|
A destructor used to delete the Rect instance. |
|
A constructor used to create a Rect instance based on the coordinates of the four boundaries. |
|
(const Rect &other) |
A constructor used to create a instance by copying another rectangle. |
OHOS::Rect::Rect (const &&other) |
A constructor used to create a Rect instance by copying another rectangle. |
OHOS::Rect::GetWidth () const |
|
OHOS::Rect::GetX () const |
|
OHOS::Rect::GetLeft () const |
|
OHOS::Rect::GetRight () const |
|
OHOS::Rect::SetX (int16_t x) |
Changes the left boundary coordinate of the rectangle without changing the rectangle width. |
Changes the top boundary coordinate of the rectangle without changing the rectangle height. |
|
OHOS::Rect::SetPosition (int16_t x, int16_t y) |
Changes the coordinates of the left and top boundaries of the rectangle without changing the rectangle width and height. |
Changes the width of the rectangle without changing the coordinate of the left boundary. |
|
OHOS::Rect::SetHeight (int16_t height) |
Changes the height of the rectangle without changing the coordinate of the top boundary. |
OHOS::Rect::SetTop (int16_t top) |
|
OHOS::Rect::SetBottom (int16_t bottom) |
|
OHOS::Rect::GetSize () const |
|
(const Rect &rect1, const &rect2) |
|
OHOS::Rect::Join (const &rect1, const Rect &rect2) |
Obtains the minimum rectangle that contains another two rectangles. |
(const Vector2< int16_t > &point) const |
|
(const Point &point) const |
|
(const Rect &other) const |
Checks whether the rectangle is adjacent to another rectangle horizontally or vertically. |
(const Rect &other) const |
Checks whether the rectangle intersects with another rectangle. |
(const Rect &other) const |
|
A constructor used to create a Style instance. |
|
A destructor used to delete the Style instance. |
|
OHOS::Style::GetStyle (uint8_t key) const |
|
A constructor used to create a StyleDefault instance. |
|
A destructor used to delete the StyleDefault instance. |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
static Style & |
|
A constructor used to create an OnFPSChangedListener instance with the default sampling type FPS_CT_FIXED_TIME. |
|
A destructor used to delete the OnFPSChangedListener instance. |
|
OHOS::SysInfo::OnFPSChangedListener::GetFPSCalculateType () const |
|
OHOS::SysInfo::OnFPSChangedListener::SetFPSCalculateType ( type) |
|
(OnFPSChangedListener onFPSChangedListener) |
|
A constructor used to create a Theme instance. |
|
A destructor used to delete the Theme instance. |
|
Style & |
|
Style & |
|
Style & |
|
Style & |
|
Style & |
|
Style & |
|
Style & |
|
static ThemeManager & |
|
OHOS::ThemeManager::SetCurrent ( theme) |
|
OHOS::TransformMap::TransformMap (const &rect) |
A constructor used to create a TransformMap instance. |
A destructor used to delete the TransformMap instance. |
|
Checks whether the vertex coordinates of a polygon are clockwise. |
|
OHOS::TransformMap::SetPolygon (const &polygon) |
|
OHOS::TransformMap::GetPolygon () const |
|
OHOS::TransformMap::GetPivot () const |
|
OHOS::TransformMap::IsInvalid () const |
Checks whether the instance is invalid. When the vertices are all 0, the TransformMap is invalid. |
Obtains the minimum rectangle that can contain a polygon. All vertices of the polygon are inside this rectangle. |
|
(int16_t angle, const Vector2< int16_t > &pivot) |
|
(const Vector2< float > scale, const < int16_t > &pivot) |
|
OHOS::Rotate (const < int16_t > &point, int16_t angle, const Vector2< int16_t > &pivot, < int16_t > &out) |
|
OHOS::Rotate (const &origLine, int16_t angle, const Vector2< int16_t > &pivot, &out) |
|
OHOS::Rotate (const &origRect, int16_t angle, const Vector2< int16_t > &pivot, &out) |
|
Details
Macro Definition Documentation
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
Description:
Calculates the value for the current time of an animation.
Returns the value for the current time.
Parameters:
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
anonymous enum : uint8_t
Description:
Enumerates the states of this animator.
STOP | |
START | |
PAUSE | |
RUNNING |
anonymous enum
anonymous enum : uint8_t
Description:
Enumerates keys of styles.
STYLE_BACKGROUND_COLOR | |
STYLE_BACKGROUND_OPA | |
STYLE_BORDER_RADIUS | |
STYLE_BORDER_COLOR | |
STYLE_BORDER_OPA | |
STYLE_BORDER_WIDTH | |
STYLE_PADDING_LEFT | |
STYLE_PADDING_RIGHT | |
STYLE_PADDING_TOP | |
STYLE_PADDING_BOTTOM | |
STYLE_MARGIN_LEFT | |
STYLE_MARGIN_RIGHT | |
STYLE_MARGIN_TOP | |
STYLE_MARGIN_BOTTOM | |
STYLE_IMAGE_OPA | |
STYLE_TEXT_COLOR | Text color |
STYLE_TEXT_FONT | |
STYLE_LETTER_SPACE | |
STYLE_LINE_SPACE | Line spacing |
STYLE_TEXT_OPA | |
STYLE_LINE_COLOR | Line color |
STYLE_LINE_WIDTH | |
STYLE_LINE_OPA | Line opacity |
STYLE_LINE_CAP |
anonymous enum
anonymous enum
Description:
Enumerates opacity values.
OPA_TRANSPARENT | |
OPA_OPAQUE |
ButtonImageSrc
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
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
enum [OHOS::CapType]($api-api-SmartVision-Devices-Graphic.md#ga2db3928cdf793f4950245a6841dd43d6) : uint8_t
Description:
Enumerates cap styles.
CAP_NONE | |
CAP_ROUND |
ColorMode
enum [OHOS::ColorMode]($api-api-SmartVision-Devices-Graphic.md#ga3a3fb04ed2cda4017e6771c66b692141) : uint8_t
Description:
colormode of image and font.
ARGB8888 | |
RGB888 | |
RGB565 | |
ARGB1555 | |
ARGB4444 | |
AL44 | |
AL88 | |
L1 | |
L2 | |
L4 | |
L8 | |
A1 | |
A2 | |
A4 | |
A8 | |
UNKNOW |
DeviceType
enum [OHOS::VirtualDeviceEvent::DeviceType]($api-api-SmartVision-Devices-Graphic.md#gaf8133740d5a3cb2f88a7f33cb11c6dbd)
Description:
Enumerates virtual device types.
DialogButtonType
enum [OHOS::UIDialog::DialogButtonType]($api-api-SmartVision-Devices-Graphic.md#ga1bfefa0b46fd5a79a28d0c9a75114295)
Description:
Enumerates buttons in a dialog box.
BUTTON1 | |
BUTTON2 | |
BUTTON3 |
Direction
enum [OHOS::UIBoxProgress::Direction]($api-api-SmartVision-Devices-Graphic.md#ga4a7a2c192206c8b18379f42a5fd176eb) : uint8_t
Description:
Enumerates the directions of the progress bar.
DIR_LEFT_TO_RIGHT | |
DIR_RIGHT_TO_LEFT | |
DIR_TOP_TO_BOTTOM | |
DIR_BOTTOM_TO_TOP |
DisplayMode
enum [OHOS::UIDigitalClock::DisplayMode]($api-api-SmartVision-Devices-Graphic.md#gabe3b64b11e5bf5d7b54e1039e40f306b)
Description:
Enumerates the display modes of this digital clock.
DISPLAY_12_HOUR_NO_SECONDS | |
DISPLAY_24_HOUR_NO_SECONDS | |
DISPLAY_12_HOUR | |
DISPLAY_24_HOUR |
DrawType
enum [OHOS::UIAnalogClock::DrawType]($api-api-SmartVision-Devices-Graphic.md#ga0a595eeb50ce4e7dfff9ede16098d2db)
Description:
Enumerates the drawing types of a clock hand.
DRAW_LINE | |
DRAW_IMAGE |
FPSCalculateType
enum [OHOS::SysInfo::FPSCalculateType]($api-api-SmartVision-Devices-Graphic.md#ga75d850e3abff6c2f617b689a0cb9a3d1)
Description:
Enumerates the FPS capture types.
HandType
enum [OHOS::UIAnalogClock::HandType]($api-api-SmartVision-Devices-Graphic.md#ga13cf64ea5bd39550976aaf65b1381edf)
Description:
Enumerates the clock hand types.
HOUR_HAND | |
MINUTE_HAND | |
SECOND_HAND |
LineBreakMode
enum [OHOS::UILabel::LineBreakMode]($api-api-SmartVision-Devices-Graphic.md#gaf2ba9acac6cafffc549781ace0475cd5) : uint8_t
Description:
Enumerates the display modes of a long text.
PaintStyle
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.
STROKE_STYLE | |
FILL_STYLE | |
STROKE_FILL_STYLE |
TextOrientation
enum [OHOS::UIArcLabel::TextOrientation]($api-api-SmartVision-Devices-Graphic.md#ga0778527bee4a7ddd8d46395585a5cfb9) : uint8_t
Description:
Enumerates text orientations.
INSIDE | |
OUTSIDE |
TimeElement
enum [OHOS::UIDigitalClock::TimeElement]($api-api-SmartVision-Devices-Graphic.md#gaa6aacc9ecbf5e20f22e50e542a69f472)
Description:
Enumerates the time elements of this digital clock.
HOUR_ELEMENT | |
MINUTE_ELEMENT | |
SECOND_ELEMENT |
UICheckBoxState
enum [OHOS::UICheckBox::UICheckBoxState]($api-api-SmartVision-Devices-Graphic.md#ga15a3f0302aded0e4d1584ddc6002335d) : uint8_t
Description:
Enumerates the states of a check box.
UITextLanguageAlignment
enum [OHOS::UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) : uint8_t
Description:
Enumerates text alignment modes.
TEXT_ALIGNMENT_LEFT | |
TEXT_ALIGNMENT_RIGHT | |
TEXT_ALIGNMENT_CENTER | |
TEXT_ALIGNMENT_TOP | |
TEXT_ALIGNMENT_BOTTOM |
UITextLanguageDirect
enum [OHOS::UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) : uint8_t
Description:
Enumerates text directions.
TEXT_DIRECT_LTR | |
TEXT_DIRECT_RTL |
WorkMode
enum [OHOS::UIAbstractClock::WorkMode]($api-api-SmartVision-Devices-Graphic.md#ga19db90932bc71e6bbced6ccf2935ac98)
Description:
Enumerates the working modes of this clock.
ALWAYS_ON | |
NORMAL |
Function Documentation
AbstractAdapter()
OHOS::AbstractAdapter::AbstractAdapter ()
Description:
A constructor used to create an AbstractAdapter instance.
Add() [1/3]
void OHOS::AnimatorManager::Add ([Animator]($api-api-SmartVision-Devices-OHOS-Animator.md) * animator)
Description:
Adds the instance to the AnimatorManager linked list for management, so that the Run function of the class is called once for each frame.
Parameters:
animator | Indicates the pointer to the instance to add. |
See also:
Add() [2/3]
virtual void OHOS::UIViewGroup::Add ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)
Description:
Adds a child view.
Reimplemented in .
Parameters:
view | Indicates the pointer to the child view to add. |
Add() [3/3]
void OHOS::UISwipeView::Add ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)
Description:
Adds a view.
Reimplemented from .
Parameters:
view | Indicates the view to add. |
AddDataSerial()
virtual bool OHOS::UIChart::AddDataSerial ([UIChartDataSerial]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial.md) * dataSerial)
Description:
Adds a data set.
Parameters:
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:
AddPoints()
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:
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()
void OHOS::UIView::AlignBottomToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Aligns the view with the bottom of a sibling view.
Parameters:
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()
void OHOS::UIView::AlignHorCenterToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Aligns the view with the center of a sibling view in the x-axis.
Parameters:
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()
void OHOS::UIView::AlignLeftToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Aligns the view with the left of a sibling view.
Parameters:
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()
void OHOS::UIView::AlignRightToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Aligns the view with the right of a sibling view.
Parameters:
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()
void OHOS::UIView::AlignTopToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Aligns the view with the top of a sibling view.
Parameters:
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()
void OHOS::UIView::AlignVerCenterToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Aligns the view with the center of a sibling view in the y-axis.
Parameters:
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]
OHOS::Animator::Animator ()
Description:
A default constructor used to create an instance.
Animator() [2/2]
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:
callback | Indicates the animator callback for producing animator effects. For details, see AnimatorCallback. |
view | Indicates the 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()
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()
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()
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:
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:
| BackEaseOut |
BackEaseInOut()
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:
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:
| BackEaseIn |
BackEaseOut()
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:
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:
| BackEaseIn |
Begin()
[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()
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()
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()
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:
view | Indicates the instance, which is added from the constructor of the Animator class. |
Cancel()
void OHOS::UITextureMapper::Cancel ()
Description:
Cancels this animator.
After being cancelled, the animator will stop in the current playback state.
CancelEvent()
OHOS::CancelEvent::CancelEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)
Description:
A constructor used to create a instance.
Parameters:
pos | Indicates the position where the cancel event occurs. |
CircEaseIn()
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:
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:
CircEaseInOut()
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:
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()
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:
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:
Clear() [1/2]
void [OHOS::List]($api-api-SmartVision-Devices-OHOS-List-T.md)< T >::Clear ()
Description:
Deletes all nodes from a linked list.
Clear() [2/2]
void OHOS::UICanvas::Clear ()
Description:
Clears the entire canvas.
ClearData()
void OHOS::UIChartDataSerial::ClearData ()
Description:
Clears all data points.
ClearDataSerial()
virtual void OHOS::UIChart::ClearDataSerial ()
Description:
Clears all data sets.
ClearOnKeyActListener()
void OHOS::RootView::ClearOnKeyActListener ()
Description:
Clears the listener for monitoring physical key events.
ClearOnVirtualDeviceEventListener()
void OHOS::RootView::ClearOnVirtualDeviceEventListener ()
Description:
Clears the listener for monitoring the input events of a virtual device.
ClearValues()
virtual void OHOS::UIPicker::ClearValues ()
Description:
Clears all values in the picker.
ClickEvent()
OHOS::ClickEvent::ClickEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)
Description:
A constructor used to create a ClickEvent instance.
Parameters:
pos | Indicates the position where the click event occurs. |
Clip() [1/2]
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:
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]
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:
poly | Indicates the polygon to clip. |
line | Indicates the line segment used for clipping. |
ColorTo16()
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:
color | Indicates the color data with the 32-bit color depth, which is defined by . |
Returns:
Returns the RGB565 color data.
ColorTo32() [1/2]
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:
color | Indicates the color data with the 16-bit color depth, which is defined by . |
alpha | Indicates the alpha, that is, how opaque each pixel is. |
Returns:
Returns the RGBA8888 color data.
ColorTo32() [2/2]
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:
color | Indicates the color data, which is defined by ColorType. |
Returns:
Returns the RGBA8888 color data.
Cross()
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:
other | Indicates the two-dimensional vector to be used for calculation. |
Returns:
Returns the cross product.
CubicEaseIn()
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:
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:
CubicEaseInOut()
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:
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()
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:
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:
Cyan()
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()
virtual bool OHOS::UIChart::DeleteDataSerial ([UIChartDataSerial]($api-api-SmartVision-Devices-OHOS-UIChartDataSerial.md) * dataSerial)
Description:
Deletes a data set.
Parameters:
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:
Determinant()
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()
void OHOS::UIButton::Disable ()
Description:
Disables this button.
DisplayLeadingZero()
void OHOS::UIDigitalClock::DisplayLeadingZero (bool displayLeadingZero)
Description:
Sets whether to add 0 before the hour of this digital clock.
Parameters:
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()
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:
other | Indicates the two-dimensional vector to be used for calculation. |
Returns:
Returns the scalar product.
DragEvent()
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:
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()
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:
DrawCircle()
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:
center | Indicates the coordinates of the circle center. |
radius | Indicates the radius of the circle. |
paint | Indicates the circle style. For details, see . |
DrawCurve() [1/2]
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:
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]
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:
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()
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:
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()
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:
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 . |
DrawLine() [1/2]
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:
endPoint | Indicates the end point of the straight line. |
paint | Indicates the straight line style. For details, see Paint. |
DrawLine() [2/2]
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:
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()
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:
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()
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:
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()
char* OHOS::UIDumpDomTree::DumpDomNode (const char * id)
Description:
Exports information about a specified DOM node.
Parameters:
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]
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:
id | Indicates the pointer to the DOM node ID. |
Returns:
Returns true if the operation is successful; returns false otherwise.
DumpDomTree() [2/2]
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:
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()
void OHOS::UIButton::Enable ()
Description:
Enables this button.
EnableAutoAlign()
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:
state | Indicates the automatic alignment state. true indicates this state is enabled, and false indicates the opposite case. |
EnableBackground()
void OHOS::UIAbstractProgress::EnableBackground (bool enable)
Description:
Sets whether the background of the progress bar is visible.
Parameters:
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()
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:
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()
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:
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()
void OHOS::UIChartDataSerial::EnableHeadPoint (bool enable)
Description:
Enables the feature of drawing the frontmost point on a polyline.
Parameters:
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()
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:
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()
void OHOS::UITimePicker::EnableSecond (bool state)
Description:
Sets whether to enable seconds in the time picker.
Parameters:
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()
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:
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()
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:
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()
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]
OHOS::Event::Event ()
Description:
A default constructor used to create an instance.
Event() [2/2]
OHOS::Event::Event (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & curPos)
Description:
A constructor used to create an Event instance.
Parameters:
pos | Indicates the position where the event occurs. |
FindSubView()
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:
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()
OHOS::FlexLayout::FlexLayout ()
Description:
A default constructor used to create a instance.
Format()
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:
value | Indicates the input integer. |
outText | Indicates the pointer to the converted string. |
textLen | Indicates the length of the string. |
Front()
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()
[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()
[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()
[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()
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()
[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()
uint16_t OHOS::UIArcLabel::GetArcTextRadius () const
Description:
Obtains the radius of this arc text.
Returns:
Returns the radius of this arc text.
GetArcTextStartAngle()
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()
uint16_t OHOS::UIPicker::GetBackgroundFontId () const
Description:
Obtains the font ID of the background text.
Returns:
Returns the font ID.
GetBackgroundStyle() [1/2]
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]
int64_t OHOS::UIAbstractProgress::GetBackgroundStyle (uint8_t key) const
Description:
Obtains the value of a background style of this progress bar.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetBackgroundTextColor()
[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()
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()
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:
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()
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()
int16_t OHOS::Rect::GetBottom () const
Description:
Obtains the bottom boundary coordinate of the rectangle.
Returns:
Returns the bottom boundary coordinate.
GetBottomPointStyle()
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 .
GetBoxRect()
[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()
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()
static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetBrightStyle ()
Description:
Obtains the bright style.
Returns:
Returns the bright style.
GetButtonInactivedStyle()
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()
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()
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()
[ButtonStyle]($api-api-SmartVision-Devices-OHOS-ButtonStyle.md)& OHOS::Theme::GetButtonStyle ()
Description:
Obtains the style of this button.
Returns:
Returns the button style.
GetCenterPosition()
[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:
GetChildById() [1/2]
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 .
Returns:
Returns the pointer to the child view.
GetChildById() [2/2]
[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:
id | Indicates the pointer to the ID of the target child view. |
Returns:
Returns the target child view if available; returns nullptr otherwise.
GetChildrenHead()
[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()
[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()
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()
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:
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()
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:
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]
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]
virtual [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) OHOS::UIButton::GetContentRect ()
Description:
Obtains a rectangular area that contains coordinate information.
Reimplemented from .
Returns:
Returns the rectangle area.
GetCount() [1/2]
virtual uint16_t OHOS::TextAdapter::GetCount ()
Description:
Obtains the data size of the UILabel adapter.
Implements .
Returns:
Returns the data size of the UILabel adapter.
GetCount() [2/2]
virtual uint16_t OHOS::AbstractAdapter::GetCount ()
Description:
Obtains the number of adapter data items.
Implemented in .
Returns:
Returns the number of adapter data items.
GetCurImageSrc()
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()
[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()
uint8_t OHOS::UIAbstractClock::GetCurrentHour () const
Description:
Obtains the current number of hours.
Returns:
Returns the current number of hours.
GetCurrentMinute()
uint8_t OHOS::UIAbstractClock::GetCurrentMinute () const
Description:
Obtains the current number of minutes.
Returns:
Returns the current number of minutes.
GetCurrentPage()
uint16_t OHOS::UISwipeView::GetCurrentPage () const
Description:
Obtains the current tab index.
Returns:
Returns the current tab index.
GetCurrentPos()
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()
uint8_t OHOS::UIAbstractClock::GetCurrentSecond () const
Description:
Obtains the current number of seconds.
Returns:
Returns the current number of seconds.
GetCurrentView()
[UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UISwipeView::GetCurrentView () const
Description:
Obtains the current view.
Returns:
Returns the current view.
GetData()
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()
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()
static [Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::StyleDefault::GetDefaultStyle ()
Description:
Obtains the default style.
Returns:
Returns the default style.
GetDeltaX()
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()
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]
[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]
[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]
[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]
[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]
uint8_t OHOS::UIAbstractScroll::GetDirection () const
Description:
Obtains the scroll direction.
Returns:
Returns the scroll direction, either HORIZONTAL or VERTICAL.
GetDirection() [2/3]
uint8_t OHOS::UISwipeView::GetDirection () const
Description:
Obtains the dragging direction.
Returns:
Returns the dragging direction.
GetDirection() [3/3]
[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:
GetDisplayMode()
[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()
uint8_t OHOS::UIAbstractScroll::GetDragACCLevel () const
Description:
Obtains the drag acceleration.
Returns:
Returns the drag acceleration.
GetDragDirection()
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()
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:
textRect | Indicates the text rectangle. |
style | Indicates the text style. |
GetEndAngle()
int16_t OHOS::UICircleProgress::GetEndAngle () const
Description:
Obtains the end angle.
Returns:
Returns the end angle.
See also:
GetFillColor() [1/2]
[ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::Paint::GetFillColor () const
Description:
Obtains the fill color.
Returns:
Returns the fill color.
See also:
GetFillColor() [2/2]
[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:
GetFontId() [1/5]
uint8_t OHOS::TextAdapter::GetFontId () const
Description:
Obtains font ID.
Returns:
Returns the font ID. For details, see UITextLanguageFontId.
GetFontId() [2/5]
uint8_t OHOS::Text::GetFontId () const
Description:
Obtains the font ID.
Returns:
Returns the front ID.
GetFontId() [3/5]
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]
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]
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]
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]
int64_t OHOS::UIAbstractProgress::GetForegroundStyle (uint8_t key) const
Description:
Obtains the value of a foreground style of this progress bar.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetFPS()
static float OHOS::SysInfo::GetFPS ()
Description:
Obtains the FPS data.
Returns:
Returns the FPS data.
GetFPSCalculateType()
[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 .
GetHandCurrentAngle()
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:
type | Indicates the clock hand type, as enumerated in . |
Returns:
Returns the current rotation angle of this specified clock hand.
GetHandInitAngle()
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:
type | Indicates the clock hand type, as enumerated in . |
Returns:
Returns the initial rotation angle of this specified clock hand.
GetHandPosition()
[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:
type | Indicates the clock hand type, as enumerated in . |
Returns:
Returns the position of this specified clock hand.
GetHandRotateCenter()
[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:
type | Indicates the clock hand type, as enumerated in . |
Returns:
Returns the rotation center.
GetHeader()
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:
header | Indicates the basic image information. |
GetHeadPointStyle()
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 .
GetHeight() [1/7]
uint16_t OHOS::Screen::GetHeight ()
Description:
Obtains the height of this screen.
Returns:
Returns the screen height.
GetHeight() [2/7]
virtual int16_t OHOS::UIView::GetHeight ()
Description:
Obtains the height for the view.
Reimplemented in OHOS::UIButton, , OHOS::UIArcLabel, and .
Returns:
Returns the view height.
GetHeight() [3/7]
int16_t OHOS::Rect::GetHeight () const
Description:
Obtains the rectangle height.
Returns:
Returns the rectangle height.
GetHeight() [4/7]
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]
int16_t OHOS::UIArcLabel::GetHeight ()
Description:
Obtains the height of this arc text.
Reimplemented from .
Returns:
Returns the height of this arc text.
GetHeight() [6/7]
int16_t OHOS::UILabel::GetHeight ()
Description:
Obtains the height of this label.
Reimplemented from OHOS::UIView.
Returns:
Returns the label height.
GetHeight() [7/7]
int16_t OHOS::UIButton::GetHeight ()
Description:
Obtains the height of this image.
Reimplemented from .
Returns:
Returns the image height.
GetHideCount()
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:
GetHideIndex()
uint16_t OHOS::UIChartDataSerial::GetHideIndex () const
Description:
Obtains the index from which the data set starts to hide.
Returns:
Returns the index.
See also:
GetHighlightFontId()
uint16_t OHOS::UIPicker::GetHighlightFontId () const
Description:
Obtains the font ID of the highlighted text.
Returns:
Returns the font ID.
GetHighlightTextColor()
[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]
[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]
[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]
[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()
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()
uint8_t OHOS::UIImageAnimatorView::GetImageAnimatorImageNum () const
Description:
Obtains the number of images.
Returns:
Returns the number of images.
GetImageAnimatorSrc()
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]
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]
const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md)* OHOS::UIImageView::GetImageInfo () const
Description:
获取图片信息
Returns:
图片信息
GetImageX()
int16_t OHOS::UIButton::GetImageX () const
Description:
Obtains the x-coordinate of this image.
Returns:
Returns the x-coordinate of this image.
GetImageY()
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]
static [Screen]($api-api-SmartVision-Devices-OHOS-Screen.md)& OHOS::Screen::GetInstance ()
Description:
Obtains a singleton instance.
Returns:
Returns the Screen instance.
GetInstance() [2/5]
static [ThemeManager]($api-api-SmartVision-Devices-OHOS-ThemeManager.md)& OHOS::ThemeManager::GetInstance ()
Description:
Obtains the singleton instance of the class.
Returns:
Returns the singleton instance of the ThemeManager class.
GetInstance() [3/5]
static [RootView]($api-api-SmartVision-Devices-OHOS-RootView.md)* OHOS::RootView::GetInstance ()
Description:
Obtains a singleton instance.
Returns:
Returns the singleton RootView instance.
GetInstance() [4/5]
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]
static [AnimatorManager]($api-api-SmartVision-Devices-OHOS-AnimatorManager.md)* OHOS::AnimatorManager::GetInstance ()
Description:
Obtains the instance.
Returns:
Returns the AnimatorManager instance.
GetInterval()
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()
uint16_t OHOS::KeyEvent::GetKeyId () const
Description:
Obtains the key ID.
GetKnobStyle() [1/2]
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]
int64_t OHOS::UISlider::GetKnobStyle (uint8_t key) const
Description:
Obtains the value of a knob style.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetKnobWidth()
int16_t OHOS::UISlider::GetKnobWidth ()
Description:
Obtains the knob width.
Returns:
Returns the knob width.
See also:
GetLabelPosition()
[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]
[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]
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]
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]
int64_t OHOS::UILabelButton::GetLabelStyle (uint8_t key) const
Description:
Obtains the value of a style of this label.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetLastPoint()
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()
uint32_t OHOS::Task::GetLastRun () const
Description:
Obtains the end time of this task.
Returns:
Returns the end time.
GetLatestIndex()
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()
int16_t OHOS::Rect::GetLeft () const
Description:
Obtains the left boundary coordinate of the rectangle.
Returns:
Returns the left boundary coordinate.
GetLibDsc()
std::string OHOS::GetLibDsc ()
Description:
Obtains the library description of the graphics module.
Returns:
Returns the library description of the graphics module.
GetLineBreakMode()
uint8_t OHOS::UILabel::GetLineBreakMode () const
Description:
Obtains the line break mode of this text.
Returns:
Returns the line break mode.
GetLineColor()
[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:
GetLoopState()
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()
[Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::Theme::GetMainStyle ()
Description:
Obtains the basic style.
Returns:
Returns the basic style.
GetMaskedRect()
[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()
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()
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:
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()
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()
[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()
[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()
[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()
[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()
[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]
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]
uint8_t OHOS::Paint::GetOpacity () const
Description:
Obtains the opacity.
Returns:
Returns the opacity.
See also:
GetOrigRect()
[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()
[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]
const char* OHOS::Image::GetPath () const
Description:
Obtains the image path in binary.
Returns:
Returns the pointer to the image path.
GetPath() [2/2]
const char* OHOS::UIImageView::GetPath () const
Description:
获取图片路径
Returns:
图片路径
GetPeakData()
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()
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()
uint32_t OHOS::Task::GetPeriod () const
Description:
Obtains the running period of this task.
Returns:
Returns the running period.
GetPickerBackgroundStyle() [1/2]
[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]
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]
[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]
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()
[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()
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:
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()
[Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) OHOS::TransformMap::GetPolygon () const
Description:
Obtains the polygon after rectangle transformation.
Returns:
Returns the polygon.
GetPreLastPoint()
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]
[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]
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]
[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]
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()
uint16_t OHOS::UICircleProgress::GetRadius () const
Description:
Obtains the outer radius of this circular progress bar.
Returns:
Returns the outer radius.
See also:
GetRangeMax()
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:
GetRangeMin()
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:
GetRect()
[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()
[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()
uint32_t OHOS::UIImageAnimatorView::GetRepeatTimes () const
Description:
Obtains the playback times.
Returns:
Returns the playback times.
See also:
GetRight()
int16_t OHOS::Rect::GetRight () const
Description:
Obtains the right boundary coordinate of the rectangle.
Returns:
Returns the right boundary coordinate.
GetRollStartPos()
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()
uint32_t OHOS::Animator::GetRunTime () const
Description:
Obtains the running time of this animator.
Returns:
Returns the running time.
See also:
GetScrollState() [1/2]
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]
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()
uint16_t OHOS::UIPicker::GetSelected () const
Description:
Obtains the index of the item currently selected in the picker.
Returns:
Returns the index.
GetSelectHour()
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()
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()
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()
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 .
GetSelectView()
[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()
uint32_t OHOS::Rect::GetSize () const
Description:
Obtains the area of a rectangle.
Returns:
Returns the area of the rectangle.
GetSliderKnobStyle() [1/2]
[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]
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]
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]
uint8_t OHOS::UIImageView::GetSrcType () const
Description:
获取图片类型
Returns:
图片类型
GetStartAngle()
int16_t OHOS::UICircleProgress::GetStartAngle () const
Description:
Obtains the start angle.
Returns:
Returns the start angle.
See also:
GetStartIndex()
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()
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()
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:
GetState() [1/6]
uint16_t OHOS::KeyEvent::GetState () const
Description:
Obtains the key state.
GetState() [2/6]
uint16_t OHOS::VirtualDeviceEvent::GetState () const
Description:
Obtains the state of the virtual event.
Returns:
Returns the state.
GetState() [3/6]
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]
uint8_t OHOS::Animator::GetState () const
Description:
Obtains the current state of this animator.
Returns:
Returns the current animator state, which can be START, , or PAUSE.
See also:
GetState() [5/6]
[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]
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 .
GetStep()
uint16_t OHOS::UIAbstractProgress::GetStep () const
Description:
Obtains the current step of this progress bar.
Returns:
Returns the current step.
See also:
GetStrokeColor()
[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:
GetStrokeWidth()
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:
GetStyle() [1/5]
[Style]($api-api-SmartVision-Devices-OHOS-Style.md)& OHOS::TextAdapter::GetStyle ()
Description:
Obtains the adapter style.
Returns:
Returns the UILabel adapter style.
GetStyle() [2/5]
[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 .
See also:
GetStyle() [3/5]
int64_t OHOS::Style::GetStyle (uint8_t key) const
Description:
Obtains the value of a style.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetStyle() [4/5]
virtual int64_t OHOS::UIView::GetStyle (uint8_t key) const
Description:
Obtains the value of a style.
Reimplemented in OHOS::UIButton.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetStyle() [5/5]
int64_t OHOS::UIButton::GetStyle (uint8_t key) const
Description:
Obtains the value of a style.
Reimplemented from OHOS::UIView.
Parameters:
key | Indicates the key of the style. |
Returns:
Returns the value of the style.
GetStyleConst()
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()
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:
key | Indicates the key of the style. |
state | Indicates the button state, as enumerated in . |
Returns:
Returns the style of the button in the specific state.
GetSurface()
[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()
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]
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:
point | Indicates the coordinates to specify. |
last | Indicates the double pointer to the view that contains the specified coordinates. |
GetTargetView() [2/2]
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:
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]
const char* OHOS::UILabelButton::GetText () const
Description:
Obtains the text of this label button.
Returns:
Returns the text.
GetText() [2/4]
const char* OHOS::Text::GetText () const
Description:
Obtains the content of this text.
Returns:
Returns the text content.
GetText() [3/4]
const char* OHOS::UIArcLabel::GetText () const
Description:
Obtains the text of this arc label.
Returns:
Returns the text.
GetText() [4/4]
const char* OHOS::UILabel::GetText () const
Description:
Obtains the text of this label.
Returns:
Returns the text.
GetTextColor()
[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()
uint16_t OHOS::UILabel::GetTextHeight ()
Description:
Obtains the height of this text.
Returns:
Returns the text height.
GetTextRotateDegree() [1/2]
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]
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]
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]
LabelRotateDegree OHOS::UILabel::GetTextRotation () const
Description:
Obtains the clockwise rotation degree of this text.
Returns:
Returns the rotation degree, as defined in LabelRotateDegree.
GetTextSize()
[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()
uint16_t OHOS::UILabel::GetTextWidth ()
Description:
Obtains the width of this text.
Returns:
Returns the text width.
GetTime()
uint32_t OHOS::Animator::GetTime () const
Description:
Obtains the total duration of this animator.
Returns:
Returns the total duration.
See also:
GetTimeOfPause()
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:
GetTimeOfUpdate()
uint16_t OHOS::UIImageAnimatorView::GetTimeOfUpdate () const
Description:
Obtains the speed of this animator.
Returns:
Returns the interval for updating images, in milliseconds.
See also:
GetTimeStamp()
const TimeType& OHOS::Event::GetTimeStamp () const
Description:
Obtains the timestamp when an event occurs.
Returns:
Returns the timestamp.
GetTop()
int16_t OHOS::Rect::GetTop () const
Description:
Obtains the top boundary coordinate of the rectangle.
Returns:
Returns the top boundary coordinate.
GetTopPointStyle()
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 .
GetTouchListener()
[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()
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()
[TransformMap]($api-api-SmartVision-Devices-OHOS-TransformMap.md)& OHOS::UIView::GetTransformMap ()
Description:
Obtains an affine transformation matrix.
Returns:
Returns the transform matrix.
GetType()
uint16_t OHOS::VirtualDeviceEvent::GetType () const
Description:
Obtains the type of the virtual device.
Returns:
Returns the type.
GetValidHeight()
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:
GetValidWidth()
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:
GetValleyData()
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()
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()
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:
GetVerAlign() [1/2]
[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]
[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()
std::string OHOS::GetVersion ()
Description:
Obtains the version number of the graphics module.
Returns:
Returns the version number of the graphics module.
GetVertexNum()
uint8_t OHOS::Polygon::GetVertexNum () const
Description:
Obtains the number of vertices of the polygon.
Returns:
Returns the number of vertices.
GetVerticalScrollState()
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]
[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 instance to convert adapter data into another UILabel instance.
Implements .
Parameters:
inView | Indicates the pointer to the reusable instance. If this parameter is not NULL, a reusable 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 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 instance constructed by the adapter.
GetView() [2/2]
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 instance.
Implemented in OHOS::TextAdapter.
Parameters:
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 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 instance. |
index | Indicates the adapter data index. |
Returns:
UIView Returns the pointer to the instance constructed by the adapter.
GetViewByIndex()
[UIView]($api-api-SmartVision-Devices-OHOS-UIView.md)* OHOS::UISwipeView::GetViewByIndex (uint16_t index) const
Description:
Obtains a view based on its index.
Parameters:
Indicates | the index of a view. |
Returns:
Returns the view.
GetViewId()
const char* OHOS::UIView::GetViewId () const
Description:
Obtains the view ID.
Returns:
Returns the pointer to the view ID.
GetViewIndex()
int16_t OHOS::UIView::GetViewIndex () const
Description:
Obtains the view index.
Returns:
Returns the view index.
GetViewType() [1/31]
virtual UIViewType OHOS::UIView::GetViewType () const
Description:
Obtains the view type.
Reimplemented in , OHOS::UICanvas, , OHOS::UIList, , OHOS::RootView, , OHOS::UILabel, , OHOS::UISwipeView, , OHOS::UIBoxProgress, , OHOS::UIButton, , OHOS::UIArcLabel, , OHOS::UIToggleButton, , OHOS::UISlider, , OHOS::UIAbstractScroll, , OHOS::UICircleProgress, , OHOS::UITextureMapper, , OHOS::UIImageView, , and OHOS::UITimePicker.
Returns:
Returns the view type.
GetViewType() [2/31]
UIViewType OHOS::UITimePicker::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns the view type. For details, see UIViewType.
GetViewType() [3/31]
UIViewType OHOS::UIImageView::GetViewType () const
Description:
Obtains the view type.
Reimplemented from OHOS::UIView.
Reimplemented in .
Returns:
Returns UI_IMAGE_VIEW, as defined in UIViewType.
GetViewType() [4/31]
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]
UIViewType OHOS::UIAbstractProgress::GetViewType () const
Description:
Obtains the component type.
Reimplemented from .
Reimplemented in OHOS::UIBoxProgress, , and OHOS::UICircleProgress.
Returns:
Returns the component type, as defined in UIViewType.
GetViewType() [6/31]
UIViewType OHOS::UIDigitalClock::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns UI_DIGITAL_CLOCK, as defined in UIViewType.
GetViewType() [7/31]
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]
UIViewType OHOS::UIAbstractScroll::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Reimplemented in OHOS::UIList, , and OHOS::UISwipeView.
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [9/31]
UIViewType OHOS::UITextureMapper::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [10/31]
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]
UIViewType OHOS::UIViewGroup::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns UI_VIEW_GROUP, as defined in UIViewType.
GetViewType() [12/31]
UIViewType OHOS::UIRepeatButton::GetViewType () const
Description:
Obtains the component type.
Reimplemented from OHOS::UIButton.
Returns:
Returns the component type, as defined in UIViewType.
UIViewType OHOS::UISlider::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [14/31]
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]
UIViewType OHOS::UILabelButton::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns UI_LABEL_BUTTON, as defined in UIViewType.
GetViewType() [16/31]
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]
UIViewType OHOS::UIRadioButton::GetViewType () const
Description:
Obtains the component type.
Reimplemented from .
Returns:
Returns the component type, as defined in UIViewType.
GetViewType() [18/31]
UIViewType OHOS::UIButton::GetViewType () const
Description:
Obtains the component type.
Reimplemented from OHOS::UIView.
Reimplemented in , and OHOS::UIRepeatButton.
Returns:
Returns the component type, as defined in UIViewType.
GetViewType() [19/31]
UIViewType OHOS::UIImageAnimatorView::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [20/31]
UIViewType OHOS::UIBoxProgress::GetViewType () const
Description:
Obtains the view type.
Reimplemented from OHOS::UIAbstractProgress.
Reimplemented in .
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [21/31]
Description:
Obtains the view type.
Reimplemented from OHOS::UIView.
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [22/31]
UIViewType OHOS::UISwipeView::GetViewType () const
Description:
Obtains the component type.
Reimplemented from .
Returns:
Returns the component type, as defined in UIViewType.
GetViewType() [23/31]
UIViewType OHOS::UIAbstractClock::GetViewType () const
Description:
Obtains the view type.
Reimplemented from OHOS::UIView.
Reimplemented in , and OHOS::UIDigitalClock.
Returns:
Returns UI_ABSTRACT_CLOCK, as defined in UIViewType.
GetViewType() [24/31]
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns UI_LABEL, as defined in UIViewType.
GetViewType() [25/31]
Description:
Obtains the component type.
Reimplemented from OHOS::UIView.
Reimplemented in , and OHOS::UIToggleButton.
Returns:
Returns the component type, as defined in UIViewType.
GetViewType() [26/31]
UIViewType OHOS::RootView::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns UI_ROOT_VIEW, as defined in UIViewType.
GetViewType() [27/31]
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]
UIViewType OHOS::UIList::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns the view type, as defined in UIViewType.
GetViewType() [29/31]
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]
UIViewType OHOS::UICanvas::GetViewType () const
Description:
Obtains the view type.
Reimplemented from .
Returns:
Returns the view type. For details, see UIViewType.
GetViewType() [31/31]
UIViewType OHOS::UIChart::GetViewType () const
Description:
Obtains the view type.
Reimplemented from OHOS::UIView.
Returns:
Returns the view type. For details, see UIViewType.
GetVisibleRect()
[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]
uint16_t OHOS::Screen::GetWidth ()
Description:
Obtains the width of this screen.
Returns:
Returns the screen width.
GetWidth() [2/7]
virtual int16_t OHOS::UIView::GetWidth ()
Description:
Obtains the width for the view.
Reimplemented in , OHOS::UILabel, , and OHOS::UIImageView.
Returns:
Returns the view width.
GetWidth() [3/7]
int16_t OHOS::Rect::GetWidth () const
Description:
Obtains the rectangle width.
Returns:
Returns the rectangle width.
GetWidth() [4/7]
int16_t OHOS::UIImageView::GetWidth ()
Description:
Obtains the width of this image view.
Reimplemented from .
Returns:
Returns the width of this image view.
GetWidth() [5/7]
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]
int16_t OHOS::UILabel::GetWidth ()
Description:
Obtains the width of this label.
Reimplemented from .
Returns:
Returns the label width.
GetWidth() [7/7]
int16_t OHOS::UIButton::GetWidth ()
Description:
Obtains the width of this image.
Reimplemented from OHOS::UIView.
Returns:
Returns the image width.
GetWorkMode()
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 .
GetX() [1/2]
int16_t OHOS::Rect::GetX () const
Description:
Obtains the left boundary coordinate of the rectangle.
Returns:
Returns the left boundary coordinate.
GetX() [2/2]
int16_t OHOS::UIView::GetX () const
Description:
Obtains the x-coordinate for the view.
Returns:
Returns the x-coordinate.
GetXAxis()
[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]
int16_t OHOS::Rect::GetY () const
Description:
Obtains the top boundary coordinate of the rectangle.
Returns:
Returns the top boundary coordinate.
GetY() [2/2]
int16_t OHOS::UIView::GetY () const
Description:
Obtains the y-coordinate for the view.
Returns:
Returns the y-coordinate.
GetYAxis()
[UIYAxis]($api-api-SmartVision-Devices-OHOS-UIYAxis.md)& OHOS::UIChart::GetYAxis ()
Description:
Obtains the y-axis instance.
Returns:
Returns the y-axis instance.
Gray()
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()
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()
OHOS::GridLayout::GridLayout ()
Description:
A default constructor used to create a GridLayout instance.
Hand()
OHOS::UIAnalogClock::Hand::Hand ()
Description:
A default constructor used to create a instance.
Head()
[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()
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:
index | Indicates the point from which the hide starts. |
count | Indicates the number of points to hide. |
Image()
OHOS::Image::Image ()
Description:
A constructor used to create an instance. You can use this constructor when a component requires a map.
ImageCacheFree()
void OHOS::ImageCacheFree ([ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) & info)
Description:
Releases the image cache memory.
Parameters:
info | Indicates the image information. For details, see . |
ImageCacheMalloc()
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:
info | Indicates the image information. For details, see . |
IncOneSecond()
void OHOS::UIAbstractClock::IncOneSecond ()
Description:
Increases the time by one second.
Insert() [1/3]
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:
node | Indicates the pointer to the node holding the inserted data. |
data | Indicates the data to insert. |
Insert() [2/3]
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 .
Parameters:
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]
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 .
Parameters:
prevView | Indicates the previous view. |
insertView | Indicates the view to insert. |
Intersect() [1/2]
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:
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]
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:
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()
void OHOS::UIView::Invalidate ()
Description:
Refreshes the invalidated area of the view.
InvalidateRect()
void OHOS::UIView::InvalidateRect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Refreshes a view in a specified invalidated area.
Parameters:
invalidatedArea | Indicates the area to refresh. |
Inverse()
[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]
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:
point | Indicates the coordinate point. |
Returns:
Returns true if the input coordinate point is contained; returns false otherwise.
IsContains() [2/3]
bool OHOS::Rect::IsContains (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & other) const
Description:
Checks whether the rectangle contains another rectangle.
Parameters:
other | Indicates the rectangle to be used for check. |
Returns:
Returns true if the input rectangle is contained; returns false otherwise.
IsContains() [3/3]
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:
point | Indicates the coordinate point. |
Returns:
Returns true if the input coordinate point is contained; returns false otherwise.
IsDraggable()
bool OHOS::UIView::IsDraggable () const
Description:
Checks whether the view is draggable.
Returns:
Returns true if the view is draggable; returns false otherwise.
IsDragParentInstead()
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()
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()
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()
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()
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:
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()
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]
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:
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]
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:
other | Indicates the rectangle to be used for check. |
Returns:
Returns true if the two rectangles intersect; returns false otherwise.
IsInvalid()
bool OHOS::TransformMap::IsInvalid () const
Description:
Checks whether the TransformMap instance is invalid. When the vertices are all 0, the is invalid.
Returns:
Returns true if TransformMap is invalid; returns false otherwise.
IsRepeat() [1/2]
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:
IsRepeat() [2/2]
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()
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:
IsSizeFixed()
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:
IsSmooth()
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()
bool OHOS::UIView::IsTouchable () const
Description:
Checks whether the view is touchable.
Returns:
Returns true if the view is touchable; returns false otherwise.
IsViewGroup()
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()
bool OHOS::UIView::IsVisible () const
Description:
Checks whether the view is visible.
Returns:
Returns true if the view is visible; returns false otherwise.
Join()
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:
rect1 | Indicates the first rectangle to contain. |
rect2 | Indicates the second rectangle to contain. |
KeyEvent()
OHOS::KeyEvent::KeyEvent (uint16_t keyId, uint16_t state )
Description:
A constructor used to create a instance.
Parameters:
keyId | Indicates the key ID. |
state | Indicates the key state. |
Layout()
OHOS::Layout::Layout ()
Description:
A default constructor used to create a instance.
LayoutBottomOfParent()
void OHOS::UIView::LayoutBottomOfParent (int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code])
Description:
Lays out the view on the bottom of the parent view.
Parameters:
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()
void OHOS::UIView::LayoutBottomToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Lays out the view on the below of a sibling view.
Parameters:
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()
void OHOS::UIView::LayoutCenterOfParent (int16_t xOffSet = [/topic/body/section/screen/code
{""}) 0 (code], int16_t yOffset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Lays out the view in the center of the parent view.
Parameters:
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]
virtual void OHOS::GridLayout::LayoutChildren (bool needInvalidate = [/topic/body/section/screen/code
{""}) false (code])
Description:
Lays out all child views according to the preset arrangement mode.
Reimplemented from .
Parameters:
LayoutChildren() [2/3]
virtual void OHOS::FlexLayout::LayoutChildren (bool needInvalidate = [/topic/body/section/screen/code
{""}) false (code])
Description:
Lays out all child views according to the preset arrangement mode.
Reimplemented from .
Parameters:
LayoutChildren() [3/3]
virtual void OHOS::UIView::LayoutChildren (bool neeInvalidate = [/topic/body/section/screen/code
{""}) false (code])
Description:
Lays out all child views according to the preset arrangement mode.
Reimplemented in , and OHOS::GridLayout.
Parameters:
LayoutLeftOfParent()
void OHOS::UIView::LayoutLeftOfParent (int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code])
Description:
Lays out the view on the left of the parent view.
Parameters:
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()
void OHOS::UIView::LayoutLeftToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Lays out the view on the left of a sibling view.
Parameters:
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()
void OHOS::UIView::LayoutRightOfParent (int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code])
Description:
Lays out the view on the right of the parent view.
Parameters:
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()
void OHOS::UIView::LayoutRightToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Lays out the view on the right of a sibling view.
Parameters:
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()
void OHOS::UIView::LayoutTopOfParent (int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code])
Description:
Lays out the view on the top of the parent view.
Parameters:
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()
void OHOS::UIView::LayoutTopToSibling (const char * id, int16_t offset = [/topic/body/section/screen/code
{""}) 0 (code] )
Description:
Lays out the view on the above of a sibling view.
Parameters:
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()
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]
OHOS::Line::Line ()
Description:
The default constructor used to create a Line instance.
Line() [2/3]
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 instance.
Parameters:
a | Indicates the start point of the line. |
b | Indicates the end point of the line. |
Line() [3/3]
OHOS::Line::Line (int16_t x1, int16_t y1, int16_t x2, int16_t y2 )
Description:
A constructor used to create a instance.
Parameters:
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()
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:
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()
[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()
OHOS::ListScrollListener::ListScrollListener ()
Description:
A constructor used to create a instance with the default state SCROLL_STATE_STOP.
LongPressEvent()
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:
pos | Indicates the position where the long-press event occurs. |
timeStamp | Indicates the time stamp when the long-press event occurs. |
Magenta()
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()
[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()
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]
[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]
[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 instance and initializes the 3 x 3 matrix data.
Parameters:
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()
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:
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]
void OHOS::UIAbstractScroll::MoveChildByOffset (int16_t offsetX, int16_t offsetY )
Description:
Moves the position of all child views.
Reimplemented from OHOS::UIViewGroup.
Reimplemented in , and OHOS::UIList.
Parameters:
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]
virtual void OHOS::UIViewGroup::MoveChildByOffset (int16_t x, int16_t y )
Description:
Moves all child views.
Reimplemented in OHOS::UISwipeView, , and OHOS::UIAbstractScroll.
Parameters:
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]
virtual void OHOS::UIList::MoveChildByOffset (int16_t x, int16_t y )
Description:
Moves the position of all child views.
Reimplemented from OHOS::UIAbstractScroll.
Parameters:
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]
void OHOS::UISwipeView::MoveChildByOffset (int16_t offsetX, int16_t offsetY )
Description:
Moves the position of all child views.
Reimplemented from OHOS::UIAbstractScroll.
Parameters:
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()
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()
[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:
node | Indicates the pointer to the data node in the linked list. |
Returns:
Returns the address of the node following node.
Olive()
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]
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 class and implement this function.
Parameters:
view | Indicates the instance of this view. |
OnAnimatorStop() [2/2]
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:
view | Indicates the instance of this view. |
OnCancel()
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:
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]
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 .
Parameters:
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]
void OHOS::UIButton::OnCancelEvent (const [CancelEvent]($api-api-SmartVision-Devices-OHOS-CancelEvent.md) & event)
Description:
Executes the cancel event action.
Reimplemented from .
Parameters:
[in] | event | The cancel event. |
OnChange() [1/2]
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:
value | Indicates the current value of the slider. |
OnChange() [2/2]
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:
state | Indicates the current state of this check box. For details, see . |
OnChildChanged()
virtual void OHOS::UIViewGroup::OnChildChanged ()
Description:
Performs operations needed after a child view is added or removed.
OnClick()
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:
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]
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::UICheckBox, , and OHOS::UIRepeatButton.
Parameters:
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]
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:
[in] | event | click event. |
OnClickEvent() [3/5]
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:
[in] | event | The event that passed when OnClickEvent is invoked. |
OnClickEvent() [4/5]
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 .
Parameters:
[in] | event | The event that passed when OnClickEvent is invoked. |
OnClickEvent() [5/5]
void OHOS::UISlider::OnClickEvent (const [ClickEvent]($api-api-SmartVision-Devices-OHOS-ClickEvent.md) & event)
Description:
Called when the view is clicked.
Reimplemented from .
Parameters:
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()
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:
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()
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:
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]
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::UISlider, , and OHOS::UIScrollView.
Parameters:
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]
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:
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]
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:
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]
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:
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]
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:
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]
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::UIList, and .
Parameters:
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]
bool OHOS::UIScrollView::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)
Description:
Called when the view is being dragged.
Reimplemented from .
Parameters:
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]
bool OHOS::UIList::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)
Description:
Called when the view is being dragged.
Reimplemented from .
Parameters:
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]
bool OHOS::UISlider::OnDragEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)
Description:
Called when the view is being dragged.
Reimplemented from .
Parameters:
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]
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 .
Parameters:
event | The drag event |
OnDragStart()
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:
view | Indicates the view dragged. |
event | Indicates the drag event. |
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()
virtual bool OHOS::UIView::OnDragStartEvent (const [DragEvent]($api-api-SmartVision-Devices-OHOS-DragEvent.md) & event)
Description:
Called when the view starts to drag.
Parameters:
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]
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::UICanvas, , OHOS::UIAnalogClock, , OHOS::UISlider, , OHOS::UICheckBox, , OHOS::UIAxis, , OHOS::UIButton, , and OHOS::UILabelButton.
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [2/15]
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]
void OHOS::UICircleProgress::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Called when a view is drawn.
Reimplemented from .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [4/15]
void OHOS::UIButton::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Executes the draw action.
Reimplemented from .
Reimplemented in OHOS::UILabelButton.
Parameters:
[in] | invalidatedArea | The rectangle to draw, with coordinates relative to this drawable.. |
OnDraw() [5/15]
void OHOS::UIImageView::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Draws this image view.
Reimplemented from OHOS::UIView.
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [6/15]
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:
invalidatedArea | Indicates the area to draw. |
OnDraw() [7/15]
void OHOS::UILabel::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Draws this label.
Reimplemented from OHOS::UIView.
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [8/15]
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:
[in] | invalidatedArea | The invalidated area. |
OnDraw() [9/15]
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:
OnDraw() [10/15]
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:
invalidatedArea | Indicates the area to draw. |
OnDraw() [11/15]
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 .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [12/15]
void OHOS::UIAnalogClock::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Draws an analog clock.
Reimplemented from .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [13/15]
virtual void OHOS::UIArcLabel::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Draws an arc text.
Reimplemented from .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [14/15]
virtual void OHOS::UICanvas::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Called when a view is drawn.
Reimplemented from .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnDraw() [15/15]
void OHOS::UIChart::OnDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Called when a view is drawn.
Reimplemented from .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnFPSChanged()
virtual void OHOS::SysInfo::OnFPSChangedListener::OnFPSChanged (float newFPS)
Description:
Called when the FPS data changes.
Parameters:
newFPS | Indicates the FPS data. |
OnFPSChangedListener()
OHOS::SysInfo::OnFPSChangedListener::OnFPSChangedListener ()
Description:
A constructor used to create an OnFPSChangedListener instance with the default sampling type FPS_CT_FIXED_TIME.
OnItemSelected()
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:
OnKeyAct()
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:
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()
virtual void OHOS::RootView::OnKeyEvent (const [KeyEvent]($api-api-SmartVision-Devices-OHOS-KeyEvent.md) & event)
Description:
Executes a physical key event.
Parameters:
event | Indicates the physical key event to execute. |
OnLongPress()
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:
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]
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 .
Parameters:
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]
void OHOS::UIRepeatButton::OnLongPressEvent (const [LongPressEvent]($api-api-SmartVision-Devices-OHOS-LongPressEvent.md) & event)
Description:
The action of long press event.
Reimplemented from .
Parameters:
[in] | event | long press event. |
OnPickerStoped()
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:
picker | Indicates the picker instance. |
OnPostDraw() [1/3]
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 .
Parameters:
invalidatedArea | Indicates the area in which the view is drawn. |
OnPostDraw() [2/3]
void OHOS::UIScrollView::OnPostDraw (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & invalidatedArea)
Description:
Called after a view is drawn.
Reimplemented from .
Parameters:
invalidatedArea | Indicates the area in which the view is drawn. |
OnPostDraw() [3/3]
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 .
Parameters:
invalidatedArea | Indicates the area to draw. |
OnPreDraw() [1/13]
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::UISlider, , OHOS::UICheckBox, , OHOS::UIAxis, , OHOS::UIImageView, , OHOS::UIRadioButton, , and OHOS::UIPicker.
Parameters:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPreDraw() [2/13]
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:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPreDraw() [3/13]
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:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPreDraw() [4/13]
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:
[in] | invalidate | area. |
Returns:
True if need cover.
OnPreDraw() [5/13]
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:
[in] | invalidate | area. |
Returns:
True if need cover.
OnPreDraw() [6/13]
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:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if this image view needs to be covered; returns false otherwise.
OnPreDraw() [7/13]
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:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if this label needs to be covered; returns false otherwise.
OnPreDraw() [8/13]
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:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPreDraw() [9/13]
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:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if this label needs to be covered; returns false otherwise.
OnPreDraw() [10/13]
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 .
Parameters:
[in] | invalidate | area. |
Returns:
True if need cover.
OnPreDraw() [11/13]
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 .
Parameters:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPreDraw() [12/13]
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 .
Parameters:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPreDraw() [13/13]
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 .
Parameters:
invalidatedArea | Indicates the area to draw. |
Returns:
Returns true if the parent view needs to be redrawn; returns false otherwise.
OnPress()
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:
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]
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, , and OHOS::UIButton.
Parameters:
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]
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:
[in] | event | The press event, contain press position. |
OnPressEvent() [3/4]
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:
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]
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:
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]
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:
value | Indicates the current value of the slider. |
OnRelease() [2/2]
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:
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]
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 .
Parameters:
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]
void OHOS::UIRepeatButton::OnReleaseEvent (const [ReleaseEvent]($api-api-SmartVision-Devices-OHOS-ReleaseEvent.md) & event)
Description:
The action of release event.
Reimplemented from .
Parameters:
[in] | event | release event. |
OnReleaseEvent() [3/3]
void OHOS::UIButton::OnReleaseEvent (const [ReleaseEvent]($api-api-SmartVision-Devices-OHOS-ReleaseEvent.md) & event)
Description:
Executes the press release event action.
Reimplemented from .
Reimplemented in OHOS::UIRepeatButton.
Parameters:
[in] | event | The press release event. |
OnScrollEnd() [1/2]
virtual void OHOS::UIScrollView::OnScrollListener::OnScrollEnd ()
Description:
Called when a scroll ends.
OnScrollEnd() [2/2]
virtual void OHOS::ListScrollListener::OnScrollEnd (int16_t index, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view )
Description:
Called when a scroll ends.
Parameters:
OnScrollListener()
OHOS::UIScrollView::OnScrollListener::OnScrollListener ()
Description:
A constructor used to create an instance with the default scroll state SCROLL_STATE_STOP.
OnScrollStart() [1/2]
virtual void OHOS::UIScrollView::OnScrollListener::OnScrollStart ()
Description:
Called when a scroll starts.
OnScrollStart() [2/2]
virtual void OHOS::ListScrollListener::OnScrollStart (int16_t index, [UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view )
Description:
Called when a scroll starts.
Parameters:
OnStop()
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:
view | Indicates the UIView instance, which is added from the constructor of the class. |
OnTimePickerStoped()
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:
picker | Indicates the time picker instance. |
OnVirtualDeviceEvent() [1/2]
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:
event | Indicates the input event to respond to. |
OnVirtualDeviceEvent() [2/2]
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:
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()
void OHOS::HeapBase::operator delete (void * p)
Description:
Overrides the delete function.
Parameters:
p | Indicates the pointer to the memory to be released. |
operator new()
void* OHOS::HeapBase::operator new (size_t size)
Description:
Overrides the new function.
Parameters:
size | Indicates the size of the memory to be allocated. |
operator[]() [1/2]
[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:
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]
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:
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()
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()
OHOS::Paint::Paint ()
Description:
A constructor used to create a instance.
Pause() [1/2]
void OHOS::Animator::Pause ()
Description:
Pauses this animator.
See also:
Pause() [2/2]
void OHOS::UIImageAnimatorView::Pause ()
Description:
Pauses this animator at the current image.
See also:
Polygon() [1/3]
OHOS::Polygon::Polygon ()
Description:
The default constructor used to create a Polygon instance.
Polygon() [2/3]
OHOS::Polygon::Polygon (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect)
Description:
A constructor used to construct a instance based on a rectangle.
Parameters:
rect | Indicates the rectangle used to construct the polygon. |
Polygon() [3/3]
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 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:
vertexes | Indicates the pointer to the vertex coordinates. |
vertexNum | Indicates the number of vertices. |
PopBack()
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()
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()
OHOS::PressEvent::PressEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)
Description:
A constructor used to create a PressEvent instance.
Parameters:
pos | Indicates the position where the press event occurs. |
Purple()
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()
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:
data | Indicates the data to insert. |
PushFront()
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:
data | Indicates the data to insert. |
QuadEaseIn()
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:
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:
QuadEaseInOut()
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:
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()
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:
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()
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:
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:
QuintEaseInOut()
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:
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()
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:
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:
Rect() [1/4]
OHOS::Rect::Rect ()
Description:
A constructor used to create a Rect instance.
Rect() [2/4]
OHOS::Rect::Rect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) && other)
Description:
A constructor used to create a instance by copying another rectangle.
Parameters:
other | Indicates the rectangle to copy. |
Rect() [3/4]
OHOS::Rect::Rect (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & other)
Description:
A constructor used to create a instance by copying another rectangle.
Parameters:
other | Indicates the rectangle to copy. |
Rect() [4/4]
OHOS::Rect::Rect (int16_t left, int16_t top, int16_t right, int16_t bottom )
Description:
A constructor used to create a instance based on the coordinates of the four boundaries.
Parameters:
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()
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]
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 .
Implements OHOS::UIChart.
RefreshChart() [2/3]
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 .
Implements OHOS::UIChart.
RefreshChart() [3/3]
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 .
Implemented in OHOS::UIChartPolyline, and .
RefreshList()
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()
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:
onFPSChangedListener | Indicates the pointer to the FPS change notification function. For details, see . |
RegisterScrollListener()
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:
scrollListener | Indicates the listener to register. For details, see . |
RegisterSelectedListener() [1/2]
void OHOS::UIPicker::RegisterSelectedListener ([SelectedListener]($api-api-SmartVision-Devices-OHOS-UIPicker-SelectedListener.md) * pickerListener)
Description:
Registers a listener for a selected event.
Parameters:
pickerListener | Indicates the listener for a selected event in the picker. For details, see . |
RegisterSelectedListener() [2/2]
void OHOS::UITimePicker::RegisterSelectedListener ([SelectedListener]($api-api-SmartVision-Devices-OHOS-UITimePicker-SelectedListener.md) * timePickerListener)
Description:
Registers a listener for a selected event.
Parameters:
timePickerListener | Indicates the listener to register. For details, see . |
ReleaseEvent()
OHOS::ReleaseEvent::ReleaseEvent (const [Point]($api-api-SmartVision-Devices-OHOS-Point.md) & pos)
Description:
A constructor used to create a ReleaseEvent instance.
Parameters:
pos | Indicates the position where the release event occurs. |
ReMeasure()
virtual void OHOS::UIView::ReMeasure ()
Description:
Remeasures the view size.
Remove() [1/4]
void OHOS::AnimatorManager::Remove (const [Animator]($api-api-SmartVision-Devices-OHOS-Animator.md) * animator)
Description:
Removes the Animator instance from the linked list.
Parameters:
animator | Indicates the pointer to the instance to remove. |
See also:
Remove() [2/4]
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:
node | Indicates the pointer to the node to delete. |
Remove() [3/4]
virtual void OHOS::UIViewGroup::Remove ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)
Description:
Removes a child view.
Reimplemented in OHOS::UISwipeView.
Parameters:
view | Indicates the pointer to the child view to remove. |
Remove() [4/4]
virtual void OHOS::UISwipeView::Remove ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * view)
Description:
Deletes a view.
Reimplemented from OHOS::UIViewGroup.
Parameters:
view | Indicates the view to delete. |
RemoveAll() [1/2]
virtual void OHOS::UIViewGroup::RemoveAll ()
Description:
Removes all child views.
Reimplemented in OHOS::UIList.
RemoveAll() [2/2]
void OHOS::UIList::RemoveAll ()
Description:
Removes all child views.
Reimplemented from .
Reset()
void OHOS::UITextureMapper::Reset ()
Description:
Displays the original image.
The configured parameters are reserved and will not be reset.
Resize() [1/3]
void OHOS::Rect::Resize (int16_t width, int16_t height )
Description:
Sets the width and height of a rectangle.
Parameters:
width | Indicates the width of the rectangle. |
height | Indicates the height of the rectangle. |
Resize() [2/3]
virtual void OHOS::UIView::Resize (int16_t width, int16_t height )
Description:
Adjusts the size of the view.
Reimplemented in .
Parameters:
width | Indicates the new width. |
height | Indicates the new height. |
Resize() [3/3]
void OHOS::UISurfaceView::Resize (int16_t width, int16_t height )
Description:
Adjusts the size of this view.
Reimplemented from .
Parameters:
width | Indicates the new width. |
height | Indicates the new height. |
ResizeVisibleArea()
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:
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]
void OHOS::Animator::Resume ()
Description:
Resumes this animator from where it was paused.
See also:
Resume() [2/2]
void OHOS::UIImageAnimatorView::Resume ()
Description:
Resumes this animator from the current image.
See also:
Rotate() [1/5]
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:
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]
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:
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]
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:
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]
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:
angle | Indicates the angle to rotate. |
pivot | Indicates the rotation pivot. |
Rotate() [5/5]
[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:
angle | Indicates the angle to rotate. |
pivot | Indicates the rotation pivot. |
Returns:
Returns the matrix after rotation.
Scale() [1/2]
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:
scale | Indicates the scaling factors of the x-axis and y-axis. |
pivot | Indicates the pivot for scaling. |
Scale() [2/2]
[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:
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]
void OHOS::UIList::ScrollBy (int16_t distance)
Description:
Scrolls the content in this list.
Parameters:
distance | Indicates the distance by which the content is scrolled. |
ScrollBy() [2/2]
void OHOS::UIScrollView::ScrollBy (int16_t xDistance, int16_t yDistance )
Description:
Scrolls the content of this view.
Parameters:
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()
void OHOS::UIList::ScrollTo (uint16_t index)
Description:
Scrolls to change the index of the first row or column of the current view.
Parameters:
index | Indicates the new index of the first row or column of the current view. |
SelectedListener() [1/2]
OHOS::UITimePicker::SelectedListener::SelectedListener ()
Description:
A constructor used to create a SelectedListener instance.
SelectedListener() [2/2]
OHOS::UIPicker::SelectedListener::SelectedListener ()
Description:
A constructor used to create a instance.
SetAdapter()
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:
adapter | Indicates the adapter to set. For details, see . |
SetAlign() [1/4]
void OHOS::UILabelButton::SetAlign ([UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) align)
Description:
Sets the alignment mode for this text.
Parameters:
align | Indicates the text alignment mode to set, as defined in UITextLanguageAlignment. |
SetAlign() [2/4]
void OHOS::UIArcLabel::SetAlign ([UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) horizontalAlign)
Description:
Sets the alignment mode for this text.
Parameters:
horizontalAlign | Indicates the horizontal alignment mode to set, which can be TEXT_ALIGNMENT_LEFT, TEXT_ALIGNMENT_CENTER, or TEXT_ALIGNMENT_RIGHT. |
SetAlign() [3/4]
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
{""}) TEXT_ALIGNMENT_TOP (code] )
Description:
Sets the alignment mode for this text.
Parameters:
SetAlign() [4/4]
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
{""}) TEXT_ALIGNMENT_TOP (code] )
Description:
Sets the alignment mode for this text.
Parameters:
SetAnimatorStopListener() [1/2]
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:
listener | Indicates the listener to set. For details, see . |
SetAnimatorStopListener() [2/2]
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:
listener | Indicates the listener to set. For details, see . |
SetAnimatorTime()
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:
time | Indicates the time of the page being animated. |
SetArcTextAngle()
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:
startAngle | Indicates the start angle to set. |
endAngle | Indicates the end angle to set. |
SetArcTextCenter()
void OHOS::UIArcLabel::SetArcTextCenter (int16_t x, int16_t y )
Description:
Sets the center position for this arc text.
Parameters:
x | Indicates the x-coordinate to set. |
y | Indicates the y-coordinate to set. |
SetArcTextOrientation()
void OHOS::UIArcLabel::SetArcTextOrientation ([TextOrientation]($api-api-SmartVision-Devices-Graphic.md#ga0778527bee4a7ddd8d46395585a5cfb9) orientation)
Description:
Sets the orientation for this arc text.
Parameters:
orientation | Indicates the text orientation to set. |
SetArcTextRadius()
void OHOS::UIArcLabel::SetArcTextRadius (uint16_t radius)
Description:
Sets the radius for this arc text.
Parameters:
radius | Indicates the radius to set. |
SetAutoEnable()
void OHOS::UIImageView::SetAutoEnable (bool enable)
Description:
Sets whether the image view size needs to be adaptive to the image size.
Parameters:
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()
void OHOS::UIViewGroup::SetAutoSize (bool state)
Description:
Sets whether the size of this view group is adaptive to that of all child views.
Parameters:
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()
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:
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:
SetBackgroundStyle() [1/2]
void OHOS::UIAbstractProgress::SetBackgroundStyle (const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)
Description:
Sets the background style for this progress bar.
Parameters:
style | Indicates the background style of the progress bar. For details, see Style. |
See also:
SetBackgroundStyle() [2/2]
void OHOS::UIAbstractProgress::SetBackgroundStyle (uint8_t key, int64_t value )
Description:
Sets a background style for this progress bar.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
SetBackOvershoot()
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:
overshoot | Indicates the overshoot s in the equation to set. |
See also:
| BackEaseOut |
SetBlankSize()
void OHOS::UISwipeView::SetBlankSize (uint16_t size)
Description:
Sets a blank size, as defined in DEFAULT_BLANK_SIZE.
Parameters:
size | Indicates the blank size to set. |
SetBlurLevel()
void OHOS::UIImageView::SetBlurLevel (BlurLevel level)
Description:
Sets the blur level for this image when it is rotated or scaled.
Parameters:
level | Indicates the blur level to set. For details, see BlurLevel. |
SetBottom()
void OHOS::Rect::SetBottom (int16_t bottom)
Description:
Sets the coordinate of the bottom boundary of a rectangle.
Parameters:
bottom | Indicates the coordinate of the bottom boundary. |
SetBottomPointStyle()
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:
style | Indicates the style to set. For details, see . |
SetButton()
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:
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()
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:
cap | Indicates the cap type. For details, see CapType. |
SetCenterPosition()
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:
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:
SetColor()
void OHOS::UIDigitalClock::SetColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)
Description:
Sets the font color for this digital clock.
Parameters:
color | Indicates the front color to set. |
SetCols()
void OHOS::GridLayout::SetCols (const uint16_t & cols)
Description:
Sets the number of columns in a grid.
Parameters:
cols | Indicates the number of columns to set. |
SetCurrent()
void OHOS::ThemeManager::SetCurrent ([Theme]($api-api-SmartVision-Devices-OHOS-Theme.md) * theme)
Description:
Sets the current screen theme for this application.
Parameters:
theme | Indicates the theme to set. |
SetCurrentPage()
void OHOS::UISwipeView::SetCurrentPage (uint16_t index, bool needAnimator = [/topic/body/section/screen/code
{""}) false (code] )
Description:
Sets the index for the current tab.
Parameters:
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]
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:
start | Indicates the start value of the integer data. |
end | Indicates the end value of the integer data. |
SetData() [2/2]
void OHOS::TextAdapter::SetData ([List]($api-api-SmartVision-Devices-OHOS-List-T.md)< const char * > * data)
Description:
Sets the adapter data, which is a string linked list.
Parameters:
data | Indicates the string linked list data. |
SetDataRange() [1/3]
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 .
Parameters:
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]
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 .
Parameters:
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]
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 , and OHOS::UIXAxis.
Parameters:
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()
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:
delayTime | Indicates the delay time to set. |
SetDirect() [1/5]
void OHOS::Text::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)
Description:
Sets the direction for this text.
Parameters:
direct | Indicates the text direction, as defined in UITextLanguageDirect. |
SetDirect() [2/5]
void OHOS::UILabelButton::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)
Description:
Sets the direction for this text.
Parameters:
direct | Indicates the text direction to set, as defined in UITextLanguageDirect. |
SetDirect() [3/5]
void OHOS::TextAdapter::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)
Description:
Sets the direction of the constructed by the adapter.
Parameters:
direct | Indicates the direction of the constructed by the adapter. |
SetDirect() [4/5]
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]
void OHOS::UIPicker::SetDirect ([UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) direct)
Description:
Sets the text direction.
Parameters:
direct | Indicates the text direction to set. For details, see UITextLanguageDirect. |
SetDirection() [1/2]
void OHOS::UIBoxProgress::SetDirection (const [Direction]($api-api-SmartVision-Devices-Graphic.md#ga4a7a2c192206c8b18379f42a5fd176eb) & direction)
Description:
Sets the direction for this progress bar.
Parameters:
direction | Indicates the direction to set. The default direction is from left to right. For details, see Direction. |
See also:
SetDirection() [2/2]
void OHOS::UISwipeView::SetDirection (uint8_t direction)
Description:
Sets the dragging direction.
Parameters:
direction | Indicates the dragging direction, either or VERTICAL. |
SetDisallowIntercept()
void OHOS::UIViewGroup::SetDisallowIntercept (bool flag)
Description:
Sets whether this view group is intercepted upon touch events.
Parameters:
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()
void OHOS::UIDigitalClock::SetDisplayMode ([DisplayMode]($api-api-SmartVision-Devices-Graphic.md#gabe3b64b11e5bf5d7b54e1039e40f306b) dm)
Description:
Sets the display mode for this digital clock.
Parameters:
dm | Indicates the display mode to set. |
SetDragACCLevel()
void OHOS::UIAbstractScroll::SetDragACCLevel (uint16_t value)
Description:
Sets the drag acceleration.
Parameters:
value | Indicates the drag acceleration to set. The default value is 10. A larger drag acceleration indicates a higher inertial scroll velocity. |
SetDragFunc()
void OHOS::UIAbstractScroll::SetDragFunc (EasingFunc func)
Description:
Sets the easing function that specifies a scroll animation after a finger lifts the screen.
Parameters:
func | Indicates the easing function to set. The default function is . For details, see EasingEquation. |
SetDraggable()
void OHOS::UIView::SetDraggable (bool draggable)
Description:
Sets whether the view is draggable.
Parameters:
draggable | Specifies whether to set the view draggable. Value true means to set the view draggable, and false means the opposite. |
SetDragParentInstead()
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:
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()
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:
durationTime | Indicates the duration to set. |
SetEasingFunc()
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:
easingFunc | Indicates the easing function to set. The animation moves at a constant velocity by default. For details, see . |
SetEndAngle()
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:
endAngle | Indicates the end angle to set, which can be any value represented by int16_t. The default value is 360. |
See also:
SetExpandHeight()
void OHOS::Text::SetExpandHeight (bool expand)
Description:
Sets whether to adapt the component height to this text.
Parameters:
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()
void OHOS::Text::SetExpandWidth (bool expand)
Description:
Sets whether to adapt the component width to this text.
Parameters:
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]
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:
color | Indicates the fill color to set. |
See also:
SetFillColor() [2/2]
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:
color | Indicates the fill color to set. |
See also:
SetFlexWrap()
void OHOS::FlexLayout::SetFlexWrap (uint8_t wrap)
Description:
Sets whether to support word wrap.
Parameters:
wrap | Indicates the word wrap attribute. |
SetFont() [1/6]
void OHOS::UIDigitalClock::SetFont (const char * name, uint8_t size )
Description:
Sets the dynamic font for this digital clock.
Parameters:
name | Indicates the pointer to the font name. |
size | Indicates the font size to set. |
SetFont() [2/6]
void OHOS::Text::SetFont (const char * name, uint8_t size )
Description:
Sets the font name and size.
Parameters:
name | Indicates the pointer to the font name. |
size | Indicates the font size to set. |
SetFont() [3/6]
void OHOS::TextAdapter::SetFont (const char * name, uint8_t size )
Description:
Sets the font.
Parameters:
name | Indicates the pointer to the font name. |
size | Indicates the font size to set. |
SetFont() [4/6]
void OHOS::UIArcLabel::SetFont (const char * name, uint8_t size )
Description:
Sets the font for this arc label.
Parameters:
name | Indicates the pointer to the font name. |
size | Indicates the font size to set. |
SetFont() [5/6]
void OHOS::UILabelButton::SetFont (const char * name, uint8_t size )
Description:
Sets the font for this text.
Parameters:
name | Indicates the pointer to the font name. |
size | Indicates the font size to set. |
SetFont() [6/6]
void OHOS::UILabel::SetFont (const char * name, uint8_t size )
Description:
Sets the font for this label.
Parameters:
name | Indicates the pointer to the font name. |
size | Indicates the font size to set. |
SetFontId() [1/7]
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:
backgroundFontId | Indicates the font ID of the background text. |
highlightFontId | Indicates the font ID of the highlighted text. |
SetFontId() [2/7]
void OHOS::UIDigitalClock::SetFontId (uint8_t fontId)
Description:
Sets the dynamic font ID for this digital clock.
Parameters:
fontId | Indicates the dynamic font ID to set. |
SetFontId() [3/7]
void OHOS::TextAdapter::SetFontId (uint8_t fontId)
Description:
Sets font ID.
Parameters:
fontId | Indicates the font ID. For details, see UITextLanguageFontId. |
SetFontId() [4/7]
void OHOS::Text::SetFontId (uint8_t fontId)
Description:
Sets the font ID.
Parameters:
fontId | Indicates the font ID to set. |
SetFontId() [5/7]
void OHOS::UIArcLabel::SetFontId (uint8_t fontId)
Description:
Sets the font ID for this arc label.
Parameters:
fontId | Indicates the font ID composed of font name and size. |
SetFontId() [6/7]
void OHOS::UILabelButton::SetFontId (uint8_t fontId)
Description:
Sets the font ID.
Parameters:
fontId | Indicates the font ID composed of the font name and size. |
SetFontId() [7/7]
void OHOS::UILabel::SetFontId (uint8_t fontId)
Description:
Sets the font ID for this label.
Parameters:
fontId | Indicates the font ID composed of font name and size. |
SetForegroundStyle() [1/2]
void OHOS::UIAbstractProgress::SetForegroundStyle (const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)
Description:
Sets the foreground style for this progress bar.
Parameters:
style | Indicates the foreground style of this progress bar. For details, see . |
See also:
SetForegroundStyle() [2/2]
void OHOS::UIAbstractProgress::SetForegroundStyle (uint8_t key, int64_t value )
Description:
Sets a foreground style for this progress bar.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
SetFPSCalculateType()
void OHOS::SysInfo::OnFPSChangedListener::SetFPSCalculateType ([FPSCalculateType]($api-api-SmartVision-Devices-Graphic.md#ga75d850e3abff6c2f617b689a0cb9a3d1) type)
Description:
Sets the FPS sampling type.
Parameters:
type | Indicates the FPS sampling type. For details, see FPSCalculateType. |
SetGradientBottom()
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:
bottom | Indicates the bottom of the filling range. The value is the distance to the x-axis. |
SetGradientOpacity()
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:
minOpa | Indicates the opacity closest to the x-axis. |
maxOpa | Indicates the opacity farthest away from the x-axis. |
SetHandImage()
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:
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()
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:
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()
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:
style | Indicates the style to set. For details, see PointStyle. |
SetHeight() [1/10]
void OHOS::TextAdapter::SetHeight (int16_t height)
Description:
Sets the height of the constructed by the adapter.
Returns:
Returns the height of the UILabel constructed by the adapter.
SetHeight() [2/10]
void OHOS::Rect::SetHeight (int16_t height)
Description:
Changes the height of the rectangle without changing the coordinate of the top boundary.
Parameters:
height | Indicates the height of the rectangle. |
SetHeight() [3/10]
virtual void OHOS::UIView::SetHeight (int16_t height)
Description:
Sets the height for the view.
Reimplemented in OHOS::UIChart, , OHOS::UIButton, , OHOS::UITimePicker, , and OHOS::UIBoxProgress.
Parameters:
height | Indicates the height to set. |
SetHeight() [4/10]
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 .
Parameters:
height | Indicates the height to set. |
See also:
| SetValidWidth |
SetHeight() [5/10]
void OHOS::UISurfaceView::SetHeight (int16_t height)
Description:
Sets the height for this view.
Reimplemented from OHOS::UIView.
Parameters:
height | Indicates the height to set. |
SetHeight() [6/10]
void OHOS::UITimePicker::SetHeight (int16_t height)
Description:
Sets the height for the time picker.
Reimplemented from OHOS::UIView.
Parameters:
height | Indicates the height to set. |
SetHeight() [7/10]
void OHOS::UIPicker::SetHeight (int16_t height)
Description:
Sets the height for this component.
Reimplemented from OHOS::UIView.
Parameters:
height | Indicates the height to set. |
SetHeight() [8/10]
void OHOS::UIButton::SetHeight (int16_t height)
Description:
Sets the height for this image.
Reimplemented from OHOS::UIView.
Parameters:
height | Indicates the height to set. |
SetHeight() [9/10]
void OHOS::UILabel::SetHeight (int16_t height)
Description:
Sets the height for this label.
Reimplemented from OHOS::UIView.
Parameters:
height | Indicates the height to set. |
SetHeight() [10/10]
void OHOS::UIChart::SetHeight (int16_t height)
Description:
Sets the height for this component.
Reimplemented from OHOS::UIView.
Parameters:
height | Indicates the height to set. |
SetHorizontalScrollState()
void OHOS::UIScrollView::SetHorizontalScrollState (bool state)
Description:
Sets whether a horizontal scroll is enabled.
Parameters:
state | Specifies whether a horizontal scroll is enabled. true indicates a horizontal scroll is enabled, and false indicates the opposite case. |
SetImage() [1/4]
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:
backgroundImage | Indicates the background image to set. |
foregroundImage | Indicates the foreground image to set. |
knobImage | Indicates the knob image to set. |
SetImage() [2/4]
void OHOS::UIAbstractProgress::SetImage (const char * foregroundImage, const char * backgroundImage = [/topic/body/section/screen/code
{""}) 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:
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]
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:
backgroundImage | Indicates the background image to set. |
foregroundImage | Indicates the foreground image to set. |
knobImage | Indicates the knob image to set. |
SetImage() [4/4]
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
{""}) 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:
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]
void OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char * imageSrc, uint8_t imageNum )
Description:
Sets the images for this animator.
Parameters:
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:
SetImageAnimatorSrc() [2/2]
void OHOS::UIImageAnimatorView::SetImageAnimatorSrc (const char * imageSrc, uint8_t imageNum, uint16_t timeOfUpdate )
Description:
Sets the images and speed for this animator.
Parameters:
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:
SetImagePosition()
void OHOS::UIButton::SetImagePosition (const int16_t x, const int16_t y )
Description:
Sets the position for this image.
Parameters:
x | Indicates the x-coordinate to set. |
y | Indicates the y-coordinate to set. |
SetImages() [1/2]
virtual void OHOS::UICheckBox::SetImages (const char * selectedImageSrc, const char * unselectedImageSrc )
Description:
Sets the images for this check box.
Parameters:
selectedImageSrc | Indicates the image for this check box when selected. |
unselectedImageSrc | Indicates the image for this check box when unselected. |
SetImages() [2/2]
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:
selectedImageSrc | Indicates the image for this check box when selected. |
unselectedImageSrc | Indicates the image for this check box when unselected. |
SetImageSrc() [1/2]
void OHOS::UIButton::SetImageSrc (const char * defaultImgSrc, const char * triggeredImgSrc )
Description:
Sets the image for this button.
Parameters:
SetImageSrc() [2/2]
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:
defaultImgSrc | Indicates the default image. |
triggeredImgSrc | Indicates the image for a button when it is triggered. |
SetInitTime12Hour()
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:
SetInitTime24Hour()
void OHOS::UIAnalogClock::SetInitTime24Hour (uint8_t hour, uint8_t minute, uint8_t second )
Description:
Sets the initial time in the 24-hour format.
Parameters:
hour | Indicates the hour to set. |
minute | Indicates the minute to set. |
second | Indicates the second to set. |
SetIntercept()
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:
isIntercept | Specifies whether to intercept the drag event. Value true means to intercept the drag event, and false means the opposite. |
SetInterval()
virtual void OHOS::UIRepeatButton::SetInterval (uint16_t interval)
Description:
Sets the interval between two consecutive click events.
Parameters:
interval | Indicates the interval to set. |
SetItemHeight() [1/2]
void OHOS::UITimePicker::SetItemHeight (int16_t height)
Description:
Sets the height of each item in the time picker.
Parameters:
height | Indicates the height of each item. |
SetItemHeight() [2/2]
Description:
Sets the height of each item in the picker.
Parameters:
height | Indicates the height to set. |
SetKnobStyle() [1/2]
void OHOS::UISlider::SetKnobStyle (const [Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)
Description:
Sets the knob style.
Parameters:
style | Indicates the knob style to set. For details, see Style. |
See also:
SetKnobStyle() [2/2]
void OHOS::UISlider::SetKnobStyle (uint8_t key, int64_t value )
Description:
Sets a knob style.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
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:
width | Indicates the knob width to set. |
See also:
SetLabelStyle() [1/2]
void OHOS::UILabelButton::SetLabelStyle ([Style]($api-api-SmartVision-Devices-OHOS-Style.md) & labelStyle)
Description:
Sets the style for this label.
Parameters:
labelStyle | Indicates the label style to set. |
SetLabelStyle() [2/2]
void OHOS::UILabelButton::SetLabelStyle (uint8_t key, int64_t value )
Description:
Sets a style for this label.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
SetLablePosition()
Description:
Sets the position for this label relative to the button holding it.
Parameters:
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()
void OHOS::Task::SetLastRun (uint32_t lastRun)
Description:
Sets the end time for this task.
Parameters:
lastRun | Indicates the end time to set. |
SetLayoutDirection()
void OHOS::Layout::SetLayoutDirection (const [DirectionType]($api-api-SmartVision-Devices-Codec.md#ga8ef30fa9c08e08c8706653571f9f5b81) & direction)
Description:
Sets the layout direction.
Parameters:
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()
void OHOS::Rect::SetLeft (int16_t left)
Description:
Sets the coordinate of the left boundary of a rectangle.
Parameters:
left | Indicates the coordinate of the left boundary. |
SetLineBreakMode() [1/2]
void OHOS::UILabel::SetLineBreakMode (const uint8_t lineBreakMode)
Description:
Sets the line break mode for this text.
Parameters:
lineBreakMode | Indicates the line break mode to set. |
SetLineBreakMode() [2/2]
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:
lineBreakMode | Indicates the LineBreakMode of UILabel. |
SetLineColor() [1/3]
void OHOS::UICircleProgress::SetLineColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)
Description:
Sets the foreground color for this progress bar.
Parameters:
color | Indicates the foreground color to set. For details, see ColorType. |
SetLineColor() [2/3]
void OHOS::UIAxis::SetLineColor (const [ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) & color)
Description:
Sets the line color of the coordinate axis.
Parameters:
color | Indicates the line color to set. For details, see ColorType. |
SetLineColor() [3/3]
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:
color | Indicates the polyline color to set. |
See also:
SetLoopState() [1/3]
void OHOS::UISwipeView::SetLoopState (bool loop)
Description:
Sets whether the swipe view supports a cycle swipe.
Parameters:
loop | Indicates the cycle swipe flag. true indicates the cycle swipe is supported, and false indicates the opposite case. |
SetLoopState() [2/3]
void OHOS::UIPicker::SetLoopState (bool state)
Description:
Sets whether a picker can slide cyclically.
Parameters:
SetLoopState() [3/3]
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:
state | Indicates the loop state to set. |
SetMajorAxisAlign()
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:
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]
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 .
Parameters:
count | Indicates the number of scales to set. The default value is 5. |
SetMarkNum() [2/3]
void OHOS::UIYAxis::SetMarkNum (uint16_t count)
Description:
Sets the number of scales on the Y axis.
Implements .
Parameters:
count | Indicates the number of scales to set. The default value is 5. |
SetMarkNum() [3/3]
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 , and OHOS::UIXAxis.
Parameters:
count | Indicates the number of scales to set. The default value is 5. |
SetMaxDataCount()
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:
maxCount | Indicates the number of data points. The default value is 0. |
Returns:
Returns true if the operation is successful; returns false otherwise.
SetMaxScrollDistance()
void OHOS::UIAbstractScroll::SetMaxScrollDistance (uint16_t distance)
Description:
Sets the maximum scroll distance after a finger lifts the screen.
Parameters:
distance | Indicates the maximum scroll distance to set. The default value is 0, indicating that the scroll distance is not limited. |
SetName()
void OHOS::UIRadioButton::SetName (const char * name)
Description:
Sets the name for this radio button.
Parameters:
name | Indicates the name to set, which is a character string. |
SetNextSibling()
void OHOS::UIView::SetNextSibling ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * sibling)
Description:
Sets the next sibling view for the view.
Parameters:
sibling | Indicates the pointer to the next sibling view to set. |
SetOnChangeListener()
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:
listener | Indicates the listener to set. For details, see . |
SetOnClickListener() [1/2]
void OHOS::UIView::SetOnClickListener ([OnClickListener]($api-api-SmartVision-Devices-OHOS-UIView-OnClickListener.md) * onClickListener)
Description:
Sets a click event listener for the view.
Parameters:
onClickListener | Indicates the pointer to the click event listener to set. |
SetOnClickListener() [2/2]
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:
clickListener | Indicates the pointer to the callback function. |
SetOnDragListener()
void OHOS::UIView::SetOnDragListener ([OnDragListener]($api-api-SmartVision-Devices-OHOS-UIView-OnDragListener.md) * onDragListener)
Description:
Sets a drag event listener for the view.
Parameters:
onDragListener | Indicates the pointer to the drag event listener to set. |
SetOnKeyActListener()
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:
onKeyActListener | Indicates the pointer to the listener to set. |
SetOnLongPressListener()
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:
onLongPressListener | Indicates the pointer to the long-press event listener to set. |
SetOnSwipeListener()
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:
onSwipeListener | Indicates the listener to set. |
SetOnTouchListener()
void OHOS::UIView::SetOnTouchListener ([OnTouchListener]($api-api-SmartVision-Devices-OHOS-UIView-OnTouchListener.md) * onTouchListener)
Description:
Sets a touch event listener for the view.
Parameters:
onTouchListener | Indicates the pointer to the touch event listener to set. |
SetOnVirtualDeviceEventListener()
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:
onVirtualDeviceEventListener | Indicates the pointer to the listener to set. |
SetOpacity() [1/2]
void OHOS::UIDigitalClock::SetOpacity (uint8_t opacity)
Description:
Sets the opacity for this digital clock.
Parameters:
opacity | Indicates the opacity of this digital clock. The value ranges from 0 (transparency) to 255 (opacity). |
SetOpacity() [2/2]
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:
opacity | Indicates the opacity. The value range is [0, 255]. |
See also:
SetParent()
void OHOS::UIView::SetParent ([UIView]($api-api-SmartVision-Devices-OHOS-UIView.md) * parent)
Description:
Sets the parent view for the view.
Parameters:
parent | Indicates the pointer to the parent view to set. |
SetPeriod()
void OHOS::Task::SetPeriod (uint32_t period)
Description:
Sets the running period for this task.
Parameters:
period | Indicates the running period to set. |
SetPivot()
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:
x | Indicates the x-coordinate to set. |
y | Indicates the y-coordinate to set. |
SetPolygon()
void OHOS::TransformMap::SetPolygon (const [Polygon]($api-api-SmartVision-Devices-OHOS-Polygon.md) & polygon)
Description:
Sets a polygon after rectangle transformation.
Parameters:
polygon | Indicates the polygon to set. |
SetPosition() [1/7]
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:
x | Indicates the coordinate of the left boundary. |
y | Indicates the coordinate of the top boundary. |
SetPosition() [2/7]
virtual void OHOS::UIView::SetPosition (int16_t x, int16_t y )
Description:
Sets the position for the view.
Reimplemented in OHOS::UIAnalogClock, and .
Parameters:
x | Indicates the x-coordinate to set. |
y | Indicates the y-coordinate to set. |
SetPosition() [3/7]
void OHOS::UISurfaceView::SetPosition (int16_t x, int16_t y )
Description:
Sets the position for this view.
Reimplemented from .
Parameters:
x | Indicates the x-coordinate to set. |
y | Indicates the y-coordinate to set. |
SetPosition() [4/7]
void OHOS::UIAnalogClock::SetPosition (int16_t x, int16_t y )
Description:
Sets the position for this analog clock.
Reimplemented from .
Parameters:
x | Indicates the x-coordinate to set. |
y | Indicates the y-coordinate to set. |
SetPosition() [5/7]
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 , and OHOS::UISurfaceView.
Parameters:
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]
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:
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]
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:
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()
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:
preLastPos | Indicates the coordinates of the stay position to set. |
SetProgressImagePosition()
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:
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:
SetRadius()
void OHOS::UICircleProgress::SetRadius (uint16_t radius)
Description:
Sets the outer radius for this circular progress bar.
Parameters:
radius | Indicates the outer radius to set. |
See also:
SetRange()
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:
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:
SetReboundSize()
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:
size | Indicates the rebound size to set. |
SetRect()
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:
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()
void OHOS::UIImageAnimatorView::SetRepeat (bool repeat)
Description:
Sets whether to play this animator for infinite times.
Parameters:
See also:
SetRepeatTimes()
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:
times | Indicates the playback times to set. The default value is 1. |
See also:
SetReverse()
void OHOS::UIImageAnimatorView::SetReverse (bool reverse)
Description:
Sets the playback sequence for this animator.
Parameters:
reverse | Indicates the playback sequence to set. true indicates a reverse playback and false (default value) indicates a forward playback. |
See also:
SetRight()
void OHOS::Rect::SetRight (int16_t right)
Description:
Sets the coordinate of the right boundary of a rectangle.
Parameters:
right | Indicates the coordinate of the right boundary. |
SetRollSpeed()
void OHOS::UILabel::SetRollSpeed (uint16_t speed)
Description:
Sets the scroll speed for this text.
Parameters:
speed | Indicates the scroll speed to set. |
SetRollStartPos()
void OHOS::UILabel::SetRollStartPos (int16_t pos)
Description:
Sets the position where this text starts to roll.
Parameters:
pos | Indicates the position to set. |
SetRotateEnd()
void OHOS::UITextureMapper::SetRotateEnd (int16_t end)
Description:
Sets the end angle of rotation for this image.
Parameters:
end | Indicates the end angle of rotation to set. The default value is 0. |
SetRotateStart()
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:
start | Indicates the start angle to set. The default value is 0. |
SetRows()
void OHOS::GridLayout::SetRows (const uint16_t & rows)
Description:
Sets the number of rows in a grid.
Parameters:
rows | Indicates the number of rows to set. |
SetRunTime()
void OHOS::Animator::SetRunTime (uint32_t runTime)
Description:
Sets the running time for this animator.
Parameters:
runTime | Indicates the running time to set, in milliseconds. |
See also:
SetScaleEnd()
void OHOS::UITextureMapper::SetScaleEnd (float end)
Description:
Sets the end ratio for scaling this image.
Parameters:
end | Indicates the end ratio to set. The default value is 1. |
SetScaleStart()
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:
start | Indicates the start ratio to set. The default value is 1. |
SetScrollbarWidth()
void OHOS::UIScrollView::SetScrollbarWidth (uint8_t width)
Description:
Sets the width for this scroll bar.
Parameters:
width | Indicates the width to set. The default value is DEFAULT_BAR_WIDTH. |
SetScrollBlankSize()
void OHOS::UIAbstractScroll::SetScrollBlankSize (uint16_t size)
Description:
Sets the blank size for this scroll view.
Parameters:
SetScrollStateListener()
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:
scrollListener | Indicates the listener to set. |
SetSecondaryAxisAlign()
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:
align | Indicates the alignment mode to set. The value can be ALIGN_START, ALIGN_CENTER, or ALIGN_END. |
SetSelected() [1/2]
bool OHOS::UITimePicker::SetSelected (const char * value)
Description:
Sets the time currently selected in the time picker.
Parameters:
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]
bool OHOS::UIPicker::SetSelected (uint16_t index)
Description:
Sets the index of the item currently selected in the picker.
Parameters:
index | Indicates the index to set. |
Returns:
Returns true if the setting is successful; returns false otherwise.
SetSelectPosition()
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:
position | Indicates the position to set. The default value is 0, indicating that no position is set. |
SetSizeFixed()
void OHOS::UIImageAnimatorView::SetSizeFixed (bool fixed)
Description:
Sets whether the image size is fixed to the view size.
Parameters:
See also:
SetSliderColor()
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:
backgroundColor | Indicates the background color to set. |
foregroundColor | Indicates the foreground color to set. |
knobColor | Indicates the knob color to set. |
SetSliderEventListener()
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:
listener | Indicates the listener to set. For details, see . |
SetSliderRadius()
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:
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]
bool OHOS::Image::SetSrc (const char * src)
Description:
Sets the image path.
Parameters:
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]
void OHOS::UIImageView::SetSrc (const char * src)
Description:
Sets the image path.
Parameters:
src | Indicates the pointer to the image path represented by a string. |
SetSrc() [3/4]
bool OHOS::Image::SetSrc (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * src)
Description:
Sets the image information.
Parameters:
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]
void OHOS::UIImageView::SetSrc (const [ImageInfo]($api-api-SmartVision-Devices-OHOS-ImageInfo.md) * src)
Description:
Sets the image information.
Parameters:
src | Indicates the pointer to the image information. For details, see . |
SetStartAngle()
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:
startAngle | Indicates the start angle to set, which can be any value represented by int16_t. The default value is 0. |
See also:
SetStartIndex()
void OHOS::UIList::SetStartIndex (uint16_t index)
Description:
Sets the start index for this list.
Parameters:
index | Indicates the start index to set. The default value is 0. |
SetStartPosition()
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:
startPoint | Indicates the coordinates of the start point. |
See also:
SetState() [1/3]
void OHOS::UIToggleButton::SetState (bool state)
Description:
Sets the state for this toggle button.
Parameters:
SetState() [2/3]
void OHOS::UICheckBox::SetState ([UICheckBoxState]($api-api-SmartVision-Devices-Graphic.md#ga15a3f0302aded0e4d1584ddc6002335d) state)
Description:
Sets the state for this check box.
Parameters:
state | Indicates the state of this check box. For details, see UICheckBoxState. |
SetState() [3/3]
void OHOS::Animator::SetState (uint8_t state)
Description:
Sets the current state for this animator.
Parameters:
state | Indicates the current animator state to set, which can be STOP, , or PAUSE. |
See also:
SetStateForStyle()
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:
state | Indicates the button state, as enumerated in ButtonState. |
SetStep()
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:
step | Indicates the step to set. The default value is 1. |
See also:
SetStrokeColor()
void OHOS::Paint::SetStrokeColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)
Description:
Sets the color of a line or border.
Parameters:
color | Indicates the line color when a line is drawn or the border color when a closed graph is drawn. |
See also:
SetStrokeWidth()
void OHOS::Paint::SetStrokeWidth (uint16_t width)
Description:
Sets the width of a line or border.
Parameters:
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:
SetStyle() [1/5]
void OHOS::Paint::SetStyle ([PaintStyle]($api-api-SmartVision-Devices-Graphic.md#ga548320a469b7862fa416af062cad5d7a) style)
Description:
Sets the paint style of a closed graph.
Parameters:
style | Indicates the paint style. Stroke and fill are set by default. For details, see PaintStyle. |
See also:
SetStyle() [2/5]
virtual void OHOS::UIView::SetStyle ([Style]($api-api-SmartVision-Devices-OHOS-Style.md) & style)
Description:
Sets the view style.
Parameters:
style | Indicates the view style. |
SetStyle() [3/5]
void OHOS::Style::SetStyle (uint8_t key, int64_t value )
Description:
Sets a style.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
SetStyle() [4/5]
virtual void OHOS::UIView::SetStyle (uint8_t key, int64_t value )
Description:
Sets a style.
Reimplemented in OHOS::UIButton.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
SetStyle() [5/5]
void OHOS::UIButton::SetStyle (uint8_t key, int64_t value )
Description:
Sets a style.
Reimplemented from OHOS::UIView.
Parameters:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
SetStyleForState()
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:
key | Indicates the key of the style to set. |
value | Indicates the value matching the key. |
state | Indicates the button state, as enumerated in . |
SetSwipeACCLevel()
void OHOS::UIAbstractScroll::SetSwipeACCLevel (uint16_t value)
Description:
Sets the compensation distance after a finger lifts the screen.
Parameters:
value | Indicates the compensation distance to set. The default value is 0. |
SetText() [1/5]
void OHOS::UILabelButton::SetText (const char * text)
Description:
Sets the text for this label button.
Parameters:
text | Indicates the pointer to the text. |
SetText() [2/5]
void OHOS::Text::SetText (const char * text)
Description:
Sets the content for this text.
Parameters:
text | Indicates the pointer to the text content. |
SetText() [3/5]
void OHOS::UIDialog::SetText (const char * text)
Description:
Sets the text for this dialog box.
Parameters:
text | Indicates the pointer to the text. |
SetText() [4/5]
void OHOS::UIArcLabel::SetText (const char * text)
Description:
Sets the text content for this arc label.
Parameters:
text | Indicates the pointer to the text content. |
SetText() [5/5]
void OHOS::UILabel::SetText (const char * text)
Description:
Sets the text content for this label.
Parameters:
text | Indicates the pointer to the text content. |
SetTextColor() [1/3]
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:
backgroundColor | Indicates the color of the background text. |
highlightColor | Indicates the color of the highlighted text. |
SetTextColor() [2/3]
void OHOS::UILabel::SetTextColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)
Description:
Sets the color for this text.
Parameters:
color | Indicates the text color to set. |
SetTextColor() [3/3]
void OHOS::UILabelButton::SetTextColor ([ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) color)
Description:
Sets the color for this text.
Parameters:
color | Indicates the text color to set. |
SetTextFormatter() [1/2]
void OHOS::TextAdapter::SetTextFormatter ([TextFormatter]($api-api-SmartVision-Devices-OHOS-TextFormatter.md) * formatter)
Description:
Sets the text formatter.
Parameters:
formatter | Indicates the pointer to the text formatter. For details, see TextFormatter. |
SetTextFormatter() [2/2]
void OHOS::UIPicker::SetTextFormatter ([TextFormatter]($api-api-SmartVision-Devices-OHOS-TextFormatter.md) * formatter)
Description:
Sets the text formatter.
Parameters:
formatter | Indicates the pointer to the text formatter. For details, see TextFormatter. |
SetTextRotation() [1/2]
void OHOS::Text::SetTextRotation (LabelRotateDegree angle)
Description:
Sets the clockwise rotation angle for this text.
Parameters:
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]
void OHOS::UILabel::SetTextRotation (LabelRotateDegree angle)
Description:
Sets the clockwise rotation angle for this text.
Parameters:
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()
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:
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()
void OHOS::UIAbstractScroll::SetThrowDrag (bool throwDrag)
Description:
Sets whether to continue scrolling after a finger lifts the screen.
Parameters:
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()
void OHOS::Animator::SetTime (uint32_t time)
Description:
Sets the total duration for this animator.
Parameters:
time | Indicates the total duration to set, in milliseconds. |
See also:
SetTime12Hour()
void OHOS::UIAbstractClock::SetTime12Hour (uint8_t hour, uint8_t minute, uint8_t second, bool am )
Description:
Sets the time in 12-hour format.
Parameters:
SetTime24Hour()
void OHOS::UIAbstractClock::SetTime24Hour (uint8_t hour, uint8_t minute, uint8_t second )
Description:
Sets the time in 24-hour format.
Parameters:
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()
void OHOS::UIImageAnimatorView::SetTimeOfPause (uint16_t timeOfPause)
Description:
Sets the interval between two playbacks of an infinitely repeated animator.
Parameters:
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:
SetTimeOfUpdate()
void OHOS::UIImageAnimatorView::SetTimeOfUpdate (uint16_t timeOfUpdate)
Description:
Sets the speed for this animator.
Parameters:
timeOfUpdate | Indicates the interval for updating images, in milliseconds. The default value is 1. |
See also:
SetTimeStamp()
void OHOS::Event::SetTimeStamp (const TimeType & timeStamp)
Description:
Sets the timestamp when an event occurs.
Parameters:
timeStamp | Indicates the timestamp of the event to set. |
SetTitle()
void OHOS::UIDialog::SetTitle (const char * title)
Description:
Sets the title for this dialog box.
Parameters:
title | Indicates the pointer to the title. |
SetTop()
void OHOS::Rect::SetTop (int16_t top)
Description:
Sets the coordinate of the top boundary of a rectangle.
Parameters:
top | Indicates the coordinate of the top boundary. |
SetTopPointStyle()
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:
style | Indicates the style to set. For details, see . |
SetTouchable()
void OHOS::UIView::SetTouchable (bool touch)
Description:
Sets whether the view is touchable.
Parameters:
touchable | Specifies whether to set the view touchable. Value true means to set the view touchable, and false means the opposite. |
SetTransformAlgorithm()
void OHOS::UIImageView::SetTransformAlgorithm (TransformAlgorithm algorithm)
Description:
Sets the algorithm used for image rotation and scaling.
Parameters:
algorithm | Indicates the image transformation algorithm. For details, see TransformAlgorithm. |
SetTransformMap()
void OHOS::UIView::SetTransformMap (const [TransformMap]($api-api-SmartVision-Devices-OHOS-TransformMap.md) & transMap)
Description:
Sets the affine transformation matrix.
Parameters:
transMap | Indicates the transformation matrix. |
SetValidHeight()
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:
height | Indicates the actual height to set. |
See also:
SetValidWidth()
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:
width | Indicates the actual width of this progress bar. |
See also:
SetValue()
void OHOS::UIAbstractProgress::SetValue (int16_t value)
Description:
Sets the current value for this progress bar.
Parameters:
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:
| GetValue
SetValues() [1/2]
bool OHOS::UIPicker::SetValues (const char * value[], uint16_t count )
Description:
Sets dynamic text data in the picker by using a string array.
Parameters:
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]
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:
start | Indicates the start integer. |
end | Indicates the end integer. |
Returns:
Returns true if the setting is successful; returns false otherwise.
SetVertexNum()
void OHOS::Polygon::SetVertexNum (uint8_t vertexNum)
Description:
Sets the number of vertices of a polygon.
Parameters:
vertexNum | Indicates the number of vertices. |
SetVerticalScrollState()
void OHOS::UIScrollView::SetVerticalScrollState (bool state)
Description:
Sets whether a vertical scroll is enabled.
Parameters:
state | Specifies whether a vertical scroll is enabled. true indicates a vertical scroll is enabled, and false indicates the opposite case. |
SetViewId()
void OHOS::UIView::SetViewId (const char * id)
Description:
Sets the view ID.
Parameters:
id | Indicates the pointer to the view ID. |
SetViewIndex()
void OHOS::UIView::SetViewIndex (int16_t index)
Description:
Sets the view index.
Parameters:
index | Indicates the view index to set. |
SetVisible() [1/3]
virtual void OHOS::UIView::SetVisible (bool visible)
Description:
Sets whether the view is visible.
Reimplemented in , and OHOS::UIDialog.
Parameters:
visible | Specifies whether to set the view visible. Value true means to set the view visible, and false means the opposite. |
SetVisible() [2/3]
void OHOS::UIDialog::SetVisible (bool visible)
Description:
Sets whether a dialog box is visible.
Reimplemented from OHOS::UIView.
Parameters:
visible | Specifies whether a dialog box is visible. The value true means visible, and false means invisible. |
SetVisible() [3/3]
void OHOS::UISurfaceView::SetVisible (bool visible)
Description:
Sets whether this view is visible.
Reimplemented from OHOS::UIView.
Parameters:
visible | Specifies whether this view is visible. true indicates this view is visible, and false indicates the opposite case. |
SetWidth() [1/10]
void OHOS::TextAdapter::SetWidth (int16_t width)
Description:
Sets the width of UILabel constructed by the adapter.
Returns:
Returns the width of .
SetWidth() [2/10]
void OHOS::Rect::SetWidth (int16_t width)
Description:
Changes the width of the rectangle without changing the coordinate of the left boundary.
Parameters:
width | Indicates the width of the rectangle. |
SetWidth() [3/10]
virtual void OHOS::UIView::SetWidth (int16_t width)
Description:
Sets the width for the view.
Reimplemented in , OHOS::UILabel, , OHOS::UIPicker, , OHOS::UISurfaceView, and .
Parameters:
width | Indicates the width to set. |
SetWidth() [4/10]
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 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:
width | Indicates the width of the view. |
See also:
SetWidth() [5/10]
void OHOS::UISurfaceView::SetWidth (int16_t width)
Description:
Sets the width for this view.
Reimplemented from .
Parameters:
width | Indicates the width to set. |
SetWidth() [6/10]
void OHOS::UITimePicker::SetWidth (int16_t width)
Description:
Sets the width for the time picker.
Reimplemented from .
Parameters:
width | Indicates the width to set. |
SetWidth() [7/10]
void OHOS::UIPicker::SetWidth (int16_t width)
Description:
Sets the width for this component.
Reimplemented from .
Parameters:
width | Indicates the width to set. |
SetWidth() [8/10]
void OHOS::UIButton::SetWidth (int16_t width)
Description:
Sets the width for this image.
Reimplemented from .
Parameters:
width | Indicates the width to set. |
SetWidth() [9/10]
void OHOS::UILabel::SetWidth (int16_t width)
Description:
Sets the width for this label.
Reimplemented from .
Parameters:
width | Indicates the width to set. |
SetWidth() [10/10]
void OHOS::UIChart::SetWidth (int16_t width)
Description:
Sets the width for this component.
Reimplemented from .
Parameters:
width | Indicates the width to set. |
SetWorkMode() [1/2]
virtual void OHOS::UIAbstractClock::SetWorkMode ([WorkMode]($api-api-SmartVision-Devices-Graphic.md#ga19db90932bc71e6bbced6ccf2935ac98) newMode)
Description:
Sets the working mode for this clock.
Reimplemented in .
Parameters:
newMode | Indicates the working mode to set. For details, see . |
SetWorkMode() [2/2]
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:
newMode | Indicates the working mode to set. For details, see WorkMode. |
SetX() [1/3]
void OHOS::Rect::SetX (int16_t x)
Description:
Changes the left boundary coordinate of the rectangle without changing the rectangle width.
Parameters:
x | Indicates the coordinate of the left boundary. |
SetX() [2/3]
virtual void OHOS::UIView::SetX (int16_t x)
Description:
Sets the x-coordinate for the view.
Reimplemented in OHOS::UISurfaceView.
Parameters:
x | Indicates the x-coordinate to set. |
SetX() [3/3]
void OHOS::UISurfaceView::SetX (int16_t x)
Description:
Sets the x-coordinate for this view.
Reimplemented from OHOS::UIView.
Parameters:
x | Indicates the x-coordinate to set. |
SetXScrollBarVisible()
void OHOS::UIScrollView::SetXScrollBarVisible (bool state)
Description:
Sets whether the horizontal scroll bar is visible.
Parameters:
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]
void OHOS::Rect::SetY (int16_t y)
Description:
Changes the top boundary coordinate of the rectangle without changing the rectangle height.
Parameters:
y | Indicates the coordinate of the top boundary. |
SetY() [2/3]
virtual void OHOS::UIView::SetY (int16_t y)
Description:
Sets the y-coordinate for the view.
Reimplemented in OHOS::UISurfaceView.
Parameters:
y | Indicates the y-coordinate to set. |
SetY() [3/3]
void OHOS::UISurfaceView::SetY (int16_t y)
Description:
Sets the y-coordinate for this view.
Reimplemented from OHOS::UIView.
Parameters:
y | Indicates the y-coordinate to set. |
SetYScrollBarVisible()
void OHOS::UIScrollView::SetYScrollBarVisible (bool state)
Description:
Sets whether the vertical scroll bar is visible.
Parameters:
state | Specifies whether this vertical scroll bar is visible. true indicates the horizontal scroll bar is visible, and false indicates the opposite case. |
Silver()
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()
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:
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:
SineEaseInOut()
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:
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()
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:
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:
Size()
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]
void OHOS::UITextureMapper::Start ()
Description:
Starts this animator.
Start() [2/3]
void OHOS::Animator::Start ()
Description:
Starts this animator.
See also:
Start() [3/3]
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() [1/2]
void OHOS::Animator::Stop ()
Description:
Stops this animator.
See also:
Stop() [2/2]
void OHOS::UIImageAnimatorView::Stop (bool needReset = [/topic/body/section/screen/code
{""}) true (code])
Description:
Stops this animator.
Parameters:
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:
Style()
OHOS::Style::Style ()
Description:
A constructor used to create a instance.
StyleDefault()
OHOS::StyleDefault::StyleDefault ()
Description:
A constructor used to create a StyleDefault instance.
SuthHodgClip()
[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:
clipRect | Indicates the rectangle used for clipping the polygon. |
polygon | Indicates the polygon to clip. |
Returns:
Returns the polygon after clipping.
Tail()
[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()
OHOS::Task::Task (uint32_t period)
Description:
A constructor used to create a Task instance with the specified running period.
Parameters:
period | Indicates the running period of this task. |
Teal()
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()
OHOS::Text::Text ()
Description:
A constructor used to create a Text instance.
TextAdapter()
OHOS::TextAdapter::TextAdapter ()
Description:
A constructor used to create a instance.
Theme()
OHOS::Theme::Theme ()
Description:
A constructor used to create a Theme instance.
TransformMap() [1/2]
OHOS::TransformMap::TransformMap ()
Description:
The default constructor used to create a instance.
TransformMap() [2/2]
OHOS::TransformMap::TransformMap (const [Rect]($api-api-SmartVision-Devices-OHOS-Rect.md) & rect)
Description:
A constructor used to create a TransformMap instance.
Parameters:
rect | Indicates the rectangle to transform. |
Translate()
[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:
trans | Indicates the distances to translate along the x-axis and y-axis. |
Returns:
Returns the matrix after translation.
TranslateToPixel() [1/3]
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 .
Parameters:
value | Indicates the current value. The x coordinate obtained after translation is also printed using this parameter. |
TranslateToPixel() [2/3]
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 .
Parameters:
value | Indicates the current value. The y coordinate obtained after translation is also printed using this parameter. |
TranslateToPixel() [3/3]
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 based on the value of value and the data range of the coordinate axis.
Implemented in OHOS::UIYAxis, and .
Parameters:
value | Indicates the current value. The coordinate value obtained after translation is also printed using this parameter. |
UIAbstractClock() [1/2]
OHOS::UIAbstractClock::UIAbstractClock ()
Description:
A default constructor used to create a instance.
UIAbstractClock() [2/2]
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:
hour | Indicates the hour. |
minute | Indicates the minute. |
second | Indicates the second. |
UIAbstractProgress()
OHOS::UIAbstractProgress::UIAbstractProgress ()
Description:
A constructor used to create a UIAbstractProgress instance.
UIAbstractScroll()
OHOS::UIAbstractScroll::UIAbstractScroll ()
Description:
A constructor used to create a instance.
UIAnalogClock()
OHOS::UIAnalogClock::UIAnalogClock ()
Description:
A default constructor used to create a UIAnalogClock instance.
UIArcLabel()
OHOS::UIArcLabel::UIArcLabel ()
Description:
A default constructor used to create a instance.
UIAxis()
OHOS::UIAxis::UIAxis ()
Description:
A constructor used to create a UIAxis instance.
UIBoxProgress()
OHOS::UIBoxProgress::UIBoxProgress ()
Description:
A constructor used to create a instance.
UIButton() [1/2]
OHOS::UIButton::UIButton ()
Description:
A constructor used to create a UIButton instance.
UIButton() [2/2]
OHOS::UIButton::UIButton (const char * id)
Description:
A constructor used to create a instance based on the button ID.
Buttons sharing the same ID are in the same batch.
Parameters:
id | Indicates the button ID. |
UICanvas()
OHOS::UICanvas::UICanvas ()
Description:
A constructor used to create a instance.
UIChart()
OHOS::UIChart::UIChart ()
Description:
A constructor used to create a UIChart instance.
UIChartDataSerial()
OHOS::UIChartDataSerial::UIChartDataSerial ()
Description:
A constructor used to create a instance.
UIChartPillar()
OHOS::UIChartPillar::UIChartPillar ()
Description:
A constructor used to create a UIChartPillar instance.
UIChartPolyline()
OHOS::UIChartPolyline::UIChartPolyline ()
Description:
A constructor used to create a instance.
UICheckBox()
OHOS::UICheckBox::UICheckBox ()
Description:
A constructor used to create a UICheckBox instance.
UICircleProgress()
OHOS::UICircleProgress::UICircleProgress ()
Description:
A constructor used to create a instance.
UIDialog()
OHOS::UIDialog::UIDialog ()
Description:
A constructor used to create a UIDialog instance.
UIDigitalClock()
OHOS::UIDigitalClock::UIDigitalClock ()
Description:
A default constructor used to create a instance.
UIFree()
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:
buffer | Indicates the pointer to the memory to be released. |
UIImageAnimatorView()
OHOS::UIImageAnimatorView::UIImageAnimatorView ()
Description:
A constructor used to create a instance.
UIImageView()
OHOS::UIImageView::UIImageView ()
Description:
A default constructor used to create a UIImageView instance.
UILabel()
OHOS::UILabel::UILabel ()
Description:
A constructor used to create a instance.
UILabelButton()
OHOS::UILabelButton::UILabelButton ()
Description:
A constructor used to create a UILabelButton instance.
UIList() [1/2]
OHOS::UIList::UIList ()
Description:
A constructor used to create a instance in the vertical direction.
UIList() [2/2]
OHOS::UIList::UIList (uint8_t direction)
Description:
A constructor used to create a UIList instance in the specified direction.
Parameters:
direction | Indicates the UIList direction, either HORIZONTAL or VERTICAL. |
UIMalloc()
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:
size | Indicates the size of the memory to apply for. |
UIPicker()
OHOS::UIPicker::UIPicker ()
Description:
A constructor used to create a UIPicker instance.
UIRadioButton()
OHOS::UIRadioButton::UIRadioButton ()
Description:
A constructor used to create a instance.
UIRepeatButton()
OHOS::UIRepeatButton::UIRepeatButton ()
Description:
A constructor used to create a UIRepeatButton instance.
UIScrollView()
OHOS::UIScrollView::UIScrollView ()
Description:
A constructor used to create a instance, with both horizontal and vertical scrolls supported.
UISlider()
OHOS::UISlider::UISlider ()
Description:
A constructor used to create a UISlider instance.
UISurfaceView()
OHOS::UISurfaceView::UISurfaceView ()
Description:
A constructor used to create a instance.
UISwipeView()
OHOS::UISwipeView::UISwipeView (uint8_t direction = [/topic/body/section/screen/code
{""}) [HORIZONTAL]($api-api-SmartVision-Devices-Graphic.md#ga34dfbde0fad8baade31c02d9e8dd5026) (code])
Description:
A constructor used to create a UISwipeView instance.
UITextureMapper()
OHOS::UITextureMapper::UITextureMapper ()
Description:
A constructor used to create a instance.
UITimePicker()
OHOS::UITimePicker::UITimePicker ()
Description:
A constructor used to create a UITimePicker instance.
UIToggleButton()
OHOS::UIToggleButton::UIToggleButton ()
Description:
A constructor used to create a instance.
UIView() [1/2]
OHOS::UIView::UIView ()
Description:
A default constructor used to create an UIView instance.
UIView() [2/2]
OHOS::UIView::UIView (const char * id)
Description:
A constructor used to create an instance.
Parameters:
id | Indicates the pointer to the view ID. |
UIViewGroup()
OHOS::UIViewGroup::UIViewGroup ()
Description:
A default constructor used to create a instance.
UIXAxis()
OHOS::UIXAxis::UIXAxis ()
Description:
A constructor used to create a UIXAxis instance.
UIYAxis()
OHOS::UIYAxis::UIYAxis ()
Description:
A constructor used to create a instance.
UpdateClock() [1/3]
virtual void OHOS::UIAbstractClock::UpdateClock (bool clockInit)
Description:
Updates this clock.
Reimplemented in OHOS::UIAnalogClock, and .
Parameters:
clockInit | Specifies whether it is the first initialization. true indicates it is the first initialization, and false indicates the opposite case. |
UpdateClock() [2/3]
void OHOS::UIDigitalClock::UpdateClock (bool clockInit)
Description:
Updates this digital clock.
Reimplemented from .
Parameters:
clockInit | Specifies whether the first initialization. true indicates the first initialization, and false indicates the opposite case. |
UpdateClock() [3/3]
void OHOS::UIAnalogClock::UpdateClock (bool clockInit)
Description:
Updates the time of this analog clock.
Reimplemented from .
Parameters:
clockInit | Specifies whether it is the first initialization. true indicates it is the first initialization, and false indicates the opposite case. |
Vector2() [1/2]
[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 instance.
Vector2() [2/2]
[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:
x | Indicates the X coordinate. |
y | Indicates the Y coordinate. |
Vector3() [1/2]
[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]
[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 instance and initializes the values of x, y, and z.
Parameters:
VirtualDeviceEvent()
OHOS::VirtualDeviceEvent::VirtualDeviceEvent (uint16_t type, uint16_t value )
Description:
A constructor used to create a instance.
Parameters:
type | Indicates the virtual device type. The options are AOD and PRIVATE. |
value | Indicates the virtual event value. |
White()
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()
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()
virtual OHOS::AbstractAdapter::~AbstractAdapter ()
Description:
A destructor used to delete the instance.
~Animator()
virtual OHOS::Animator::~Animator ()
Description:
A destructor used to delete the Animator instance.
~AnimatorCallback()
virtual OHOS::AnimatorCallback::~AnimatorCallback ()
Description:
A default destructor used to delete an instance.
~AnimatorStopListener() [1/2]
virtual OHOS::UITextureMapper::AnimatorStopListener::~AnimatorStopListener ()
Description:
A destructor used to delete an AnimatorStopListener instance.
~AnimatorStopListener() [2/2]
virtual OHOS::UIImageAnimatorView::AnimatorStopListener::~AnimatorStopListener ()
Description:
A destructor used to delete an instance.
~CancelEvent()
virtual OHOS::CancelEvent::~CancelEvent ()
Description:
A destructor used to delete the CancelEvent instance.
~ClickEvent()
virtual OHOS::ClickEvent::~ClickEvent ()
Description:
A destructor used to delete the instance.
~DragEvent()
virtual OHOS::DragEvent::~DragEvent ()
Description:
A destructor used to delete the DragEvent instance.
~Event()
virtual OHOS::Event::~Event ()
Description:
A destructor used to delete the instance.
~FlexLayout()
virtual OHOS::FlexLayout::~FlexLayout ()
Description:
A destructor used to delete the FlexLayout instance.
~GridLayout()
virtual OHOS::GridLayout::~GridLayout ()
Description:
A destructor used to delete the instance.
~Hand()
virtual OHOS::UIAnalogClock::Hand::~Hand ()
Description:
A destructor used to delete the Hand instance.
~Image()
virtual OHOS::Image::~Image ()
Description:
A destructor used to delete the instance.
~KeyEvent()
OHOS::KeyEvent::~KeyEvent ()
Description:
A destructor used to delete the KeyEvent instance.
~Layout()
virtual OHOS::Layout::~Layout ()
Description:
A destructor used to delete the instance.
~Line()
OHOS::Line::~Line ()
Description:
A destructor used to delete the Line instance.
~List()
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 instance.
~ListScrollListener()
virtual OHOS::ListScrollListener::~ListScrollListener ()
Description:
A destructor used to delete the ListScrollListener instance.
~LongPressEvent()
virtual OHOS::LongPressEvent::~LongPressEvent ()
Description:
A destructor used to delete the instance.
~Matrix3()
[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()
virtual OHOS::UICheckBox::OnChangeListener::~OnChangeListener ()
Description:
A destructor used to delete the instance.
~OnClickListener()
virtual OHOS::UIView::OnClickListener::~OnClickListener ()
Description:
A destructor used to delete the OnClickListener instance.
~OnDragListener()
virtual OHOS::UIView::OnDragListener::~OnDragListener ()
Description:
A destructor used to delete the instance.
~OnFPSChangedListener()
virtual OHOS::SysInfo::OnFPSChangedListener::~OnFPSChangedListener ()
Description:
A destructor used to delete the OnFPSChangedListener instance.
~OnLongPressListener()
virtual OHOS::UIView::OnLongPressListener::~OnLongPressListener ()
Description:
A destructor used to delete the instance.
~OnScrollListener()
virtual OHOS::UIScrollView::OnScrollListener::~OnScrollListener ()
Description:
A destructor used to delete the OnScrollListener instance.
~OnTouchListener()
virtual OHOS::UIView::OnTouchListener::~OnTouchListener ()
Description:
A destructor used to delete the instance.
~Paint()
virtual OHOS::Paint::~Paint ()
Description:
A destructor used to delete the Paint instance.
~Polygon()
OHOS::Polygon::~Polygon ()
Description:
A destructor used to delete the instance.
~PressEvent()
virtual OHOS::PressEvent::~PressEvent ()
Description:
A destructor used to delete the PressEvent instance.
~Rect()
OHOS::Rect::~Rect ()
Description:
A destructor used to delete the instance.
~ReleaseEvent()
virtual OHOS::ReleaseEvent::~ReleaseEvent ()
Description:
A destructor used to delete the ReleaseEvent instance.
~SelectedListener() [1/2]
OHOS::UITimePicker::SelectedListener::~SelectedListener ()
Description:
A destructor used to delete the instance.
~SelectedListener() [2/2]
virtual OHOS::UIPicker::SelectedListener::~SelectedListener ()
Description:
A destructor used to delete the SelectedListener instance.
~Style()
virtual OHOS::Style::~Style ()
Description:
A destructor used to delete the instance.
~StyleDefault()
OHOS::StyleDefault::~StyleDefault ()
Description:
A destructor used to delete the StyleDefault instance.
~Text()
virtual OHOS::Text::~Text ()
Description:
A destructor used to delete the instance.
~TextAdapter()
virtual OHOS::TextAdapter::~TextAdapter ()
Description:
A destructor used to delete the UILabel instance.
~Theme()
virtual OHOS::Theme::~Theme ()
Description:
A destructor used to delete the instance.
~TransformMap()
OHOS::TransformMap::~TransformMap ()
Description:
A destructor used to delete the TransformMap instance.
~UIAbstractClock()
virtual OHOS::UIAbstractClock::~UIAbstractClock ()
Description:
A destructor used to delete the instance.
~UIAbstractProgress()
virtual OHOS::UIAbstractProgress::~UIAbstractProgress ()
Description:
A destructor used to delete the UIAbstractProgress instance.
~UIAbstractScroll()
virtual OHOS::UIAbstractScroll::~UIAbstractScroll ()
Description:
A destructor used to delete the instance.
~UIAnalogClock()
virtual OHOS::UIAnalogClock::~UIAnalogClock ()
Description:
A destructor used to delete the UIAnalogClock instance.
~UIArcLabel()
virtual OHOS::UIArcLabel::~UIArcLabel ()
Description:
A destructor used to delete the instance.
~UIAxis()
virtual OHOS::UIAxis::~UIAxis ()
Description:
A destructor used to delete the UIAxis instance.
~UIBoxProgress()
virtual OHOS::UIBoxProgress::~UIBoxProgress ()
Description:
A destructor used to delete the instance.
~UIButton()
virtual OHOS::UIButton::~UIButton ()
Description:
A destructor used to delete the UIButton instance.
~UICanvas()
virtual OHOS::UICanvas::~UICanvas ()
Description:
A destructor used to delete the instance.
~UIChart()
virtual OHOS::UIChart::~UIChart ()
Description:
A destructor used to delete the UIChart instance.
~UIChartDataSerial()
virtual OHOS::UIChartDataSerial::~UIChartDataSerial ()
Description:
A destructor used to delete the instance.
~UIChartPillar()
virtual OHOS::UIChartPillar::~UIChartPillar ()
Description:
A destructor used to delete the UIChartPillar instance.
~UIChartPolyline()
virtual OHOS::UIChartPolyline::~UIChartPolyline ()
Description:
A destructor used to delete the instance.
~UICheckBox()
virtual OHOS::UICheckBox::~UICheckBox ()
Description:
A destructor used to delete the UICheckBox instance.
~UICircleProgress()
virtual OHOS::UICircleProgress::~UICircleProgress ()
Description:
A destructor used to delete the instance.
~UIDialog()
virtual OHOS::UIDialog::~UIDialog ()
Description:
A destructor used to delete the UIDialog instance.
~UIDigitalClock()
virtual OHOS::UIDigitalClock::~UIDigitalClock ()
Description:
A destructor used to delete the instance.
~UIImageAnimatorView()
virtual OHOS::UIImageAnimatorView::~UIImageAnimatorView ()
Description:
A destructor used to delete the UIImageAnimatorView instance.
~UIImageView()
virtual OHOS::UIImageView::~UIImageView ()
Description:
A destructor used to delete the instance.
~UILabel()
virtual OHOS::UILabel::~UILabel ()
Description:
A destructor used to delete the UILabel instance.
~UILabelButton()
virtual OHOS::UILabelButton::~UILabelButton ()
Description:
A destructor used to delete the instance.
~UIList()
virtual OHOS::UIList::~UIList ()
Description:
A destructor used to delete the UIList instance.
~UIPicker()
virtual OHOS::UIPicker::~UIPicker ()
Description:
A destructor used to delete the instance.
~UIRadioButton()
virtual OHOS::UIRadioButton::~UIRadioButton ()
Description:
A destructor used to delete the UIRadioButton instance.
~UIRepeatButton()
virtual OHOS::UIRepeatButton::~UIRepeatButton ()
Description:
A destructor used to delete the instance.
~UIScrollView()
virtual OHOS::UIScrollView::~UIScrollView ()
Description:
A destructor used to delete the UIScrollView instance.
~UISlider()
virtual OHOS::UISlider::~UISlider ()
Description:
A destructor used to delete the instance.
~UISliderEventListener()
virtual OHOS::UISlider::UISliderEventListener::~UISliderEventListener ()
Description:
A destructor used to delete the UISliderEventListener instance.
~UISurfaceView()
OHOS::UISurfaceView::~UISurfaceView ()
Description:
A destructor used to delete the instance.
~UISwipeView()
virtual OHOS::UISwipeView::~UISwipeView ()
Description:
A destructor used to delete the UISwipeView instance.
~UITextureMapper()
virtual OHOS::UITextureMapper::~UITextureMapper ()
Description:
A destructor used to delete the instance.
~UITimePicker()
virtual OHOS::UITimePicker::~UITimePicker ()
Description:
A destructor used to delete the UITimePicker instance.
~UIToggleButton()
virtual OHOS::UIToggleButton::~UIToggleButton ()
Description:
A destructor used to delete the instance.
~UIView()
virtual OHOS::UIView::~UIView ()
Description:
A destructor used to delete the UIView instance.
~UIViewGroup()
virtual OHOS::UIViewGroup::~UIViewGroup ()
Description:
A destructor used to delete the instance.
~UIXAxis()
virtual OHOS::UIXAxis::~UIXAxis ()
Description:
A destructor used to delete the UIXAxis instance.
~UIYAxis()
virtual OHOS::UIYAxis::~UIYAxis ()
Description:
A destructor used to delete the instance.
~Vector2()
[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()
[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 instance.
~VirtualDeviceEvent()
OHOS::VirtualDeviceEvent::~VirtualDeviceEvent ()
Description:
A destructor used to delete the VirtualDeviceEvent instance.
Variable Documentation
align
[UITextLanguageAlignment]($api-api-SmartVision-Devices-Graphic.md#ga3f99b58f731a37cacde72d5e0c934593) OHOS::UICanvas::FontStyle::align
Description:
alignment mode. For details, see UITextLanguageAlignment.
alpha [1/2]
uint8_t OHOS::Color32::alpha
Description:
Alpha (how opaque each pixel is)
alpha [2/2]
uint8_t { ... } ::alpha
Description:
Alpha (how opaque each pixel is)
ANIMATOR_TIME
constexpr static uint16_t OHOS::UISwipeView::ANIMATOR_TIME = 12
Description:
Indicates that the animation duration is 12 ticks.
blue [1/5]
uint16_t { ... } ::blue
Description:
Blue
blue [2/5]
uint16_t OHOS::Color16::blue
Description:
Blue
blue [3/5]
uint8_t OHOS::Color24::blue
Description:
Blue
blue [4/5]
uint8_t OHOS::Color32::blue
Description:
Blue
blue [5/5]
uint8_t { ... } ::blue
Description:
Blue
CIRCLE_IN_DEGREE
constexpr uint16_t OHOS::CIRCLE_IN_DEGREE = 360
Description:
A full rotation: 360 degrees
colorMode
uint32_t OHOS::ImageHeader::colorMode
Description:
Color format, which is used to match image type. This variable is important.
data
const uint8_t* OHOS::ImageInfo::data
Description:
Pixel color data of pixelmap images
dataSize
uint32_t OHOS::ImageInfo::dataSize
Description:
Size of the image data (in bytes)
DEFAULT_BLANK_SIZE
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
[UITextLanguageDirect]($api-api-SmartVision-Devices-Graphic.md#ga0c108f97781843f67c101b47b6c00cf0) OHOS::UICanvas::FontStyle::direct
Description:
direction. For details, see UITextLanguageDirect.
fillColor
[ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIChartDataSerial::PointStyle::fillColor
Description:
Fill color
fontName
const char* OHOS::UICanvas::FontStyle::fontName
Description:
Font name
fontSize
uint8_t OHOS::UICanvas::FontStyle::fontSize
Description:
Font size
full [1/2]
uint16_t OHOS::Color16::full
Description:
Full RGB data
full [2/2]
uint32_t OHOS::Color32::full
Description:
Full RGB data
green [1/5]
uint16_t { ... } ::green
Description:
Green
green [2/5]
uint16_t OHOS::Color16::green
Description:
Green
green [3/5]
uint8_t OHOS::Color24::green
Description:
Green
green [4/5]
uint8_t { ... } ::green
Description:
Green
green [5/5]
uint8_t OHOS::Color32::green
Description:
Green
header
[ImageHeader]($api-api-SmartVision-Devices-OHOS-ImageHeader.md) OHOS::ImageInfo::header
Description:
Image head node information. For details, see .
height [1/2]
uint16_t OHOS::ImageHeader::height
Description:
Image height
height [2/2]
int16_t OHOS::ImageAnimatorInfo::height
Description:
height
HORIZONTAL
constexpr uint8_t OHOS::UISwipeView::HORIZONTAL = 0
Description:
Indicates the horizontal direction.
imageInfo
const char* OHOS::ImageAnimatorInfo::imageInfo
Description:
Image path or pointer to the structure
inactive
[Style]($api-api-SmartVision-Devices-OHOS-Style.md) OHOS::ButtonStyle::inactive
Description:
Style when inactive
letterSpace
int16_t OHOS::UICanvas::FontStyle::letterSpace
Description:
Letter-spacing
MAX_VERTEX_NUM
const uint8_t OHOS::Polygon::MAX_VERTEX_NUM = 8
Description:
Maximum number of vertices in a polygon
pos
[Point]($api-api-SmartVision-Devices-OHOS-Point.md) OHOS::ImageAnimatorInfo::pos
Description:
start position, relative to this view
pressed
[Style]($api-api-SmartVision-Devices-OHOS-Style.md) OHOS::ButtonStyle::pressed
Description:
Style when pressed
QUARTER_IN_DEGREE
constexpr uint16_t OHOS::QUARTER_IN_DEGREE = 90
Description:
A quarter of a rotation: 90 degrees
radius
uint16_t OHOS::UIChartDataSerial::PointStyle::radius
Description:
Inner radius
red [1/5]
uint16_t OHOS::Color16::red
Description:
Red
red [2/5]
uint16_t { ... } ::red
Description:
Red
red [3/5]
uint8_t OHOS::Color24::red
Description:
Red
red [4/5]
uint8_t OHOS::Color32::red
Description:
Red
red [5/5]
uint8_t { ... } ::red
Description:
Red
released
[Style]($api-api-SmartVision-Devices-OHOS-Style.md) OHOS::ButtonStyle::released
Description:
when released
SEMICIRCLE_IN_DEGREE
constexpr uint16_t OHOS::SEMICIRCLE_IN_DEGREE = 180
Description:
A half of a rotation: 180 degrees
STOP_DISTANCE
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
[ColorType]($api-api-SmartVision-Devices-OHOS-Color32.md) OHOS::UIChartDataSerial::PointStyle::strokeColor
Description:
Border color
strokeWidth
uint16_t OHOS::UIChartDataSerial::PointStyle::strokeWidth
Description:
Border width, which extends outwards from the inner radius
TEXT_ELLIPSIS_END_INV
constexpr uint16_t OHOS::Text::TEXT_ELLIPSIS_END_INV = 0xFFFF
Description:
Invalid value for the ellipsis position
THREE_QUARTER_IN_DEGREE
constexpr uint16_t OHOS::THREE_QUARTER_IN_DEGREE = 270
Description:
Three fourths of a rotation: 270 degrees
UI_PI
constexpr double OHOS::UI_PI = 3.14159265358979
Description:
Pi value
userData
Description:
User-defined data
VERTICAL
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:
width
x
Description:
X coordinate
int16_t OHOS::Point::y
Description: