Aether
SDL2 based UI Framework for NX
Public Member Functions | List of all members
Aether::FilledButton Class Reference

A FilledButton is exactly that. The text/rectangle are resized/repositioned to be centered on any resizes. More...

#include <FilledButton.hpp>

Inheritance diagram for Aether::FilledButton:
Aether::Element

Public Member Functions

 FilledButton (int x, int y, int w, int h, std::string t, unsigned int s, std::function< void()> f)
 Construct a new Filled Button object. More...
 
Colour getFillColour ()
 Get the colour to fill rectangle with. More...
 
void setFillColour (Colour c)
 Set the colour to fill rectangle with. More...
 
Colour getTextColour ()
 Get the text's colour. More...
 
void setTextColour (Colour c)
 Set the text's colour. More...
 
std::string getString ()
 Get current button text. More...
 
void setString (std::string s)
 Set new button text. More...
 
void setW (int w)
 Set new width for the button. More...
 
void setH (int h)
 Set new width for the button. More...
 
DrawablerenderHighlightBG ()
 Render highlight background.
 
DrawablerenderHighlight ()
 Render highlight border.
 
DrawablerenderSelection ()
 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...
 
Elementparent ()
 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...
 
Elementfocused ()
 Returns the currently focused element. More...
 
Elementfocussed ()
 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
Elementparent_
 Pointer to parent element, if there is one.
 
std::vector< Element * > children
 Vector of child elements (used to call their methods)
 
Elementfocused_
 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 DrawablehiBGTex
 Highlight background texture.
 
static DrawablehiBorderTex
 Highlight border texture.
 
static DrawableselTex
 Selection texture.
 
static Rendererrenderer
 
static bool isTouch
 Indicator on whether the touch is "active" (i.e. hide highlighting) or not.
 

Detailed Description

A FilledButton is exactly that. The text/rectangle are resized/repositioned to be centered on any resizes.

Constructor & Destructor Documentation

◆ FilledButton()

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

Construct a new Filled Button object.

Parameters
xx-coordinate of start position offset
yy-coordinate of start position offset
wwidth of button
hheight of button
tbutton text
sfont size (will be smaller if text can't fit)
ffunction to invoke on button press

Member Function Documentation

◆ getFillColour()

Colour Aether::FilledButton::getFillColour ( )

Get the colour to fill rectangle with.

Returns
rectangle colour

◆ getString()

std::string Aether::FilledButton::getString ( )

Get current button text.

Returns
button text

◆ getTextColour()

Colour Aether::FilledButton::getTextColour ( )

Get the text's colour.

Returns
text colour

◆ setFillColour()

void Aether::FilledButton::setFillColour ( Colour  c)

Set the colour to fill rectangle with.

Parameters
cnew rectangle colour

◆ setH()

void Aether::FilledButton::setH ( int  h)
virtual

Set new width for the button.

Note
Adjusting dimensions causes text position to be adjusted
Rectangle needs to be rendered again
Parameters
hnew height

Reimplemented from Aether::Element.

◆ setString()

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

Set new button text.

Parameters
snew button text

◆ setTextColour()

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

Set the text's colour.

Parameters
cnew colour to set

◆ setW()

void Aether::FilledButton::setW ( int  w)
virtual

Set new width for the button.

Note
Adjusting dimensions causes text position to be adjusted
Rectangle needs to be rendered again
Parameters
wnew width

Reimplemented from Aether::Element.


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