A "PopupList" is an overlay at the bottom of the screen containing a list of items to select from. A handler must be specified for each item, and the overlay is closed when any item is selected. More...

#include <PopupList.hpp>

Inheritance diagram for Aether::PopupList:

Public Member Functions
	PopupList (std::string s)
	Construct a new Popup List object. More...

void	addEntry (std::string s, std::function< void()> f, bool t=false)
	Add new entry to popup list. More...

void	setTitleLabel (std::string s)
	Set the title label. More...

void	setBackLabel (std::string s)
	Set the back button label. More...

void	setOKLabel (std::string s)
	Set the OK button label. More...

void	removeEntries ()
	Removes all entries from list.

Colour	getBackgroundColour ()
	Get the background colour. More...

void	setBackgroundColour (Colour c)
	Set the background colour. More...

Colour	getTextColour ()
	Get the text colour. More...

void	setTextColour (Colour c)
	Set the text colour. More...

Colour	getLineColour ()
	Get the line colour. More...

void	setLineColour (Colour c)
	Set the line colour. More...

Colour	getHighlightColour ()
	Get the highlight colour. More...

void	setHighlightColour (Colour c)
	Set the highlight colour. More...

Colour	getListLineColour ()
	Get the list line colour. More...

void	setListLineColour (Colour c)
	Set the list line colour. More...

void	setAllColours (Colour bg, Colour hi, Colour li, Colour lli, Colour tx)
	Set the all colours. More...

Public Member Functions inherited from Aether::Overlay
	Overlay ()
	Construct a new Overlay object.

void	close ()
	Mark overlay to be closed.

void	reuse ()
	Mark overlay to be able to used (readded) again. More...

bool	shouldClose ()
	Check if overlay is marked to be closed. More...

void	render ()
	Draws background then renders overlay.

Public Member Functions inherited from Aether::Screen
	Screen ()
	Constructs a new (empty) Screen object.

virtual void	onLoad ()
	Invoked once when the screen is requested to be 'shown'. This method should set up all child elements.

virtual void	onUnload ()
	Invoked once when the screen has been replaced by another screen. This method should tidy up all child elements.

void	onButtonPress (Button btn, std::function< void()> func)
	Assigns a function to invoke when a button is pressed. More...

void	onButtonRelease (Button btn, std::function< void()> func)
	Assigns a function to invoke when a button is released. More...

bool	handleEvent (InputEvent *event)
	Attempts to handle the event if it is a button press/release. More...

Public Member Functions inherited from Aether::Container
	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	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 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.

Additional Inherited Members
Protected Member Functions inherited from Aether::Container
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...

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 "PopupList" is an overlay at the bottom of the screen containing a list of items to select from. A handler must be specified for each item, and the overlay is closed when any item is selected.

Constructor & Destructor Documentation

◆ PopupList()

Aether::PopupList::PopupList ( std::string s )

Construct a new Popup List object.

Parameters

s	title string

Member Function Documentation

◆ addEntry()

void Aether::PopupList::addEntry	(	std::string	s,
		std::function< void()>	f,
		bool	t = `false`
	)

Add new entry to popup list.

Note: Back/OK buttons have default text but can be changed using other functions

Parameters

s	entry item string
f	function to invoke if entry is selected
t	indicator on whether to show entry as ticked

◆ getBackgroundColour()

Colour Aether::PopupList::getBackgroundColour ( )

Get the background colour.

Returns: background colour

◆ getHighlightColour()

Colour Aether::PopupList::getHighlightColour ( )

Get the highlight colour.

Returns: highlight colour

◆ getLineColour()

Colour Aether::PopupList::getLineColour ( )

Get the line colour.

Returns: line colour

◆ getListLineColour()

Colour Aether::PopupList::getListLineColour ( )

Get the list line colour.

Returns: list line colour

◆ getTextColour()

Colour Aether::PopupList::getTextColour ( )

Get the text colour.

Returns: text colour

◆ setAllColours()

void Aether::PopupList::setAllColours	(	Colour	bg,
		Colour	hi,
		Colour	li,
		Colour	lli,
		Colour	tx
	)

Set the all colours.

Parameters

bg	new background colour
hi	new highlight colour
li	new line colour
lli	new list line colour
tx	new text colour

◆ setBackgroundColour()

void Aether::PopupList::setBackgroundColour ( Colour c )

Set the background colour.

Parameters

c	new colour

◆ setBackLabel()

void Aether::PopupList::setBackLabel ( std::string s )

Set the back button label.

Parameters

s new label

◆ setHighlightColour()

void Aether::PopupList::setHighlightColour ( Colour c )

Set the highlight colour.

Parameters

c	new colour

◆ setLineColour()

void Aether::PopupList::setLineColour ( Colour c )

Set the line colour.

Parameters

c	new colour

◆ setListLineColour()

void Aether::PopupList::setListLineColour ( Colour c )

Set the list line colour.

Parameters

c	new colour

◆ setOKLabel()

void Aether::PopupList::setOKLabel ( std::string s )

Set the OK button label.

Parameters

s new label

◆ setTextColour()

void Aether::PopupList::setTextColour ( Colour c )

Set the text colour.

Parameters

c	new colour

◆ setTitleLabel()

void Aether::PopupList::setTitleLabel ( std::string s )

Set the title label.

Parameters

s new label

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

include/Aether/horizon/overlays/PopupList.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PopupList()

Member Function Documentation

◆ addEntry()

◆ getBackgroundColour()

◆ getHighlightColour()

◆ getLineColour()

◆ getListLineColour()

◆ getTextColour()

◆ setAllColours()

◆ setBackgroundColour()

◆ setBackLabel()

◆ setHighlightColour()

◆ setLineColour()

◆ setListLineColour()

◆ setOKLabel()

◆ setTextColour()

◆ setTitleLabel()