Button State for a button that uses imagery as its button graphics. More...

#include <ButtonState.h>

Inheritance diagram for ImageButtonState:

Public Member Functions
	ImageButtonState (Canvas &destCanvas, const Block_Image &destLoc, buttonCallbackFunction callback, ROM_Image buttonImage, uint16_t buttonGfxColor16, unsigned short cornerRadius, uint8_t borderWidth, uint16_t borderColor16, uint16_t fillColor16)
	Constructs a new Image Button State object.

	~ImageButtonState (void)=default
	Destroys the Image Button State object.

void	begin (void) override
	Initializes the button state object. This method should be called before first use of the object.

Public Member Functions inherited from ButtonState
	ButtonState (Canvas &destCanvas, uint16_t x, uint16_t y, uint16_t width, uint16_t height, buttonCallbackFunction callback, unsigned short cornerRadius, uint8_t borderWidth, uint16_t borderColor, uint16_t fillColor16)
	Construct a new Button State object.

virtual	~ButtonState ()=default
	Default destructor.

virtual void	updateBackground (void)
	Update the button background graphics.

virtual void	draw (void)
	Draw the button assuming images have transparent background.

virtual void	drawOpaque (void)
	Draw the button assuming images have an opaque background.

virtual void	draw (Canvas &newCanvas, bool TransparentOn=true)
	Draw the button onto the specified canvas at the specified location.

void	callback (void) const
	Calls the callback function associated with this button state.

uint16_t	width (void) const
	Returns the width of the button state.

uint16_t	height (void) const
	Returns the height of the button state.

uint16_t	x (void) const
	Returns the X location of the button state on the destination canvas.

uint16_t	y (void) const
	Returns the Y location of the button state on the destination canvas.

Additional Inherited Members
Public Types inherited from ButtonState
typedef void(*	buttonCallbackFunction) (void)
	Defines the form of the callback functions expected by the Button class.

Protected Attributes inherited from ButtonState
Canvas *	_ButtonGfxCanvas = nullptr
	Canvas that holds the colorized button graphics. Derived classes will define this canvas as appropriate.

Detailed Description

Button State for a button that uses imagery as its button graphics.

Constructor & Destructor Documentation

◆ ImageButtonState()

ImageButtonState::ImageButtonState	(	Canvas &	destCanvas,
		const Block_Image &	destLoc,
		buttonCallbackFunction	callback,
		ROM_Image	buttonImage,
		uint16_t	buttonGfxColor16,
		unsigned short	cornerRadius,
		uint8_t	borderWidth,
		uint16_t	borderColor16,
		uint16_t	fillColor16 )

inline

Constructs a new Image Button State object.

Parameters

destCanvas	[in] Canvas where the final button will be drawn
destLoc	[in] X-Y location and size of the button within the destination canvas
callback	[in] Callback function associated with this button state
buttonImage	[in] Image in Flash ROM containing the button graphics
buttonGfxColor16	[in] 16-bit RGB color to use for the button graphics foreground color
cornerRadius	[in] Corner radius for the button
borderWidth	[in] Border width in pixels of the button border
borderColor16	[in] Border color in 16-bit RGB format
fillColor16	[in] Fill color in 16-bit RGB format

◆ ~ImageButtonState()

ImageButtonState::~ImageButtonState ( void )

default

Destroys the Image Button State object.

Parameters: None.

Member Function Documentation

◆ begin()

void ImageButtonState::begin ( void )

overridevirtual

Initializes the button state object. This method should be called before first use of the object.

Parameters: None.

Reimplemented from ButtonState.

The documentation for this class was generated from the following files:

C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Display/ButtonState.h
C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Display/ButtonState.cpp