Aether::Container Class Reference

A container is an element that contains other elements. It implements the required behaviour to navigate between children. More...

#include <Container.hpp>

Inheritance diagram for Aether::Container:

Public Member Functions
	Container (int x=0, int y=0, int w=100, int h=100)
	Construct a new Container object. More...
void	setActive ()
	Re-highlight/focus the focused element.
void	setInactive ()
	Removes focus from the focused element.
void	addElement (Element *e)
	Adds new element a child. More...
bool	handleEvent (InputEvent *e)
	Attempt to handle a given event. More...
bool	removeElement (Element *e)
	Attempt to delete given child element. More...
void	removeAllElements ()
	Deletes all children elements.
bool	returnElement (Element *e)
	Attempt to remove the given child element. More...
void	returnAllElements ()
	Removes (but does not delete) all children elements.
Public Member Functions inherited from Aether::Element
	Element (int x=0, int y=0, int w=100, int h=100)
	Construct a new Element object. More...
int	x ()
	Returns x-coordinate of element. More...
int	y ()
	Returns y-coordinate of element. More...
int	w ()
	Returns width of element. More...
int	h ()
	Returns height of element. More...
virtual void	setX (int x)
	Set x-coordinate of element. More...
virtual void	setY (int y)
	Set y-coordinate of element. More...
virtual void	setW (int w)
	Set width of element. More...
virtual void	setH (int h)
	Set height of element. More...
virtual void	setXY (int x, int y)
	Set co-ordinates of element. More...
virtual void	setWH (int w, int h)
	Set size of element. More...
virtual void	setXYWH (int x, int y, int w, int h)
	Setter size and co-ordinates of element. More...
Element *	parent ()
	Returns the parent element of this element. More...
void	setParent (Element *p)
	Set the parent element of this element. More...
bool	isVisible ()
	Check if current element is visible on-screen. More...
bool	hidden ()
	Check if current element is hidden. More...
void	setHidden (bool b)
	Set whether element is hidden or not. More...
bool	selected ()
	Check if current element is selected. More...
virtual void	setSelected (bool b)
	Set whether element is selected or not. More...
bool	selectable ()
	Check if current element is selectable. More...
void	setSelectable (bool b)
	Set whether element is selectable or not. More...
bool	touchable ()
	Check if current element is touch responsive. More...
void	setTouchable (bool b)
	Set whether element is touch responsive or not. More...
bool	highlighted ()
	Check if current element is highlighted. More...
void	setHighlighted (bool b)
	Set whether element is highlighted or not. More...
bool	hasHighlighted ()
	Check if current element has highlighted children element. More...
void	setHasHighlighted (bool b)
	Set whether element has highlighted children element or not. More...
bool	hasSelectable ()
	Check if current element has selectable children element. More...
void	setHasSelectable (bool b)
	Set whether element has selectable children element or not. More...
bool	hasSelected ()
	Check if current element has selected children element. More...
void	setHasSelected (bool b)
	Set whether element has selected children element or not. More...
void	setFocused (Element *e)
	Sets current element as unfocused and instead focuses a sub-element. More...
void	setFocussed (Element *e)
	Sets current element as unfocused and instead focuses a sub-element. More...
Element *	focused ()
	Returns the currently focused element. More...
Element *	focussed ()
	Returns the currently focused element. More...
std::function< void()>	onPressFunc ()
	Returns function invoked when the element is pressed. More...
void	onPress (std::function< void()> f)
	Sets the function to invoked when the element is pressed. More...
virtual void	update (unsigned int dt)
	Update is passed time since last frame (for animations) More...
virtual void	render ()
	Render child elements + highlights.
virtual Drawable *	renderHighlightBG ()
	Renders the highlight background. More...
virtual Drawable *	renderHighlight ()
	Renders the highlight border. More...
virtual Drawable *	renderSelection ()
	Renders the selection overlay. More...
virtual	~Element ()
	Destroy the Element object.

Protected Member Functions
void	addElementAt (Element *e, size_t i)
Protected Member Functions inherited from Aether::Element
void	renderHighlightTextures ()
	Renders cached highlight textures.
void	renderSelectionTexture ()
	Renders cached selection texture.
void	addElementAt (Element *e, size_t i)
	Add element at given index in vector. More...

Friends
bool	moveHighlight (Container *parent, std::function< bool(Element *, Element *)> check, std::function< int(Element *, Element *)> dist)
	Determine which element to move to. More...

Additional Inherited Members
Protected Attributes inherited from Aether::Element
Element *	parent_
	Pointer to parent element, if there is one.
std::vector< Element * >	children
	Vector of child elements (used to call their methods)
Element *	focused_
	Children element which is highlighted/focused (to regain focus on activation)
Static Protected Attributes inherited from Aether::Element
static Colour	hiBGColour
	Background colour if element is highlighted.
static Colour	hiBorderColour
	Border colour if element is highlighted.
static Colour	selColour
	Selected colour if element is highlighted.
static unsigned int	hiSize
	Size of highlight border.
static Drawable *	hiBGTex
	Highlight background texture.
static Drawable *	hiBorderTex
	Highlight border texture.
static Drawable *	selTex
	Selection texture.
static Renderer *	renderer
static bool	isTouch
	Indicator on whether the touch is "active" (i.e. hide highlighting) or not.

Detailed Description

A container is an element that contains other elements. It implements the required behaviour to navigate between children.

Note

It must be used when controller navigation is required between children! Using a standard Element will result in navigation being ignored.

It allows the selection to automatically move between elements without having to specify which ones are next to which.

Constructor & Destructor Documentation

Container()

Aether::Container::Container	(	int	x = 0,
		int	y = 0,
		int	w = 100,
		int	h = 100
	)

Construct a new Container object.

Parameters

x	x-coordinate of start position offset
y	y-coordinate of start position offset
w	width of container
h	height of container

Member Function Documentation

addElement()

void Aether::Container::addElement ( Element *  e )

virtual

Adds new element a child.

Parameters

e	element to add

Reimplemented from Aether::Element.

Reimplemented in Aether::Scrollable.

handleEvent()

bool Aether::Container::handleEvent ( InputEvent *  e )

virtual

Attempt to handle a given event.

Parameters

e	event to handle

Returns

true if event was handled

false if event was not handled

Reimplemented from Aether::Element.

Reimplemented in Aether::Scrollable, Aether::DateTime, Aether::Spinner, Aether::List, and Aether::Screen.

removeElement()

bool Aether::Container::removeElement ( Element *  e )

virtual

Attempt to delete given child element.

Note

This calls the element destructor if it is found

Parameters

e	child to delete

Returns

true if deleted successfully (i.e. was a child)

false if not a child of element

Reimplemented from Aether::Element.

Reimplemented in Aether::Scrollable.

returnElement()

bool Aether::Container::returnElement ( Element *  e )

virtual

Attempt to remove the given child element.

Note

This does not call the element's destructor, hence it can be reused

Parameters

e	child to remove

Returns

true if removed successfully (i.e. was a child)

false if not a child of element

Reimplemented from Aether::Element.

Reimplemented in Aether::Scrollable.

Friends And Related Function Documentation

moveHighlight

bool moveHighlight ( Container *  parent, std::function< bool(Element *, Element *)>  check, std::function< int(Element *, Element *)>  dist  )

friend

Determine which element to move to.

Parameters

parent	parent element (usually this)
check	function which returns true if size between elements is valid
dist	function to return distance between two elements

Returns

true if valid element found to move to

false otherwise

---

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

• include/Aether/base/Container.hpp