pu::ui::elm::TextBlock Class Reference

Element for text rendering. More...

#include <elm_TextBlock.hpp>

Inheritance diagram for pu::ui::elm::TextBlock:

Public Member Functions
	TextBlock (const i32 x, const i32 y, const std::string &text)
	Creates a new instance of a TextBlock element.
	~TextBlock ()
i32	GetX () override
	Gets the X position of the Element.
void	SetX (const i32 x)
	Sets the X position of the TextBlock.
i32	GetY () override
	Gets the Y position of the Element.
void	SetY (const i32 y)
	Sets the Y position of the TextBlock.
i32	GetWidth () override
	Gets the width of the Element.
i32	GetHeight () override
	Gets the height of the Element.
std::string	GetText ()
	Gets the text of the TextBlock.
void	SetText (const std::string &text)
	Sets the text of the TextBlock.
void	SetFont (const std::string &font_name)
	Gets the font name of the TextBlock.
void	SetColor (const Color clr)
	Sets the color of the TextBlock.
void	ResetClamp ()
	Resets the clamping of the TextBlock.
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 Color	DefaultColor = { 0, 0, 0, 0xFF }
static constexpr i32	DefaultClampSpeedSteps = 3
static constexpr i32	DefaultClampStaticDelaySteps = 20
static constexpr i32	NoClamp = -1

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

Constructor & Destructor Documentation

TextBlock()

pu::ui::elm::TextBlock::TextBlock	(	const i32	x,
		const i32	y,
		const std::string &	text )

Creates a new instance of a TextBlock element.

Parameters

x	X position of the TextBlock.
y	Y position of the TextBlock.
text	Text to render.

~TextBlock()

pu::ui::elm::TextBlock::~TextBlock

(

)

Member Function Documentation

GetHeight()

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

overridevirtual

Gets the height of the Element.

Returns

Height of the Element.

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

GetText()

std::string pu::ui::elm::TextBlock::GetText ( )

inline

Gets the text of the TextBlock.

Returns

Text of the TextBlock.

GetWidth()

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

overridevirtual

Gets the width of the Element.

Returns

Width of the Element.

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

GetX()

i32 pu::ui::elm::TextBlock::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::TextBlock::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::TextBlock::OnInput ( const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos )

inlineoverridevirtual

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

ResetClamp()

void pu::ui::elm::TextBlock::ResetClamp ( )

inline

Resets the clamping of the TextBlock.

SetColor()

void pu::ui::elm::TextBlock::SetColor

(

const Color

clr

)

Sets the color of the TextBlock.

Parameters

clr	New color.

Note

This will re-render the text.

SetFont()

void pu::ui::elm::TextBlock::SetFont

(

const std::string &

font_name

)

Gets the font name of the TextBlock.

Returns

Font name of the TextBlock.

Note

This will re-render the text.

SetText()

void pu::ui::elm::TextBlock::SetText

(

const std::string &

text

)

Sets the text of the TextBlock.

Parameters

text

New text.

Note

This will re-render the text.

SetX()

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

inline

Sets the X position of the TextBlock.

Parameters

x	New X position.

SetY()

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

inline

Sets the Y position of the TextBlock.

Parameters

y	New Y position.

Member Data Documentation

DefaultClampSpeedSteps

i32 pu::ui::elm::TextBlock::DefaultClampSpeedSteps = 3

staticconstexpr

DefaultClampStaticDelaySteps

i32 pu::ui::elm::TextBlock::DefaultClampStaticDelaySteps = 20

staticconstexpr

DefaultColor

Color pu::ui::elm::TextBlock::DefaultColor = { 0, 0, 0, 0xFF }

staticconstexpr

NoClamp

i32 pu::ui::elm::TextBlock::NoClamp = -1

staticconstexpr

---

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

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