OHOS::UILabel

    Graphic

    Description:

    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.

    Since:

    1.0

    Version:

    1.0

    Public Member Function Name

    Description

    ()

     

    A constructor used to create a UILabel instance.

    ()

    virtual 

    A destructor used to delete the UILabel instance.

    () const override

    UIViewType 

    Obtains the view type.

    GetWidth () override

    int16_t 

    Obtains the width of this label.

    () override

    int16_t 

    Obtains the height of this label.

    OnPreDraw (const &invalidatedArea) override

    bool 

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

    OnDraw (const &invalidatedArea) override

    void 

    Draws this label.

    SetText (const char text)

    void 

    Sets the text content for this label.

    () const

    const char  

    Obtains the text of this label.

    SetLineBreakMode (const uint8_t lineBreakMode)

    void 

    Sets the line break mode for this text.

    () const

    uint8_t 

    Obtains the line break mode of this text.

    SetTextColor ( color)

    void 

    Sets the color for this text.

    GetTextColor () const

     

    Obtains the color of this text.

    SetAlign ( horizontalAlign, UITextLanguageAlignment verticalAlign=TEXT_ALIGNMENT_TOP)

    void 

    Sets the alignment mode for this text.

    () const

    UITextLanguageAlignment 

    Obtains the horizontal alignment mode.

    () const

    UITextLanguageAlignment 

    Obtains the vertical alignment mode.

    (UITextLanguageDirect direct)

    void 

    Sets the direction for this text.

    () const

    UITextLanguageDirect 

    Obtains the direction of this text.

    (uint8_t fontId)

    void 

    Sets the font ID for this label.

    GetFontId () const

    uint8_t 

    Obtains the font ID composed of font name and size.

    (const char name, uint8_t size)

    void 

    Sets the font for this label.

    SetRollSpeed (uint16_t speed)

    void 

    Sets the scroll speed for this text.

    ()

    uint16_t 

    Obtains the width of this text.

    GetTextHeight ()

    uint16_t 

    Obtains the height of this text.

    (int16_t pos)

    void 

    Sets the position where this text starts to roll.

    GetRollStartPos () const

    int16_t 

    Obtains the position where this text starts to roll.

    (int16_t width) override

    void 

    Sets the width for this label.

    SetHeight (int16_t height) override

    void 

    Sets the height for this label.

    (LabelRotateDegree angle)

    void 

    Sets the clockwise rotation angle for this text.

    GetTextRotation () const

    LabelRotateDegree 

    Obtains the clockwise rotation degree of this text.

    () const

    uint16_t 

    Obtains the number of text rotation degrees.

    UIView ()

     

    A default constructor used to create an instance.

    UIView (const char id)

     

    A constructor used to create an instance.

    ~UIView ()

    A destructor used to delete the instance.

    OnPostDraw (const &invalidatedArea)

    virtual void 

    Called after a view is drawn.

    Invalidate ()

    void 

    Refreshes the invalidated area of the view.

    (const Rect &invalidatedArea)

    void 

    Refreshes a view in a specified invalidated area.

    (const LongPressEvent &event)

    virtual bool 

    Called when the view is long pressed.

    (const DragEvent &event)

    virtual bool 

    Called when the view starts to drag.

    (const DragEvent &event)

    virtual bool 

    Called when the view is being dragged.

    (const DragEvent &event)

    virtual bool 

    Called when the view stops dragging.

    (const ClickEvent &event)

    virtual void 

    Called when the view is clicked.

    (const PressEvent &event)

    virtual void 

    Called when the view is pressed.

    (const ReleaseEvent &event)

    virtual void 

    Called when the view is released.

    (const CancelEvent &event)

    virtual void 

    Called when a click event on the view is canceled.

    (OnDragListener onDragListener)

    void 

    Sets a drag event listener for the view.

    ()

    OnDragListener

    Obtains the drag event listener for the view.

    (OnClickListener onClickListener)

    void 

    Sets a click event listener for the view.

    ()

    OnClickListener

    Obtains the click event listener for the view.

    (OnLongPressListener onLongPressListener)

    void 

    Sets a long-press event listener for the view.

    ()

    OnLongPressListener

    Obtains the long-press event listener for the view.

    (OnTouchListener onTouchListener)

    void 

    Sets a touch event listener for the view.

    ()

    OnTouchListener

    Obtains the touch event listener for the view.

    (const Point &point, *last)

    virtual void 

    Obtains the top-level view based on specified coordinates.

    SetParent ( parent)

    void 

    Sets the parent view for the view.

    GetParent () const

     

    Obtains the parent view of the view.

    SetNextSibling ( sibling)

    void 

    Sets the next sibling view for the view.

    GetNextSibling () const

     

    Obtains the next sibling view of the view.

    SetVisible (bool visible)

    virtual void 

    Sets whether the view is visible.

    () const

    bool 

    Checks whether the view is visible.

    SetTouchable (bool touch)

    void 

    Sets whether the view is touchable.

    () const

    bool 

    Checks whether the view is touchable.

    SetDraggable (bool draggable)

    void 

    Sets whether the view is draggable.

    () const

    bool 

    Checks whether the view is draggable.

    SetDragParentInstead (bool dragParentInstead)

    void 

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

    () const

    bool 

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

    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.

    GetVisibleRect () const

     

    Obtains the visible absolute rectangle area of the view.

    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.

    GetOrigRect () const

     

    Obtains the absolute rectangle area of the view.

    GetContentRect ()

    virtual  

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

    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.

    void 

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

    Resize (int16_t width, int16_t height)

    virtual void 

    Adjusts the size of the view.

    (int16_t x)

    virtual void 

    Sets the x-coordinate for the view.

    GetX () const

    int16_t 

    Obtains the x-coordinate for the view.

    (int16_t y)

    virtual void 

    Sets the y-coordinate for the view.

    GetY () const

    int16_t 

    Obtains the y-coordinate for the view.

    (int16_t x, int16_t y)

    virtual void 

    Sets the position for the view.

    SetPosition (int16_t x, int16_t y, int16_t width, int16_t height)

    virtual void 

    Adjusts the position and size of the view.

    () const

    bool 

    Checks whether the view is a container view.

    SetIntercept (bool isIntercept)

    void 

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

    (const TransformMap &transMap)

    void 

    Sets the affine transformation matrix.

    ()

    TransformMap

    Obtains an affine transformation matrix.

    (const char id) const

    virtual UIView  

    Obtains the child view of a specified ID.

    (const char id)

    void 

    Sets the view ID.

    GetViewId () const

    const char  

    Obtains the view ID.

    (int16_t index)

    void 

    Sets the view index.

    () const

    int16_t 

    Obtains the view index.

    LayoutChildren (bool neeInvalidate=false)

    virtual void 

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

    (int16_t xOffSet=0, int16_t yOffset=0)

    void 

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

    LayoutLeftOfParent (int16_t offset=0)

    void 

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

    (int16_t offset=0)

    void 

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

    LayoutTopOfParent (int16_t offset=0)

    void 

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

    (int16_t offset=0)

    void 

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

    AlignLeftToSibling (const char id, int16_t offset=0)

    void 

    Aligns the view with the left of a sibling view.

    (const char id, int16_t offset=0)

    void 

    Aligns the view with the right of a sibling view.

    AlignTopToSibling (const char id, int16_t offset=0)

    void 

    Aligns the view with the top of a sibling view.

    (const char id, int16_t offset=0)

    void 

    Aligns the view with the bottom of a sibling view.

    AlignHorCenterToSibling (const char id, int16_t offset=0)

    void 

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

    (const char id, int16_t offset=0)

    void 

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

    LayoutLeftToSibling (const char id, int16_t offset=0)

    void 

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

    (const char id, int16_t offset=0)

    void 

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

    LayoutTopToSibling (const char id, int16_t offset=0)

    void 

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

    (const char id, int16_t offset=0)

    void 

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

    SetStyle ( &style)

    virtual void 

    Sets the view style.

    SetStyle (uint8_t key, int64_t value)

    virtual void 

    Sets a style.

    (uint8_t key) const

    virtual int64_t 

    Obtains the value of a style.

    GetStyleConst () const

    const & 

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

    operator new (size_t size)

    void  

    Overrides the new function.

    (void *p)

    void