주요 내용으로 건너뛰기

AbstractButton

touchgfx/widgets/AbstractButton.hpp

This class defines an abstract interface for button-like elements. A button is a clickable element that has two states: pressed and released. A button also has an action that is executed when the button goes from state pressed to state released.

Inherits from: Widget, Drawable

Inherited by: Button, RadioButton, TouchArea

Public Functions

AbstractButton()
Sets this Widget touchable so the user can interact with buttons.
virtual voidexecuteAction()
Executes the previously set action.
virtual boolgetPressedState() const
Function to determine if the AbstractButton is currently pressed.
virtual voidhandleClickEvent(const ClickEvent & event)
Updates the current state of the button.
voidsetAction(GenericCallback< const AbstractButton & > & callback)
Associates an action with the button.

Protected Attributes

GenericCallback< const AbstractButton & > *action
The callback to be executed when this AbstractButton is clicked.
boolpressed
Is the button pressed or released? True if pressed.

Additional inherited members

Public Functions inherited from Widget

virtual voidgetLastChild(int16_t , int16_t , Drawable ** last)
Since a Widget is only one Drawable, Widget::getLastChild simply yields itself as result, but only if the Widget isVisible and isTouchable.

Public Functions inherited from Drawable

voidcenter()
Centers the Drawable inside its parent.
voidcenterX()
Center the Drawable horizontally inside its parent.
voidcenterY()
Center the Drawable vertically inside its parent.
virtual voidchildGeometryChanged()
This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.
virtual voiddraw(const Rect & invalidatedArea) const =0
Draw this drawable.
Drawable()
Initializes a new instance of the Drawable class.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
voidexpand(int margin =0)
Expands the Drawable to have the same size as its parent with a given margin around the edge.
RectgetAbsoluteRect() const
Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.
virtual Drawable *getFirstChild()
Function for obtaining the first child of this drawable if any.
int16_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last) =0
Function for obtaining the the last child of this drawable that intersects with the specified point.
Drawable *getNextSibling()
Gets the next sibling node.
Drawable *getParent() const
Returns the parent node.
const Rect &getRect() const
Gets the rectangle this Drawable covers, in coordinates relative to its parent.
virtual RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & event)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & other)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(Rect & r) const
Helper function for converting a region of this Drawable to absolute coordinates.
virtual ~Drawable()
Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable

Drawable *nextSibling
Pointer to the next Drawable.
Drawable *parent
Pointer to this drawable's parent.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Public Functions Documentation

AbstractButton

Sets this Widget touchable so the user can interact with buttons.

executeAction

virtual void executeAction()

Executes the previously set action.

See also:

getPressedState

virtual bool getPressedState()const

Function to determine if the AbstractButton is currently pressed.

Returns:

true if button is pressed, false otherwise.

handleClickEvent

virtual void handleClickEvent(const ClickEvent &event)

Updates the current state of the button.

The state can be either pressed or released, and if the new state is different from the current state, the button is also invalidated to force a redraw.

If the button state is changed from ClickEvent::PRESSED to ClickEvent::RELEASED, the associated action (if any) is also executed.

Parameters:
eventInformation about the click.

Reimplements: touchgfx::Drawable::handleClickEvent

Reimplemented by: touchgfx::RadioButton::handleClickEvent, touchgfx::RepeatButton::handleClickEvent, touchgfx::ToggleButton::handleClickEvent, touchgfx::TouchArea::handleClickEvent

setAction

void setAction(GenericCallback< const AbstractButton & > &callback)

Associates an action with the button.

The action is performed when the AbstractButton is in the pressed state, goes to the released.

Parameters:
callbackThe callback to be executed. The callback will be executed with a reference to the AbstractButton.
See also:

Protected Attributes Documentation

action

GenericCallback< const AbstractButton & > * action

The callback to be executed when this AbstractButton is clicked.

pressed

bool pressed

Is the button pressed or released? True if pressed.