Skip to main content
Version: 4.16

ListLayout

This class provides a layout mechanism for arranging Drawable instances adjacent in the specified Direction. The first element in the ListLayout is positioned in the ListLayout origin (0,0). The dimensions of this class is automatically expanded to cover the area of the added Drawable instances, which may grow larger than the dimensions of the physical screen. Place the ListLayout inside e.g. a ScrollableContainer to allow all the children to be viewed.

See: ScrollableContainer

Inherits from: Container, Drawable

Public Functions#

virtual voidadd(Drawable & d)
Adds a Drawable instance to the end of the list.
virtual DirectiongetDirection() const
Gets the direction of the ListLayout.
virtual voidinsert(Drawable * previous, Drawable & d)
Inserts a Drawable after a specific child node.
ListLayout(const Direction d =SOUTH)
Initializes a new instance of the ListLayout class.
virtual voidremove(Drawable & d)
Removes a Drawable.
virtual voidremoveAll()
Removes all children in the Container by resetting their parent and sibling pointers.
virtual voidsetDirection(const Direction d)
Sets the direction of the ListLayout.

Additional inherited members#

Public Functions inherited from Container#

Container()
virtual boolcontains(const Drawable & d)
Query if a given Drawable has been added directly to this Container.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
virtual voidforEachChild(GenericCallback< Drawable & > * function)
Executes the specified callback function for each child in the Container.
virtual Drawable *getFirstChild()
Obtain a pointer to the first child of this container.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Gets the last child in the list of children in this Container.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual voidunlink()
Removes all children by unlinking the first child.

Protected Functions inherited from Container#

virtual RectgetContainedArea() const
Gets a rectangle describing the total area covered by the children of this container.
virtual voidmoveChildrenRelative(int16_t deltaX, int16_t deltaY)
Calls moveRelative on all children.

Protected Attributes inherited from Container#

Drawable *firstChild
Pointer to the first child of this container. Subsequent children can be found through firstChild's nextSibling.

Public Functions inherited from Drawable#

virtual voidchildGeometryChanged()
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 voiddraw(const Rect & invalidatedArea) const =0
Draw this drawable.
Drawable()
Initializes a new instance of the Drawable class.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
RectgetAbsoluteRect() 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_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(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 RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleClickEvent(const ClickEvent & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & evt)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & rect)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(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.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Public Functions Documentation#

add#

virtual void add(Drawable &d)

Adds a Drawable instance to the end of the list.

The Drawable dimensions shall be set prior to addition. The coordinates of the Drawable will be updated to reflect the position in the ListLayout.

Parameters:
dThe Drawable to add.

Reimplements: touchgfx::Container::add

getDirection#

virtual Direction getDirection()const

Gets the direction of the ListLayout.

Returns:

The current direction to grow in when added children (either SOUTH or EAST).

See also:

insert#

virtual void insert(Drawable *previous ,
Drawable &d
)

Inserts a Drawable after a specific child node.

If previous child node is 0, the drawable will be inserted as the first element in the list. The first element in the list of children is the element drawn first, so this makes it possible to insert a Drawablebehind all previously added children.

Parameters:
previousThe Drawable to insert after. If null, insert as header.
dThe Drawable to insert.
Note

As with add, do not add the same drawable twice.

Reimplements: touchgfx::Container::insert

ListLayout#

ListLayout(const Directiond =SOUTH)

Initializes a new instance of the ListLayout class.

Parameters:
d(Optional) The direction to place the elements. SOUTH (Default) places the elements vertically, EAST places the elements horizontally.
See also:

remove#

virtual void remove(Drawable &d)

Removes a Drawable.

Safe to call even if drawable has not been added. Other Drawable elements in the ListLayout are repositioned and the size of the ListLayout is adjusted.

Parameters:
dThe drawable to remove.

Reimplements: touchgfx::Container::remove

removeAll#

virtual void removeAll()

Removes all children in the Container by resetting their parent and sibling pointers.

Please note that this is not done recursively, so any child which is itself a Container is not emptied.

Reimplements: touchgfx::Container::removeAll

setDirection#

virtual void setDirection(const Directiond)

Sets the direction of the ListLayout.

If elements have already been added to the ListLayout, these elements will be repositioned to adhere to the new direction.

Parameters:
dThe new Direction to grow in when added children (either SOUTH or EAST).
See also: