AboutBox Class Reference

Widget that displays framed text. More...

#include <aboutbox.hpp>

Inheritance diagram for AboutBox:

Public Member Functions
	AboutBox (KTech::Engine &engine, KTech::ID< KTech::UI > ui, KTech::Point position, const std::vector< std::string > &text, KTech::RGBA foreground=KTech::RGBAColors::black, KTech::RGBA background=KTech::RGBAColors::gray)
	Construct an AboutBox.
void	SetText (const std::vector< std::string > &text)
	Change the displayed text.
Public Member Functions inherited from KTech::Widget
	Widget (Engine &engine, Point position=Point(0, 0), std::string name="")
	Construct a Widget.
	Widget (Engine &engine, const ID< UI > &parentUI, Point position=Point(0, 0), std::string name="")
	Construct a Widget and immediately enter a UI.
virtual	~Widget ()
	Leave parent UI (if in one) and remove itself from Memory.
auto	AddWidget (const ID< Widget > &widget) -> bool
	Undocumented due to planned changes (see GitHub issue #106).
auto	RemoveWidget (const ID< Widget > &widget) -> bool
	Undocumented due to planned changes (see GitHub issue #106).
auto	RemoveAllWidgets () -> bool
	Undocumented due to planned changes (see GitHub issue #106).
auto	EnterWidget (const ID< Widget > &widget) -> bool
	Undocumented due to planned changes (see GitHub issue #106).
auto	EnterUI (const ID< UI > &ui) -> bool
	Enter a UI.
auto	LeaveWidget () -> bool
	Undocumented due to planned changes (see GitHub issue #106).
auto	LeaveUI () -> bool
	Leave the parent UI.
void	Select ()
	Enable input callbacks, and call Widget::OnSelect().
void	Deselect ()
	Disable input callbacks, and call Widget::OnDisable().
void	Show ()
	Let UI render this Widget, and call Widget::OnShow().
void	Hide ()
	Don't let UI render this Widget, and call Widget::OnHide().

Additional Inherited Members
Public Attributes inherited from KTech::Widget
Engine &	engine
	Parent Engine.
const ID< Widget >	m_id {ID<Widget>::Unique()}
	Personal ID.
std::string	m_name
	String name.
ID< UI >	m_parentUI
	The UI containing this Widget.
ID< Widget >	m_parentWidget = nullID<Widget>
	Undocumented because it's planned to change (see GitHub issue #106).
std::vector< ChildWidget >	m_childWidgets
	Undocumented because it's planned to change (see GitHub issue #106).
bool	m_selected = false
	true: player input reaches the Widget. false: player input doesn't.
bool	m_shown = true
	true: will be rendered by UI. false: will be ignored by UI.
Point	m_pos
	World position.
std::vector< Texture >	m_textures = {}
	Comprising Textures.
Input::CallbackGroup	m_callbackGroup
	Group of all input callbacks, which are enabled and disabled in correspondence to Widget::m_selected.
Protected Member Functions inherited from KTech::Widget
virtual auto	OnTick () -> bool
	Virtual function called once each tick.
virtual void	OnSelect ()
	Virtual function called by Widget::Select().
virtual void	OnDeselect ()
	Virtual function called by Widget::Deselect().
virtual void	OnShow ()
	Virtual function called by Widget::Show().
virtual void	OnHide ()
	Virtual function called by Widget::Hide().

Detailed Description

Widget that displays framed text.

Constructor & Destructor Documentation

AboutBox()

AboutBox::AboutBox ( KTech::Engine & engine, KTech::ID< KTech::UI > ui, KTech::Point position, const std::vector< std::string > & text, KTech::RGBA foreground = KTech::RGBAColors::black, KTech::RGBA background = KTech::RGBAColors::gray )

inline

Construct an AboutBox.

Parameters

[in]	engine	Parent Engine.
[in]	ui	KTech::UI to immediately enter.
[in]	position	World position.
[in]	text	Text to display.
[in]	foreground	Foreground (text and frame) color.
[in]	background	Background color.

Member Function Documentation

SetText()

void AboutBox::SetText ( const std::vector< std::string > & text )

inline

Change the displayed text.

Parameters

[in]

text

Text to display.

---

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

• ktech/widgets/aboutbox.hpp