ButtonWithIcon

A Button that has a bitmap with an icon on top of it. It is possible to have two different icons depending on the current state of the button (released or pressed).

Typical use case could be a blue button with a released and a pressed image. Those images can be reused across several buttons. The ButtonWithIcon will then allow an image to superimposed on top of the blue button.

Inherits from: Button, AbstractButton, Widget, Drawable

Public Functions

	ButtonWithIcon()
virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
Bitmap	getCurrentlyDisplayedIcon() const
	Gets currently displayed icon.
int16_t	getIconX() const
	Gets the x coordinate of the icon bitmap.
int16_t	getIconY() const
	Gets the y coordinate of the icon bitmap.
virtual void	setBitmaps(const Bitmap & newBackgroundReleased, const Bitmap & newBackgroundPressed, const Bitmap & newIconReleased, const Bitmap & newIconPressed)
	Sets the four bitmaps used by this button.
void	setIconX(int16_t x)
	Sets the x coordinate of the icon bitmaps.
void	setIconXY(int16_t x, int16_t y)
	Sets the x and y coordinates of the icon bitmap.
void	setIconY(int16_t y)
	Sets the y coordinate of the icon bitmaps.

Protected Attributes

Bitmap	iconPressed
	Icon to display when button is pressed.
Bitmap	iconReleased
	Icon to display when button is not pressed.
int16_t	iconX
	x coordinate offset for icon.
int16_t	iconY
	y coordinate offset for icon.

Additional inherited members

Public Functions inherited from Button

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

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.
virtual void	handleClickEvent(const ClickEvent & event)
	Updates the current state of the button.
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.
	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	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
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	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

ButtonWithIcon

ButtonWithIcon	(			)

draw

virtual void draw	(	const Rect &	invalidatedArea	)

Draw this drawable.

It is a requirement that the draw implementation does not draw outside the region specified by invalidatedArea.

Parameters:

invalidatedArea	The sub-region of this drawable that needs to be redrawn, expressed in coordinates relative to its parent (e.g. for a complete redraw, invalidatedArea will be (0, 0, width, height).

Reimplements: touchgfx::Button::draw

getCurrentlyDisplayedIcon

Bitmap getCurrentlyDisplayedIcon	(			)	const

Gets currently displayed icon.

This depends on the current state of the button, released (normal) or pressed.

Returns:

The icon currently displayed.

getIconX

int16_t getIconX	(			)	const

Gets the x coordinate of the icon bitmap.

Returns:

The x coordinate of the icon bitmap.

getIconY

int16_t getIconY	(			)	const

Gets the y coordinate of the icon bitmap.

Returns:

The y coordinate of the icon bitmap.

setBitmaps

virtual void setBitmaps	(	const Bitmap &	newBackgroundReleased ,
		const Bitmap &	newBackgroundPressed ,
		const Bitmap &	newIconReleased ,
		const Bitmap &	newIconPressed
		)

Sets the four bitmaps used by this button.

The last two bitmaps are drawn on top of the first two, again depending on the current state of the Button. This means that when the button state is released (normal), the newIconReleased is drawn on top of the newBackgroundReleased, and when the button state is pressed, the newIconPressed is drawn on top of the newBackgroundPressed.

The default position if the icons is set to the center of the bitmaps. The two icons are assumed to have the same dimensions. The size of the released icon is used to position the icons centered on the Button.

Parameters:

newBackgroundReleased	Bitmap to use when button is released.
newBackgroundPressed	Bitmap to use when button is pressed.
newIconReleased	The bitmap for the icon in the released (normal) button state.
newIconPressed	The bitmap for the icon in the pressed button state.

Note

The user code must call invalidate() in order to update the button on the display.

setIconX

void setIconX	(	int16_t	x	)

Sets the x coordinate of the icon bitmaps.

The same x coordinate is used for both icons (released and pressed).

Parameters:

x	The new x value, relative to the background bitmap. A negative value is allowed.

Note

The user code must call invalidate() in order to update the button on the display. The value set is overwritten on a subsequent call to setBitmaps.

setIconXY

void setIconXY	(	int16_t	x ,
		int16_t	y
		)

Sets the x and y coordinates of the icon bitmap.

Same as calling setIconX and setIconY.

Parameters:

x	The new x value, relative to the background bitmap. A negative value is allowed.
y	The new y value, relative to the background bitmap. A negative value is allowed.

Note

The user code must call invalidate() in order to update the button on the display. The values set are overwritten on a subsequent call to setBitmaps.

setIconY

void setIconY	(	int16_t	y	)

Sets the y coordinate of the icon bitmaps.

The same y coordinate is used for both icons (released and pressed).

Parameters:

y	The new y value, relative to the background bitmap. A negative value is allowed.

Note

The user code must call invalidate() in order to update the button on the display. The value set is overwritten on a subsequent call to setBitmaps.

Protected Attributes Documentation

iconPressed

Bitmap iconPressed

Icon to display when button is pressed.

iconReleased

Bitmap iconReleased

Icon to display when button is not pressed.

iconX

int16_t iconX

x coordinate offset for icon.

iconY

int16_t iconY

y coordinate offset for icon.