ContainerStack Class Reference

class for a container that is showing all items at a time stacked one after another. More...

#include <ContainerStack.h>

Inheritance diagram for ContainerStack:

Public Member Functions
	ContainerStack (StackLayout_t stackLayout=STACK_LAYOUT_VERTICAL_LEFT, uint8_t maxNumItems=DEFAULT_MAX_CONTAINER_ITEMS, uint16_t locX=0, uint16_t locY=0, uint16_t width=0, uint16_t height=0)
	Constructor of the ContainerStack.
virtual void	Draw (bool redraw) override
	Method used for drawing of the ContainerStack.
virtual bool	KeyInput (Keys_t key) override
	Process the given key.
virtual bool	TouchInput (uint16_t x, uint16_t y, TouchTypes touchType) override
	Process a touch input at the given point (x, y)
void	InitItems ()
	This method selects the first UIElement in the container that is of UI_CONTROL type.
virtual void	RecalculateDimensions () override
	Recalculate the Height and Width of the UIElement.
virtual void	RecalculateLayout () override
	Recalculate the UIElement layout (containers update the X- and Y-Location of all their items, all other items can do other layout update stuff)
Public Member Functions inherited from Container
	Container (uint8_t maxNumItems=DEFAULT_MAX_CONTAINER_ITEMS)
	Constructor of the Container.
	~Container ()
	Destructor of the Container.
virtual void	Draw ()
	Virtual method used for drawing of the container UIElement.
UIElement *	GetSelectedItem ()
	Get the selected item.
bool	AddItem (UIElement *item)
	Add a new element to the container and activate it as active child.
void	ClearAllItems ()
	Clear all items in the container.
bool	NextItem ()
	Select the next item in the container.
bool	PreviousItem ()
	Select the previous item in the container.
bool	NextControlItem ()
	Select the next item in the container that is of UI_CONTROL type.
bool	PreviousControlItem ()
	Select the previous item in the container that is of UI_CONTROL type.
void	GetItemsBoundingBox (uint16_t *x, uint16_t *y, uint16_t *w, uint16_t *h)
	Get a bounding box around all items in the Container.
Public Member Functions inherited from UIElement
	UIElement (UIElementType type)
	Constructor of the UIElement.
	UIElement (uint16_t locX, uint16_t locY, UIElementType type)
	Constructor of the UIElement.
bool	HitTest (uint16_t x, uint16_t y)
	Check if the given point (x, y) is inside this UIElement.

Private Attributes
StackLayout_t	_stackLayout
	Stack layout.

Additional Inherited Members
Public Attributes inherited from UIElement
UIElementType	Type
	Element type (control, indicator, container)
uint16_t	LocX
	X Location of the upper left corner of the UIElement.
uint16_t	LocY
	Y Location of the upper left corner of the UIElement.
uint16_t	Width
	Drawing width of the UIElement.
uint16_t	Height
	Drawing height of the UIElement.
bool	Visible
	The UIElement is only drawn if the visibility is set to true.
bool	IsInEditMode
	Is the UIElement in edit mode?
UIElement *	Parent
	Parent UIElement that this UIElement belongs to.
UIElement *	ActiveChild
	Child element that is currently active (receiving all key inputs).
Protected Attributes inherited from Container
uint8_t	_maxNumItems
	Maximum number of items, each container can hold.
UIElement **	_items
	Array holding pointers to all UIElement that are items of the container.
uint8_t	_numItems
	Number of items in the container (number of valid items in the _items array).
uint8_t	_selectedItemIndex
	Index of the selected container item.
Protected Attributes inherited from UIElement
bool	_lastDrawnVisible
	The Visible value that was last drawn.

Detailed Description

class for a container that is showing all items at a time stacked one after another.

Constructor & Destructor Documentation

ContainerStack()

ContainerStack::ContainerStack	(	StackLayout_t	stackLayout = STACK_LAYOUT_VERTICAL_LEFT,
		uint8_t	maxNumItems = DEFAULT_MAX_CONTAINER_ITEMS,
		uint16_t	locX = 0,
		uint16_t	locY = 0,
		uint16_t	width = 0,
		uint16_t	height = 0 )

Constructor of the ContainerStack.

Parameters

stackLayout	Stack layout
maxNumItems	Maximum number of items, each container can hold. Lower this value if you don't need that much items to save memory.
locX	X Location of the upper left corner of the ContainerStack
locY	Y Location of the upper left corner of the ContainerStack
width	Drawing width of the ContainerStack
height	Drawing height of the ContainerStack

Member Function Documentation

Draw()

void ContainerStack::Draw ( bool redraw )

overridevirtual

Method used for drawing of the ContainerStack.

Implements UIElement.

KeyInput()

bool ContainerStack::KeyInput ( Keys_t key )

overridevirtual

Process the given key.

If this element doesn't support the key type, the key is forwarded to the parent. This is done until the key is processed or the root of the visual tree is reached.

Parameters

key	Key that should be processed. Supported keys are: KEYUP, KEYDOWN

Returns

true if the key was processed; false if not.

Reimplemented from Container.

RecalculateDimensions()

void ContainerStack::RecalculateDimensions ( )

overridevirtual

Recalculate the Height and Width of the UIElement.

Implements UIElement.

RecalculateLayout()

void ContainerStack::RecalculateLayout ( )

overridevirtual

Recalculate the UIElement layout (containers update the X- and Y-Location of all their items, all other items can do other layout update stuff)

Reimplemented from UIElement.

TouchInput()

bool ContainerStack::TouchInput ( uint16_t x, uint16_t y, TouchTypes touchType )

overridevirtual

Process a touch input at the given point (x, y)

Parameters

x	X-Coordinate of the touched point
y	Y-Coordinate of the touched point
touchType	Type of the touch

Returns

true if the touch was processed; false if not.

Reimplemented from UIElement.

---

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

• /github/workspace/include/Containers/ContainerStack.h
• /github/workspace/src/Containers/ContainerStack.cpp