OHOS::UIButton
Overview
Related Modules:
Description:
Represents a button.
This component responds to the press and release events.
Since:
1.0
Version:
1.0
Summary
Public Types
ButtonImageSrc : uint8_t |
|
ButtonState : uint8_t |
Public Member Functions
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 () |
A destructor used to delete the UIButton instance. |
GetViewType () const 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. |
|
OnPressEvent (const PressEvent &event) override |
|
OnReleaseEvent (const ReleaseEvent &event) override |
|
OnCancelEvent (const CancelEvent &event) override |
|
SetImageSrc (const char defaultImgSrc, const char triggeredImgSrc) |
|
SetImageSrc (const ImageInfo defaultImgSrc, const ImageInfo triggeredImgSrc) |
|
SetImagePosition (const int16_t x, const int16_t y) |
|
GetImageX () const |
|
GetImageY () const |
|
GetCurImageSrc () const |
const Image |
GetWidth () override |
|
GetHeight () override |
|
SetWidth (int16_t width) override |
|
SetHeight (int16_t height) override |
|
GetContentRect () override |
virtual Rect Obtains a rectangular area that contains coordinate information. |
GetStyle (uint8_t key) const override |
|
SetStyle (uint8_t key, int64_t value) override |
|
GetStyleForState (uint8_t key, ButtonState state) const |
|
SetStyleForState (uint8_t key, int64_t value, ButtonState state) |
|
Disable () |
|
Enable () |
|
SetStateForStyle (ButtonState state) |
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 () |
A destructor used to delete the UIView instance. |
OnPostDraw (const Rect &invalidatedArea) |
|
ReMeasure () |
|
Invalidate () |
|
InvalidateRect (const Rect &invalidatedArea) |
|
OnLongPressEvent (const LongPressEvent &event) |
|
OnDragStartEvent (const DragEvent &event) |
|
OnDragEvent (const DragEvent &event) |
|
OnDragEndEvent (const DragEvent &event) |
|
OnClickEvent (const ClickEvent &event) |
|
SetOnDragListener (OnDragListener onDragListener) |
|
SetOnClickListener (OnClickListener onClickListener) |
|
SetOnLongPressListener (OnLongPressListener onLongPressListener) |
|
SetOnTouchListener (OnTouchListener onTouchListener) |
|
GetTargetView (const Point &point, UIView **last) |
|
GetParent () const |
|
SetNextSibling (UIView sibling) |
|
GetNextSibling () const |
|
SetVisible (bool visible) |
|
IsVisible () const |
|
SetTouchable (bool touch) |
|
IsTouchable () const |
|
SetDraggable (bool draggable) |
|
IsDraggable () const |
|
SetDragParentInstead (bool dragParentInstead) |
Sets whether to transfer the drag event to the parent view for processing when the view is being dragged. |
IsDragParentInstead () const |
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 |
|
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 |
|
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. |
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. |
Resize (int16_t width, int16_t height) |
|
SetX (int16_t x) |
|
GetX () const |
|
SetY (int16_t y) |
|
GetY () const |
|
SetPosition (int16_t x, int16_t y) |
|
SetPosition (int16_t x, int16_t y, int16_t width, int16_t height) |
|
IsViewGroup () const |
|
SetIntercept (bool isIntercept) |
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) |
|
GetChildById (const char id) const |
virtual UIView |
SetViewId (const char id) |
|
GetViewId () const |
|
SetViewIndex (int16_t index) |
|
GetViewIndex () const |
|
LayoutChildren (bool neeInvalidate=false) |
Lays out all child views according to the preset arrangement mode. |
LayoutCenterOfParent (int16_t xOffSet=0, int16_t yOffset=0) |
|
LayoutLeftOfParent (int16_t offset=0) |
|
LayoutRightOfParent (int16_t offset=0) |
|
LayoutTopOfParent (int16_t offset=0) |
|
LayoutBottomOfParent (int16_t offset=0) |
|
AlignLeftToSibling (const char id, int16_t offset=0) |
|
AlignRightToSibling (const char id, int16_t offset=0) |
|
AlignTopToSibling (const char id, int16_t offset=0) |
|
AlignBottomToSibling (const char id, int16_t offset=0) |
|
AlignHorCenterToSibling (const char id, int16_t offset=0) |
Aligns the view with the center of a sibling view in the x-axis. |
AlignVerCenterToSibling (const char id, int16_t offset=0) |
Aligns the view with the center of a sibling view in the y-axis. |
LayoutLeftToSibling (const char id, int16_t offset=0) |
|
LayoutRightToSibling (const char id, int16_t offset=0) |
|
LayoutTopToSibling (const char id, int16_t offset=0) |
|
LayoutBottomToSibling (const char id, int16_t offset=0) |
|
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) |
|
operator delete (void *p) |