# OHOS::UILabelButton - [Overview](#section1326413647165634) - [Summary](#section665276057165634) - [Public Member Functions](#pub-methods) - [Additional Inherited Members](#inherited) ## **Overview** **Related Modules:** [Graphic](Graphic.md) **Description:** Provides the functions related to a label button. **Since:** 1.0 **Version:** 1.0 ## **Summary** ## Public Member Functions

Function

Description

UILabelButton ()

A constructor used to create a UILabelButton instance.

~UILabelButton ()

virtual

A destructor used to delete the UILabelButton instance.

OnDraw (const Rect &invalidatedArea) override

void

Draws a label button.

GetViewType () const override

UIViewType

Obtains the view type.

SetText (const char *text)

void

Sets the text for this label button.

GetText () const

const char *

Obtains the text of this label button.

SetLablePosition (int16_t x, int16_t y)

void

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

GetLabelPosition () const

Point

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

SetAlign (UITextLanguageAlignment align)

void

Sets the alignment mode for this text.

GetAlign () const

UITextLanguageAlignment

Obtains the alignment mode of this text.

SetDirect (UITextLanguageDirect direct)

void

Sets the direction for this text.

GetDirect () const

UITextLanguageDirect

Obtains the direction of this text.

SetLabelStyle (Style &labelStyle)

void

Sets the style for this label.

SetLabelStyle (uint8_t key, int64_t value)

void

Sets a style for this label.

GetLabelStyle () const

const Style &

Obtains the style of this label.

GetLabelStyle (uint8_t key) const

int64_t

Obtains the value of a style of this label.

SetTextColor (ColorType color)

void

Sets the color for this text.

SetFont (const char *name, uint8_t size)

void

Sets the font for this text.

SetFontId (uint8_t fontId)

void

Sets the font ID.

GetFontId () const

uint8_t

Obtains the font ID.

UIButton ()

A constructor used to create a UIButton instance.

UIButton (const char *id)

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

~UIButton ()

virtual

A destructor used to delete the UIButton instance.

OnPreDraw (const Rect &invalidatedArea) override

bool

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

OnPressEvent (const PressEvent &event) override

void

Executes the press event action.

OnReleaseEvent (const ReleaseEvent &event) override

void

Executes the press release event action.

OnCancelEvent (const CancelEvent &event) override

void

Executes the cancel event action.

SetImageSrc (const char *defaultImgSrc, const char *triggeredImgSrc)

void

Sets the image for this button.

SetImageSrc (const ImageInfo *defaultImgSrc, const ImageInfo *triggeredImgSrc)

void

Sets the image for this button.

SetImagePosition (const int16_t x, const int16_t y)

void

Sets the position for this image.

GetImageX () const

int16_t

Obtains the x-coordinate of this image.

GetImageY () const

int16_t

Obtains the y-coordinate of this image.

GetCurImageSrc () const

const Image *

Obtains the image for the current button state.

GetWidth () override

int16_t

Obtains the width of this image.

GetHeight () override

int16_t

Obtains the height of this image.

SetWidth (int16_t width) override

void

Sets the width for this image.

SetHeight (int16_t height) override

void

Sets the height for this image.

GetContentRect () override

virtual Rect

Obtains a rectangular area that contains coordinate information.

GetStyle (uint8_t key) const override

int64_t

Obtains the value of a style.

SetStyle (uint8_t key, int64_t value) override

void

Sets a style.

GetStyleForState (uint8_t key, ButtonState state) const

int64_t

Obtains the style of a button in a specific state.

SetStyleForState (uint8_t key, int64_t value, ButtonState state)

void

Sets the style for a button in a specific state.

Disable ()

void

Disables this button.

Enable ()

void

Enables this button.

SetStateForStyle (ButtonState state)

void

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

UIView ()

A default constructor used to create an UIView instance.

UIView (const char *id)

A constructor used to create an UIView instance.

~UIView ()

virtual

A destructor used to delete the UIView instance.

OnPostDraw (const Rect &invalidatedArea)

virtual void

Called after a view is drawn.

ReMeasure ()

virtual void

Remeasures the view size.

Invalidate ()

void

Refreshes the invalidated area of the view.

InvalidateRect (const Rect &invalidatedArea)

void

Refreshes a view in a specified invalidated area.

OnLongPressEvent (const LongPressEvent &event)

virtual bool

Called when the view is long pressed.

OnDragStartEvent (const DragEvent &event)

virtual bool

Called when the view starts to drag.

OnDragEvent (const DragEvent &event)

virtual bool

Called when the view is being dragged.

OnDragEndEvent (const DragEvent &event)

virtual bool

Called when the view stops dragging.

OnClickEvent (const ClickEvent &event)

virtual void

Called when the view is clicked.

SetOnDragListener (OnDragListener *onDragListener)

void

Sets a drag event listener for the view.

GetOnDragListener ()

OnDragListener *&

Obtains the drag event listener for the view.

SetOnClickListener (OnClickListener *onClickListener)

void

Sets a click event listener for the view.

GetOnClickListener ()

OnClickListener *&

Obtains the click event listener for the view.

SetOnLongPressListener (OnLongPressListener *onLongPressListener)

void

Sets a long-press event listener for the view.

GetOnLongPressListener ()

OnLongPressListener *&

Obtains the long-press event listener for the view.

SetOnTouchListener (OnTouchListener *onTouchListener)

void

Sets a touch event listener for the view.

GetTouchListener ()

OnTouchListener *&

Obtains the touch event listener for the view.

GetTargetView (const Point &point, UIView **last)

virtual void

Obtains the top-level view based on specified coordinates.

SetParent (UIView *parent)

void

Sets the parent view for the view.

GetParent () const

UIView *

Obtains the parent view of the view.

SetNextSibling (UIView *sibling)

void

Sets the next sibling view for the view.

GetNextSibling () const

UIView *

Obtains the next sibling view of the view.

SetVisible (bool visible)

virtual void

Sets whether the view is visible.

IsVisible () const

bool

Checks whether the view is visible.

SetTouchable (bool touch)

void

Sets whether the view is touchable.

IsTouchable () const

bool

Checks whether the view is touchable.

SetDraggable (bool draggable)

void

Sets whether the view is draggable.

IsDraggable () 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.

IsDragParentInstead () const

bool

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

GetRect () const

Rect

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

GetVisibleRect () const

Rect

Obtains the visible absolute rectangle area of the view.

GetMaskedRect () const

Rect

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

GetOrigRect () const

Rect

Obtains the absolute rectangle area of the view.

GetRelativeRect () const

Rect

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

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

void

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

Resize (int16_t width, int16_t height)

virtual void

Adjusts the size of the view.

SetX (int16_t x)

virtual void

Sets the x-coordinate for the view.

GetX () const

int16_t

Obtains the x-coordinate for the view.

SetY (int16_t y)

virtual void

Sets the y-coordinate for the view.

GetY () const

int16_t

Obtains the y-coordinate for the view.

SetPosition (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.

IsViewGroup () 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.

SetTransformMap (const TransformMap &transMap)

void

Sets the affine transformation matrix.

GetTransformMap ()

TransformMap &

Obtains an affine transformation matrix.

GetChildById (const char *id) const

virtual UIView *

Obtains the child view of a specified ID.

SetViewId (const char *id)

void

Sets the view ID.

GetViewId () const

const char *

Obtains the view ID.

SetViewIndex (int16_t index)

void

Sets the view index.

GetViewIndex () const

int16_t

Obtains the view index.

LayoutChildren (bool neeInvalidate=false)

virtual void

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

LayoutCenterOfParent (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.

LayoutRightOfParent (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.

LayoutBottomOfParent (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.

AlignRightToSibling (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.

AlignBottomToSibling (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.

AlignVerCenterToSibling (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.

LayoutRightToSibling (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.

LayoutBottomToSibling (const char *id, int16_t offset=0)

void

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

SetStyle (Style &style)

void

Sets the view style.

GetStyleConst () const

const Style &

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

operator new (size_t size)

void *

Overrides the new function.

operator delete (void *p)

void

Overrides the delete function.

## Additional Inherited Members

Additional Inherited Member Name

Description

ButtonImageSrc : uint8_t

Enumerates the images for different button states.

ButtonState : uint8_t

Enumerates the states of this button.