pu::ui::elm::Toggle Class Reference

Element for toggling between two states. More...

#include <elm_Toggle.hpp>

Inheritance diagram for pu::ui::elm::Toggle:

Public Member Functions
	Toggle (const i32 x, const i32 y, const std::string &content, const u64 toggle_key, const Color clr)
	Creates a new instance of a Toggle element.
	~Toggle ()
i32	GetX () override
	Gets the X position of the Element.
void	SetX (const i32 x)
	Sets the X position of the Toggle.
i32	GetY () override
	Gets the Y position of the Element.
void	SetY (const i32 y)
	Sets the Y position of the Toggle.
i32	GetWidth () override
	Gets the width of the Element.
i32	GetHeight () override
	Gets the height of the Element.
std::string	GetContent ()
	Gets the content of the Toggle.
void	SetContent (const std::string &content)
	Sets the content of the Toggle.
void	SetFont (const std::string &font_name)
	Gets the font name of the Toggle.
void	SetColor (const Color clr)
	Sets the color of the Toggle.
void	OnRender (render::Renderer::Ref &drawer, const i32 x, const i32 y) override
	Renders the Element on the screen.
void	OnInput (const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos) override
	Called before rendering the Element in order to handle input.
Public Member Functions inherited from pu::ui::elm::Element
	Element ()
	Creates a new instance of an Element.
virtual	~Element ()
bool	IsVisible ()
	Gets whether the Element is visible.
void	SetVisible (const bool visible)
	Sets whether the Element is visible.
void	SetHorizontalAlign (const HorizontalAlign align)
	Sets the horizontal alignment of the Element.
HorizontalAlign	GetHorizontalAlign ()
	Gets the horizontal alignment of the Element.
void	SetVerticalAlign (const VerticalAlign align)
	Sets the vertical alignment of the Element.
VerticalAlign	GetVerticalAlign ()
	Gets the vertical alignment of the Element.
void	SetParentContainer (Container *parent_container)
	Sets the parent Container of the Element.
i32	GetProcessedX ()
	Gets the actual X position of the Element, considering the parent Container (depends on alignment).
i32	GetProcessedY ()
	Gets the actual Y position of the Element, considering the parent Container (depends on alignment).

Static Public Attributes
static constexpr u32	DefaultContentHorizontalMargin = 30
static constexpr u32	DefaultContentVerticalMargin = 20
static constexpr DefaultFontSize	DefaultContentFontSize = DefaultFontSize::MediumLarge
static constexpr u8	DefaultToggleAlphaIncrement = 48
static constexpr Color	DefaultBackgroundColor = { 130, 130, 130, 255 }

Additional Inherited Members
Protected Attributes inherited from pu::ui::elm::Element
bool	visible
HorizontalAlign	h_align
VerticalAlign	v_align
Container *	parent_container

Detailed Description

Element for toggling between two states.

Constructor & Destructor Documentation

Toggle()

pu::ui::elm::Toggle::Toggle	(	const i32	x,
		const i32	y,
		const std::string &	content,
		const u64	toggle_key,
		const Color	clr )

Creates a new instance of a Toggle element.

Parameters

x	X position of the Toggle.
y	Y position of the Toggle.
content	Content of the Toggle.
toggle_key	Key to toggle the state of the Toggle.
clr	Color of the Toggle.

~Toggle()

pu::ui::elm::Toggle::~Toggle

(

)

Member Function Documentation

GetContent()

std::string pu::ui::elm::Toggle::GetContent ( )

inline

Gets the content of the Toggle.

Returns

Content of the Toggle.

GetHeight()

i32 pu::ui::elm::Toggle::GetHeight ( )

overridevirtual

Gets the height of the Element.

Returns

Height of the Element.

Implements pu::ui::elm::Element.

GetWidth()

i32 pu::ui::elm::Toggle::GetWidth ( )

overridevirtual

Gets the width of the Element.

Returns

Width of the Element.

Implements pu::ui::elm::Element.

GetX()

i32 pu::ui::elm::Toggle::GetX ( )

inlineoverridevirtual

Gets the X position of the Element.

Returns

X position of the Element.

Implements pu::ui::elm::Element.

GetY()

i32 pu::ui::elm::Toggle::GetY ( )

inlineoverridevirtual

Gets the Y position of the Element.

Returns

Y position of the Element.

Implements pu::ui::elm::Element.

OnInput()

void pu::ui::elm::Toggle::OnInput ( const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos )

overridevirtual

Called before rendering the Element in order to handle input.

Parameters

keys_down	Keys that are currently being pressed.
keys_up	Keys that are currently being released.
keys_held	Keys that are currently held.
touch_pos	Position of the touch on the screen.

Note

This method is called by the Application. It should not be called manually.

Implements pu::ui::elm::Element.

OnRender()

void pu::ui::elm::Toggle::OnRender ( render::Renderer::Ref & drawer, const i32 x, const i32 y )

overridevirtual

Renders the Element on the screen.

Parameters

drawer	Renderer to use for rendering.
x	X position to render the Element.
y	Y position to render the Element.

Note

This method is called by the Application. It should not be called manually.

Implements pu::ui::elm::Element.

SetColor()

void pu::ui::elm::Toggle::SetColor

(

const Color

clr

)

Sets the color of the Toggle.

Parameters

clr	New color.

Note

This will re-render the content of the Toggle.

SetContent()

void pu::ui::elm::Toggle::SetContent

(

const std::string &

content

)

Sets the content of the Toggle.

Parameters

content

New content.

Note

This will re-render the content of the Toggle.

SetFont()

void pu::ui::elm::Toggle::SetFont

(

const std::string &

font_name

)

Gets the font name of the Toggle.

Returns

Font name of the Toggle.

Note

This will re-render the content of the Toggle.

SetX()

void pu::ui::elm::Toggle::SetX ( const i32 x )

inline

Sets the X position of the Toggle.

Parameters

x	New X position.

SetY()

void pu::ui::elm::Toggle::SetY ( const i32 y )

inline

Sets the Y position of the Toggle.

Parameters

y	New Y position.

Member Data Documentation

DefaultBackgroundColor

Color pu::ui::elm::Toggle::DefaultBackgroundColor = { 130, 130, 130, 255 }

staticconstexpr

DefaultContentFontSize

DefaultFontSize pu::ui::elm::Toggle::DefaultContentFontSize = DefaultFontSize::MediumLarge

staticconstexpr

DefaultContentHorizontalMargin

u32 pu::ui::elm::Toggle::DefaultContentHorizontalMargin = 30

staticconstexpr

DefaultContentVerticalMargin

u32 pu::ui::elm::Toggle::DefaultContentVerticalMargin = 20

staticconstexpr

DefaultToggleAlphaIncrement

u8 pu::ui::elm::Toggle::DefaultToggleAlphaIncrement = 48

staticconstexpr

---

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

• Plutonium/include/pu/ui/elm/elm_Toggle.hpp