ToggleButton
A ToggleButton is a Button specialization that swaps the two bitmaps when clicked, such that the previous "pressed" bitmap, now becomes the one displayed when button is not pressed. This can by used to give the effect of a button that can be pressed in and when it is subsequently pressed, it will pop back out.
Inherits from: Button, AbstractButton, Widget, Drawable
Public Functions
| void | forceState(bool activeState) |
| Allows the ToggleButton to be forced into either the pressed state, or the normal state. | |
| bool | getState() const |
| Gets the state of the ToggleButton as set with forceState. | |
| virtual void | handleClickEvent(const ClickEvent & event) |
| Updates the current state of the button. | |
| virtual void | setBitmaps(const Bitmap & bitmapReleased, const Bitmap & bitmapPressed) |
| Sets the two bitmaps used by this button. | |
Protected Attributes
| Bitmap | originalPressed |
| Contains the bitmap that was originally being displayed when button is pressed. | |
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). | |
| void | setAlpha(uint8_t newAlpha) |
| Sets the opacity (alpha value). | |
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 x, int16_t y, 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
| 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. | |
| 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 | handleTickEvent() |
| Called periodically by the framework if the Drawable instance has subscribed to timer ticks. | |
| virtual void | invalidate() const |
| Tell the framework that this entire 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 & rect) |
| 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
forceState
| void forceState | ( | bool | activeState | ) | |
Allows the ToggleButton to be forced into either the pressed state, or the normal state.
In the pressed state, the Button will always be shown as pressed down (and shown as released when the user presses it). In the normal state, the Button will be show as released or pressed depending on its actual state.
| activeState | If true, swap the images for released and pressed. If false display the Button normally. |
getState
| bool getState | ( | ) | const |
Gets the state of the ToggleButton as set with forceState.
True if the button has been toggled, i.e. the pressed state is shown when the button is not pressed.
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.
| event | Information about the click. |
Reimplements: touchgfx::AbstractButton::handleClickEvent
setBitmaps
| virtual void setBitmaps | ( | const Bitmap & | bitmapReleased , | ||
| const Bitmap & | bitmapPressed | ||||
| ) |
Sets the two bitmaps used by this button.
One bitmap for the released (normal) state and one bitmap for the pressed state. The images are expected to be of the same dimensions, and the Button is resized to the dimensions of the pressed Bitmap.
| bitmapReleased | Bitmap to use when button is released. |
| bitmapPressed | Bitmap to use when button is pressed. |
Note
It is assumed that the dimensions of the bitmaps are the same. Unexpected (visual) behavior may be observed if the bitmaps are of different sizes. The user code must call invalidate() in order to update the button on the display.
Reimplements: touchgfx::Button::setBitmaps
Protected Attributes Documentation
originalPressed
Bitmap originalPressed
Contains the bitmap that was originally being displayed when button is pressed.