A list is a scrollable with some values changed to match how a list functions within Horizon. More...

#include <List.hpp>

Inheritance diagram for Aether::List:

Public Member Functions
	List (int x, int y, int w, int h, Padding p=Padding::Default)
	Construct a new List object. The scrollbar is shown by default. More...

void	setInactive ()
	A list needs to stop scrolling when it is set inactive.

bool	wrapAround ()
	Returns whether the list is configured to wrap around. More...

void	setWrapAround (bool b)
	Set whether the list 'wraps around' from top to bottom and vice versa. More...

bool	handleEvent (InputEvent *e)
	Attempts to handle event. More...

void	update (unsigned int dt)
	Updates info as necessary. More...

Public Member Functions inherited from Aether::Scrollable
	Scrollable (int x, int y, int w, int h, Padding p=Padding::Default)
	Construct a new Scrollable object. More...

int	catchup ()
	Get amount to "catchup" by. More...

void	setCatchup (int c)
	Set amount to "catchup" by. More...

float	dampening ()
	Get amount to decrease velocity by (pixels per second) More...

void	setDampening (float d)
	Set amount to decrease velocity by (pixels per second) More...

bool	showScrollBar ()
	Returns if the scroll bar is being shown. More...

void	setShowScrollBar (bool b)
	Set whether to show scroll bar. More...

void	setScrollBarColour (Colour c)
	Set scroll bar colour. More...

bool	canScroll ()
	Check whether this element can be scrolled (by touch/drag) More...

void	setCanScroll (bool b)
	Set whether this element can be scrolled by touching and dragging. More...

int	maxScrollPos ()
	Returns the maximum value permitted for scrollPos (i.e. the limit). More...

int	scrollPos ()
	Returns current scroll position of list (0 indicates at the top) More...

void	setScrollPos (int pos)
	Sets scrollPos. Set to min/max if outside valid range. More...

void	addElement (Element *e)
	Add the given element to the list. More...

bool	addElementAfter (Element e, Element a)
	Adds an element to the scrollable object after the specified element. Pass nullptr to insert at the start. More...

bool	addElementBefore (Element e, Element b)
	Adds an element to the scrollable object before the specified element. Pass nullptr to insert at the end (note: this is the same as addElement()) More...

bool	removeElementsAfter (Element *e)
	Deletes any elements succeeding the given element. More...

bool	removeElementsBefore (Element *e)
	Deletes any elements preceding the given element. More...

void	setW (int w)
	Set width of element. More...

void	setH (int h)
	Set height of element. 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.

void	render ()
	Render child elements + highlights.

	~Scrollable ()
	Delete the scrollable object.

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.

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 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::Scrollable
void	addElementAt (Element *e, size_t i)

void	updateMaxScrollPos ()
	Sums up height of children and sets maximum scroll value.

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::Scrollable
bool	canScroll_
	Indicator on whether scrolling is allowed.

bool	isTouched
	Indicator on whether this scrollable has been touched (used for scrolling when touch is outside)

bool	isScrolling
	Indicator on whether is the element is scrolling (used for touch events)

float	scrollDampening
	Amount to decrease velocity by (oixels per second)

float	scrollVelocity
	Scroll velocity (pixels to scroll per second)

int	touchY
	Start of touch Y coord (used to touch element instead of scroll briefly)

unsigned int	maxScrollPos_
	Maximum Y offset in pixels.

float	scrollCatchup
	Amount to "catchup" by.

unsigned int	scrollPos_
	Offset (y) in pixels.

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 list is a scrollable with some values changed to match how a list functions within Horizon.

Constructor & Destructor Documentation

◆ List()

Aether::List::List	(	int	x,
		int	y,
		int	w,
		int	h,
		Padding	p = `Padding::Default`
	)

Construct a new List object. The scrollbar is shown by default.

Parameters

x	x-coordinate of start position offset
y	y-coordinate of start position offset
w	width of list
h	height of list
p	type of padding to use (see Padding)

Member Function Documentation

◆ handleEvent()

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

virtual

Attempts to handle event.

Parameters

e	event to attempt handle

Returns: true if event was handled; false otherwise

Reimplemented from Aether::Scrollable.

◆ setWrapAround()

void Aether::List::setWrapAround ( bool b )

Set whether the list 'wraps around' from top to bottom and vice versa.

Parameters

b	true to wrap around, false to not

◆ update()

void Aether::List::update ( unsigned int dt )

virtual

Updates info as necessary.

Parameters

dt	change in time

Reimplemented from Aether::Scrollable.

◆ wrapAround()

bool Aether::List::wrapAround ( )

Returns whether the list is configured to wrap around.

Returns: true if it is; false otherwise

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

include/Aether/horizon/list/List.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ List()

Member Function Documentation

◆ handleEvent()

◆ setWrapAround()

◆ update()

◆ wrapAround()