A ListHeading but with a help icon that's right aligned. More...

#include <ListHeadingHelp.hpp>

Inheritance diagram for Aether::ListHeadingHelp:

Public Member Functions
	ListHeadingHelp (std::string s, std::function< void()> f)
	Construct a new List Heading Help object. Auto positions elements when instantiated. More...

Colour	getHelpColour ()
	Get the help colour. More...

void	setHelpColour (Colour c)
	Set the help colour. More...

Colour	getRectColour ()
	Get the rectangle colour. More...

void	setRectColour (Colour c)
	Set the rectangle colour. More...

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

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

void	onHelpPressed (std::function< void()> f)
	Sets the function to invoke when the help button is pressed. More...

void	setW (int w)
	Adjusts the list heading width. Repositions elements as necessary. More...

void	setH (int h)
	Adjusts the list heading height. Repositions elements as necessary. 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	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	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.

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 ListHeading but with a help icon that's right aligned.

Constructor & Destructor Documentation

◆ ListHeadingHelp()

Aether::ListHeadingHelp::ListHeadingHelp	(	std::string	s,
		std::function< void()>	f
	)

Construct a new List Heading Help object. Auto positions elements when instantiated.

Parameters

s	list heading string
f	function to invoke on help button press

Member Function Documentation

◆ getHelpColour()

Colour Aether::ListHeadingHelp::getHelpColour ( )

Get the help colour.

Returns: help colour

◆ getRectColour()

Colour Aether::ListHeadingHelp::getRectColour ( )

Get the rectangle colour.

Returns: rectangle colour

◆ getTextColour()

Colour Aether::ListHeadingHelp::getTextColour ( )

Get the text colour.

Returns: text colour

◆ onHelpPressed()

void Aether::ListHeadingHelp::onHelpPressed ( std::function< void()> f )

Sets the function to invoke when the help button is pressed.

Parameters

f	Function to invoke

◆ setH()

void Aether::ListHeadingHelp::setH ( int h )

virtual

Adjusts the list heading height. Repositions elements as necessary.

Parameters

h	new height

Reimplemented from Aether::Element.

◆ setHelpColour()

void Aether::ListHeadingHelp::setHelpColour ( Colour c )

Set the help colour.

Parameters

c	new help colour

◆ setRectColour()

void Aether::ListHeadingHelp::setRectColour ( Colour c )

Set the rectangle colour.

Parameters

c	new rectangle coloue

◆ setTextColour()

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

Set the text colour.

Parameters

c	new text colour

◆ setW()

void Aether::ListHeadingHelp::setW ( int w )

virtual

Adjusts the list heading width. Repositions elements as necessary.

Parameters

w new width

Reimplemented from Aether::Element.

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

include/Aether/horizon/list/ListHeadingHelp.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ListHeadingHelp()

Member Function Documentation

◆ getHelpColour()

◆ getRectColour()

◆ getTextColour()

◆ onHelpPressed()

◆ setH()

◆ setHelpColour()

◆ setRectColour()

◆ setTextColour()

◆ setW()