HoverRace::Display::BaseText Class Reference

Base class for widgets that display text. More...

#include <BaseText.h>

Inheritance diagram for HoverRace::Display::BaseText:

Classes
struct	Props

Public Member Functions
	BaseText (const std::string &text, const UiFont &font, const Color color, uiLayoutFlags_t layoutFlags=0)
	Constructor for automatically-sized widget. More...
virtual	~BaseText ()
const Color	GetColor () const
const UiFont &	GetFont () const
const std::string &	GetText () const
bool	IsFixedScale () const
	Check if the scaling is fixed (i.e., ignores user text scale config). More...
void	SetColor (const Color color)
void	SetFixedScale (bool fixedScale)
void	SetFont (const UiFont &font)
void	SetText (const std::string &text)
Public Member Functions inherited from HoverRace::Display::UiViewModel
	UiViewModel (uiLayoutFlags_t layoutFlags=0)
virtual	~UiViewModel ()
virtual void	DropFocus ()
	Force this widget to give up focus, if it is currently focused. More...
Vec2	GetAlignedPos (const Vec2 &pos, double w, double h) const
	Retrieve an arbitrary position adjusted by the current alignment. More...
Vec2	GetAlignedPos (double w, double h) const
	Retrieve the position adjusted by the current alignment. More...
Alignment	GetAlignment () const
	Retrieve the alignment of the component. More...
focusRelinquishedSignal_t &	GetFocusRelinquishedSignal ()
focusRequestedSignal_t &	GetFocusRequestedSignal ()
uiLayoutFlags_t	GetLayoutFlags () const
	Retrieve the layout flags. More...
const Vec2 &	GetPos () const
	Get the position of the component. More...
const Vec2 &	GetTranslation () const
	Retrieves the position translation. More...
bool	IsFocused () const
	Check if this widget currently has input focus. More...
uiLayoutFlags_t	IsLayoutFloating () const
uiLayoutFlags_t	IsLayoutUnscaled () const
virtual bool	OnAction ()
virtual bool	OnMouseMoved (const Vec2 &)
virtual bool	OnMousePressed (const Control::Mouse::Click &)
virtual bool	OnMouseReleased (const Control::Mouse::Click &)
virtual bool	OnMouseScrolled (const Control::Mouse::Scroll &)
virtual bool	OnNavigate (const Control::Nav &)
void	RequestFocus ()
	Attempt to hand over the input focus to this widget. More...
void	SetAlignment (Alignment alignment)
	Set the alignment of the component. More...
void	SetPos (const Vec2 &pos)
	Set the position of the component. More...
void	SetPos (double x, double y)
	Convenience function for SetPos(const Vec2&). More...
void	SetTranslation (const Vec2 &translation)
	Sets the position translation. More...
void	SetTranslation (double x, double y)
	Convenience function for SetTranslation(const Vec2&). More...
virtual bool	TryFocus (const Control::Nav &nav=Control::Nav::NEUTRAL)
	Attempts to give this widget focus. More...
Public Member Functions inherited from HoverRace::Display::ViewModel
	ViewModel ()
virtual	~ViewModel ()
virtual void	AttachView (Display &disp)=0
View *	GetView () const
virtual Vec3	Measure ()
	Calculate the size of the component. More...
void	PrepareRender ()
void	Render ()
void	SetView (std::unique_ptr< View > &&view)

Private Types
using	SUPER = UiViewModel

Private Attributes
Color	color
bool	fixedScale
UiFont	font
std::string	text

Additional Inherited Members
Public Types inherited from HoverRace::Display::UiViewModel
enum	Alignment {   Alignment::NW, Alignment::N, Alignment::NE, Alignment::E,   Alignment::SE, Alignment::S, Alignment::SW, Alignment::W,   Alignment::CENTER }
	Imagine the component pinned to the container with a thumbtack. More...
using	focusRelinquishedSignal_t = boost::signals2::signal< void(UiViewModel &, const Control::Nav &)>
using	focusRequestedSignal_t = boost::signals2::signal< void(UiViewModel &)>
Protected Member Functions inherited from HoverRace::Display::UiViewModel
void	RelinquishFocus (const Control::Nav &nav)
	Voluntarily give up input focus, passing it on to the next widget. More...
void	SetFocused (bool focused)
	Set the focused state. More...
Protected Member Functions inherited from HoverRace::Display::ViewModel
template<class T >
void	AttachViewDynamic (Display &disp, T *self)
virtual void	FireModelUpdate (int prop)
	Indicate that a model property has changed. More...
virtual void	Layout ()
	Adjust the size and position of any child elements. More...
void	RequestLayout ()
	Indicate that the current layout is out-of-date and needs to be adjusted. More...

Detailed Description

Base class for widgets that display text.

Author

Michael Imamura

Member Typedef Documentation

using HoverRace::Display::BaseText::SUPER = UiViewModel

private

Constructor & Destructor Documentation

HoverRace::Display::BaseText::BaseText	(	const std::string &	text,
		const UiFont &	font,
		const Color	color,
		uiLayoutFlags_t	layoutFlags = 0
	)

Constructor for automatically-sized widget.

Parameters

text	The text.
font	The font.
color	The text foreground color (including alpha).
layoutFlags	Optional layout flags.

virtual HoverRace::Display::BaseText::~BaseText ( )

inlinevirtual

Member Function Documentation

const Color HoverRace::Display::BaseText::GetColor ( ) const

inline

const UiFont& HoverRace::Display::BaseText::GetFont ( ) const

inline

const std::string& HoverRace::Display::BaseText::GetText ( ) const

inline

bool HoverRace::Display::BaseText::IsFixedScale ( ) const

inline

Check if the scaling is fixed (i.e., ignores user text scale config).

Returns

true if fixed scale, false if not.

void HoverRace::Display::BaseText::SetColor

(

const Color

color

)

void HoverRace::Display::BaseText::SetFixedScale

(

bool

fixedScale

)

void HoverRace::Display::BaseText::SetFont

(

const UiFont &

font

)

void HoverRace::Display::BaseText::SetText

(

const std::string &

text

)

Member Data Documentation

Color HoverRace::Display::BaseText::color

private

bool HoverRace::Display::BaseText::fixedScale

private

UiFont HoverRace::Display::BaseText::font

private

std::string HoverRace::Display::BaseText::text

private

---

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

• BaseText.h
• BaseText.cpp