spk::DynamicTextLabel Class Reference

Text label that refreshes its content periodically. More...

#include <spk_dynamic_text_label.hpp>

Inheritance diagram for spk::DynamicTextLabel:

Collaboration diagram for spk::DynamicTextLabel:

Public Types
using	TextProducer = std::function<std::wstring()>
	Function type used to generate label text.
Public Types inherited from spk::Widget
enum class	FocusType { Keyboard = 0 , Mouse = 1 }
	Types of focus a widget can own.
Public Types inherited from spk::ActivableObject
using	Contract = StatefulObject<ActivationStatus>::Contract
	Subscription handle controlling callback lifetime.
using	Job = StatefulObject<ActivationStatus>::Job
	Callback signature executed on activation state changes.
Public Types inherited from spk::StatefulObject< ActivationStatus >
using	Contract
	Handle allowing subscribers to manage callback lifetimes.
using	Job
	Callable invoked when the object transitions to a state.

Public Member Functions
	DynamicTextLabel (const std::wstring &p_name, spk::Widget *p_parent)
	Builds a dynamic text label.
void	setTextProducer (const TextProducer &p_textProducer)
	Sets the text producer callback.
void	setRefreshDuration (const spk::Duration &p_refreshDuration)
	Sets the refresh duration.
void	refresh ()
	Immediately refreshes the label text.
Public Member Functions inherited from spk::TextLabel
	TextLabel (const std::wstring &p_name, spk::Widget *p_parent)
	Creates a text label widget.
void	setCornerSize (const spk::Vector2UInt &p_cornerSize)
	Sets the corner size for the nine-slice background.
const spk::Vector2UInt &	cornerSize () const
	Returns the current corner size for the background.
void	setTexture (const spk::SpriteSheet *p_spriteSheet)
	Assigns the sprite sheet used for the background.
const spk::SpriteSheet *	texture () const
	Returns the sprite sheet used for the background.
void	setFont (spk::Font *p_font)
	Sets the font used for the label text.
spk::Font *	font () const
	Returns the font used for the label text.
void	setFontSize (const spk::Font::Size &p_size)
	Sets the font size for the label text.
const spk::Font::Size &	fontSize () const
	Returns the current font size for the label text.
void	setColors (const spk::Color &p_glyphColor, const spk::Color &p_outlineColor)
	Sets the glyph and outline colors for the label text.
const spk::Color &	glyphColor () const
	Returns the current glyph color.
const spk::Color &	outlineColor () const
	Returns the current outline color.
void	setText (const std::wstring &p_text)
	Updates the label text.
const std::wstring &	text () const
	Returns the current label text.
void	setAlignment (HorizontalAlignment p_horizontalAlignment, VerticalAlignment p_verticalAlignment)
	Sets the horizontal and vertical alignment for the text.
HorizontalAlignment	horizontalAlignment () const
	Returns the current horizontal alignment.
VerticalAlignment	verticalAlignment () const
	Returns the current vertical alignment.
Public Member Functions inherited from spk::Widget
void	takeFocus (FocusType p_focusType)
	Grants this widget ownership of the requested focus type.
void	releaseFocus (FocusType p_focusType)
	Releases a previously acquired focus type.
bool	hasFocus (FocusType p_focusType) const
	Checks if this widget currently owns a focus type.
void	takeAllFocus ()
	Acquires both keyboard and mouse focus.
void	releaseAllFocus ()
	Releases both keyboard and mouse focus types.
	Widget (const std::wstring &p_name, Widget *p_parent)
	Builds a widget optionally attached to a parent.
void	addChild (Widget *p_child) override
	Adds a child widget and sorts the hierarchy by layer.
const float &	layer () const
	Current rendering layer of the widget.
void	setLayer (const float &p_newLayer)
	Updates the widget layer and propagates relative offsets to children.
const std::wstring &	name () const
	Retrieves the widget name.
void	setName (const std::wstring &p_name)
	Sets the widget name.
void	setGeometry (const spk::Extend2D &p_geometry) override
	Requests a specific viewport and scissor region for the widget.
const spk::Extend2D &	geometry () const
	Returns the current widget geometry.
const spk::OpenGL::ViewRegion &	viewRegion () const
	Accesses the computed view region.
const spk::OpenGL::FrameBufferObject &	frameBufferObject () const
	Returns the frame buffer object used for widget rendering.
const spk::OpenGL::FrameBufferObject &	fbo () const
	Alias for frameBufferObject().
void	requireGeometryChange ()
	Marks the widget view region as needing recomputation.
Public Member Functions inherited from spk::InherenceObject< Widget >
virtual void	removeChild (Widget *p_child)
	Removes a child from this node.
Widget *	parent () const
	Returns the parent pointer.
virtual std::vector< Widget * > &	children ()
	Returns the children vector.
void	clearChildren ()
	Clears the children list and resets each child's parent pointer.
Public Member Functions inherited from spk::ActivableObject
	ActivableObject ()
	Builds a deactivated object.
	ActivableObject (ActivationStatus p_initial)
	Builds with a custom initial activation state.
void	activate ()
	Sets the state to Activated.
void	deactivate ()
	Sets the state to Deactivated.
void	toggle ()
	Toggles between activated and deactivated states.
bool	isActive () const
	Checks whether the object is currently activated.
Contract	addActivationCallback (const Job &p_callback)
	Registers a callback executed when the object activates.
Contract	addDeactivationCallback (const Job &p_callback)
	Registers a callback executed when the object deactivates.
Public Member Functions inherited from spk::StatefulObject< ActivationStatus >
	StatefulObject (const ActivationStatus &p_initialState)
	Builds with an initial state.
StatefulObject &	operator= (const StatefulObject &p_other)=delete
void	setState (const ActivationStatus &p_newState)
	Sets a new state and triggers callbacks registered for it.
ActivationStatus	state () const
	Returns the current state.
Contract	addCallback (const ActivationStatus &p_state, const Job &p_callback)
	Subscribes a callback for a specific state.
Public Member Functions inherited from spk::ResizableElement
SizeHint &	sizeHint ()
	Returns mutable size hint data.
const SizeHint &	sizeHint () const
	Returns const size hint data.

Static Public Attributes
static const spk::Duration	DefaultDuration = 1000_ms
	Default refresh duration.
Static Public Attributes inherited from spk::Widget
static const size_t	NbFocusType = 2
	Number of focus slots tracked at runtime.

Protected Member Functions
void	_onUpdateEvent (spk::UpdateEvent &p_event) override
	Updates the label when the refresh timer ticks.
Protected Member Functions inherited from spk::TextLabel
void	_onGeometryChange () override
	Updates background and text geometry when the widget size changes.
void	_onPaintEvent (spk::PaintEvent &p_event) override
	Paints the background and text regions.
Protected Member Functions inherited from spk::Widget
virtual void	_onKeyPressEvent (spk::KeyPressEvent &p_event)
	Keyboard press handler for derived widgets.
virtual void	_onKeyReleaseEvent (spk::KeyReleaseEvent &p_event)
	Keyboard release handler for derived widgets.
virtual void	_onGlyphEvent (spk::GlyphEvent &p_event)
	Text glyph input handler for derived widgets.
virtual void	_onMousePressEvent (spk::MousePressEvent &p_event)
	Mouse button press handler for derived widgets.
virtual void	_onMouseReleaseEvent (spk::MouseReleaseEvent &p_event)
	Mouse button release handler for derived widgets.
virtual void	_onMouseDoubleClickEvent (spk::MouseDoubleClickEvent &p_event)
	Mouse double click handler for derived widgets.
virtual void	_onMouseMotionEvent (spk::MouseMotionEvent &p_event)
	Mouse motion handler for derived widgets.
virtual void	_onMouseWheelEvent (spk::MouseWheelEvent &p_event)
	Mouse wheel handler for derived widgets.
virtual void	_onEnterResizeModeEvent (spk::EnterResizeModeEvent &p_event)
	Callback for entering resize mode.
virtual void	_onResizeEvent (spk::ResizeEvent &p_event)
	Resize handling hook.
virtual void	_onExitResizeModeEvent (spk::ExitResizeModeEvent &p_event)
	Callback invoked when leaving resize mode.
virtual void	_onQuitEvent (spk::QuitEvent &p_event)
	Quit event handler hook.
virtual void	_onMoveEvent (spk::MoveEvent &p_event)
	Window move handler hook.
virtual void	_onFullScreenModeEvent (spk::FullScreenModeEvent &p_event)
	Full screen toggle handler hook.
virtual void	_onMaximizedModeEvent (spk::MaximizedModeEvent &p_event)
	Maximized mode change handler.
virtual void	_onFocusEvent (spk::FocusEvent &p_event)
	Focus change handler hook.

Additional Inherited Members
Static Public Member Functions inherited from spk::Widget
static Widget *	focusedWidget (FocusType p_focusType)
	Retrieves the widget currently owning a focus type.

Detailed Description

Text label that refreshes its content periodically.

See also

TextLabel

spk::DynamicTextLabel label(L"Clock", parent);
label.setTextProducer([] { return L"Now"; });

Constructor & Destructor Documentation

DynamicTextLabel()

spk::DynamicTextLabel::DynamicTextLabel	(	const std::wstring &	p_name,
		spk::Widget *	p_parent )

Builds a dynamic text label.

Parameters

p_name	Widget name.
p_parent	Parent widget.

Here is the call graph for this function:

Member Function Documentation

_onUpdateEvent()

void spk::DynamicTextLabel::_onUpdateEvent ( spk::UpdateEvent & p_event )

overrideprotectedvirtual

Updates the label when the refresh timer ticks.

Parameters

p_event

Update event payload.

Reimplemented from spk::Widget.

Here is the call graph for this function:

setRefreshDuration()

void spk::DynamicTextLabel::setRefreshDuration

(

const spk::Duration &

p_refreshDuration

)

Sets the refresh duration.

Parameters

p_refreshDuration

Duration between refreshes.

setTextProducer()

void spk::DynamicTextLabel::setTextProducer

(

const TextProducer &

p_textProducer

)

Sets the text producer callback.

Parameters

p_textProducer

Callback that returns text.

---

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

• includes/structure/widget/spk_dynamic_text_label.hpp
• srcs/structure/widget/spk_dynamic_text_label.cpp