The BorderButton element looks similar to the unfilled buttons seen within Horizon. More...

#include <BorderButton.hpp>

Inheritance diagram for Aether::BorderButton:

Public Member Functions
	BorderButton (int x, int y, int w, int h, unsigned int b, std::string t, unsigned int s, std::function< void()> f)
	The text in the button. More...

Colour	getBorderColour ()
	Get the colour of the border. More...

void	setBorderColour (Colour c)
	Set the colour of the border. More...

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

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

std::string	getString ()
	Get the text for the button. More...

void	setString (std::string s)
	Set the text for the button. More...

void	setW (int w)
	Set the width for the button. More...

void	setH (int h)
	Set the height for the button. More...

Drawable *	renderHighlightBG ()
	Render highlight background.

Drawable *	renderHighlight ()
	Render highlight border.

Drawable *	renderSelection ()
	Render selection layer.

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...

virtual void	addElement (Element *e)
	Adds new element a child. More...

virtual bool	removeElement (Element *e)
	Attempt to delete given child element. More...

virtual void	removeAllElements ()
	Deletes all children elements.

virtual bool	returnElement (Element *e)
	Attempt to remove the given child element. More...

virtual void	returnAllElements ()
	Removes (but does not delete) all children elements.

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...

virtual void	setActive ()
	Set element as activated.

virtual void	setInactive ()
	Set element as in-activated.

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 bool	handleEvent (InputEvent *e)
	Attempt to handle a given event. 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	~Element ()
	Destroy the Element object.

Additional Inherited Members
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

The BorderButton element looks similar to the unfilled buttons seen within Horizon.

Constructor & Destructor Documentation

◆ BorderButton()

Aether::BorderButton::BorderButton	(	int	x,
		int	y,
		int	w,
		int	h,
		unsigned int	b,
		std::string	t,
		unsigned int	s,
		std::function< void()>	f
	)

The text in the button.

Construct a new Border Button object

Parameters

x	x-coordinate of the start position offset
y	y-coordinate of the start position offset
w	width of the button
h	height of the buttpn
b	border size
t	text in button
s	text size
f	function to invoke on button press

Member Function Documentation

◆ getBorderColour()

Colour Aether::BorderButton::getBorderColour ( )

Get the colour of the border.

Returns: border colour

◆ getString()

std::string Aether::BorderButton::getString ( )

Get the text for the button.

Returns: button text

◆ getTextColour()

Colour Aether::BorderButton::getTextColour ( )

Get the colour of the text.

Returns: text colour

◆ setBorderColour()

void Aether::BorderButton::setBorderColour ( Colour c )

Set the colour of the border.

Parameters

c	new border colour

◆ setH()

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

virtual

Set the height for the button.

Note: Changing dimension requires text position to be adjusted; Box to be rendered again

Parameters

h	new button height

Reimplemented from Aether::Element.

◆ setString()

void Aether::BorderButton::setString ( std::string s )

Set the text for the button.

Parameters

s	new button text

◆ setTextColour()

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

Set the colour of the text.

Parameters

c	new text colour

◆ setW()

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

virtual

Set the width for the button.

Note: Changing dimension requires text position to be adjusted; Box to be rendered again

Parameters

w	new button width

Reimplemented from Aether::Element.

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

include/Aether/horizon/button/BorderButton.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BorderButton()

Member Function Documentation

◆ getBorderColour()

◆ getString()

◆ getTextColour()

◆ setBorderColour()

◆ setH()

◆ setString()

◆ setTextColour()

◆ setW()