RepeatButton
touchgfx/widgets/RepeatButton.hpp
A RepeatButton is similar to a regular Button, but it will 'repeat' if pressed for a long period of time. The RepeatButton differs from a regular Button with regards to activation. A Button is activated when the button is released, whereas a RepeatButton is activated immediately when pressed and then at regular intervals. A RepeatButton does not activate when released.
As for other well-known repeat buttons, the interval from the first activation until the second activation as well as the subsequent interval between activations can be set for the RepeatButton.
The default values for initial delay is 10 ticks, and the default value for the following delays between button activations is 5 ticks.
Inherits from: Button, AbstractButton, Widget, Drawable
Public Functions
| virtual int | getDelay() |
| Gets the delay in ticks from first button activation until next activation. | |
| virtual int | getInterval() |
| The interval between repeated activations, measured in ticks. | |
| virtual void | handleClickEvent(const ClickEvent & event) |
| Updates the current state of the button. | |
| virtual void | handleTickEvent() |
| Called periodically by the framework if the Drawable instance has subscribed to timer ticks. | |
| RepeatButton() | |
| virtual void | setDelay(int delay) |
| Sets the delay (in number of ticks) from the first button activation until the next time it will be automatically activated. | |
| virtual void | setInterval(int interval) |
| Sets the interval in number of ticks between each each activation of the pressed button after the second activation. | |
Additional inherited members
Public Functions inherited from Button
| Button() | |
| virtual void | draw(const Rect & invalidatedArea) const |
| Draw this drawable. | |
| uint8_t | getAlpha() const |
| Gets the current alpha value of the widget. | |
| Bitmap | getCurrentlyDisplayedBitmap() const |
| Gets currently displayed bitmap. | |
| virtual Rect | getSolidRect() const |
| Get (the largest possible) rectangle that is guaranteed to be solid (opaque). | |
| virtual void | invalidateContent() const |
| Tell the framework that the contents of the Drawable needs to be redrawn. | |
| void | setAlpha(uint8_t newAlpha) |
| Sets the opacity (alpha value). | |
| virtual void | setBitmaps(const Bitmap & bitmapReleased, const Bitmap & bitmapPressed) |
| Sets the two bitmaps used by this button. | |
Protected Attributes inherited from Button
| uint8_t | alpha |
| The current alpha value. 255=solid, 0=invisible. | |
| Bitmap | down |
| The image to display when button is pressed. | |
| Bitmap | up |
| The image to display when button is released (normal state). | |
Public Functions inherited from AbstractButton
| AbstractButton() | |
| Sets this Widget touchable so the user can interact with buttons. | |
| virtual void | executeAction() |
| Executes the previously set action. | |
| virtual bool | getPressedState() const |
| Function to determine if the AbstractButton is currently pressed. | |
| void | setAction(GenericCallback< const AbstractButton & > & callback) |
| Associates an action with the button. | |
Protected Attributes inherited from AbstractButton
| GenericCallback< const AbstractButton & > * | action |
| The callback to be executed when this AbstractButton is clicked. | |
| bool | pressed |
| Is the button pressed or released? True if pressed. | |
Public Functions inherited from Widget
| virtual void | getLastChild(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
| void | center() |
| Centers the Drawable inside its parent. | |
| void | centerX() |
| Center the Drawable horizontally inside its parent. | |
| void | centerY() |
| Center the Drawable vertically inside its parent. | |
| virtual void | childGeometryChanged() |
| 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 void | draw(const Rect & invalidatedArea) const =0 |
| Draw this drawable. | |
| Drawable() | |
| Initializes a new instance of the Drawable class. | |
| void | drawToDynamicBitmap(BitmapId id) |
| Render the Drawable object into a dynamic bitmap. | |
| void | expand(int margin =0) |
| Expands the Drawable to have the same size as its parent with a given margin around the edge. | |
| Rect | getAbsoluteRect() 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_t | getHeight() const |
| Gets the height of this Drawable. | |
| virtual void | getLastChild(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 Rect | getSolidRect() const =0 |
| Get (the largest possible) rectangle that is guaranteed to be solid (opaque). | |
| virtual Rect | getSolidRectAbsolute() |
| Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates. | |
| virtual void | getVisibleRect(Rect & rect) const |
| Function for finding the visible part of this drawable. | |
| int16_t | getWidth() const |
| Gets the width of this Drawable. | |
| int16_t | getX() const |
| Gets the x coordinate of this Drawable, relative to its parent. | |
| int16_t | getY() const |
| Gets the y coordinate of this Drawable, relative to its parent. | |
| virtual void | handleDragEvent(const DragEvent & event) |
| Defines the event handler interface for DragEvents. | |
| virtual void | handleGestureEvent(const GestureEvent & event) |
| Defines the event handler interface for GestureEvents. | |
| virtual void | invalidate() const |
| Tell the framework that this entire Drawable needs to be redrawn. | |
| virtual void | invalidateContent() const |
| Tell the framework that the contents of the Drawable needs to be redrawn. | |
| virtual void | invalidateRect(Rect & invalidatedArea) const |
| Request that a region of this drawable is redrawn. | |
| bool | isTouchable() const |
| Gets whether this Drawable receives touch events or not. | |
| bool | isVisible() const |
| Gets whether this Drawable is visible. | |
| virtual void | moveRelative(int16_t x, int16_t y) |
| Moves the drawable. | |
| virtual void | moveTo(int16_t x, int16_t y) |
| Moves the drawable. | |
| virtual void | setHeight(int16_t height) |
| Sets the height of this drawable. | |
| void | setPosition(const Drawable & drawable) |
| Sets the position of the Drawable to the same as the given Drawable. | |
| void | setPosition(int16_t x, int16_t y, int16_t width, int16_t height) |
| Sets the size and position of this Drawable, relative to its parent. | |
| void | setTouchable(bool touch) |
| Controls whether this Drawable receives touch events or not. | |
| void | setVisible(bool vis) |
| Controls whether this Drawable should be visible. | |
| virtual void | setWidth(int16_t width) |
| Sets the width of this drawable. | |
| void | setWidthHeight(const Bitmap & bitmap) |
| Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates). | |
| void | setWidthHeight(const Drawable & drawable) |
| Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates). | |
| void | setWidthHeight(const Rect & other) |
| Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates). | |
| void | setWidthHeight(int16_t width, int16_t height) |
| Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates). | |
| virtual void | setX(int16_t x) |
| Sets the x coordinate of this Drawable, relative to its parent. | |
| void | setXY(const Drawable & drawable) |
| Sets the x and y coordinates of this Drawable. | |
| void | setXY(int16_t x, int16_t y) |
| Sets the x and y coordinates of this Drawable, relative to its parent. | |
| virtual void | setY(int16_t y) |
| Sets the y coordinate of this Drawable, relative to its parent. | |
| virtual void | translateRectToAbsolute(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. | |
| Rect | rect |
| The coordinates of this Drawable, relative to its parent. | |
| bool | touchable |
| True if this drawable should receive touch events. | |
| bool | visible |
| True if this drawable should be drawn. | |
Public Functions Documentation
getDelay
| virtual int getDelay | ( | ) |
Gets the delay in ticks from first button activation until next activation.
Returns:
The delay, measured in ticks, between first activation and second activation.
See also:
getInterval
| virtual int getInterval | ( | ) |
The interval between repeated activations, measured in ticks.
This is the number of ticks between the an activation beyond the first and the following activation.
Returns:
The interval between repeated activations, measured in ticks.
See also:
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:
| event | Information about the click. |
Reimplements: touchgfx::AbstractButton::handleClickEvent
handleTickEvent
| virtual void handleTickEvent | ( | ) |
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
See also:
Reimplements: touchgfx::Drawable::handleTickEvent
RepeatButton
setDelay
| virtual void setDelay | ( | int | delay | ) | |
Sets the delay (in number of ticks) from the first button activation until the next time it will be automatically activated.
Parameters:
| delay | The delay, measured in ticks, between first activation and second activation. |
See also:
setInterval
| virtual void setInterval | ( | int | interval | ) | |
Sets the interval in number of ticks between each each activation of the pressed button after the second activation.
Parameters:
| interval | The interval between repeated activations, measured in ticks. |
See also: