Text display widget with wrapping and background support. More...

#include <spk_text_area.hpp>

Inheritance diagram for spk::TextArea:

Collaboration diagram for spk::TextArea:

Public Member Functions
	TextArea (const std::wstring &p_name, spk::Widget *p_parent)
	Builds a text area widget.
void	setCornerSize (const spk::Vector2UInt &p_cornerSize)
	Sets background corner size.
const spk::Vector2UInt &	cornerSize () const
	Returns background corner size.
void	setTexture (const spk::SpriteSheet *p_spriteSheet)
	Sets the background texture.
const spk::SpriteSheet *	texture () const
	Returns the background texture.
void	setFont (spk::Font *p_font)
	Sets the font used for text rendering.
spk::Font *	font () const
	Returns the font used for text rendering.
void	setFontSize (const spk::Font::Size &p_size)
	Sets the font size used for text rendering.
const spk::Font::Size &	fontSize () const
	Returns the font size used for text rendering.
void	setColors (const spk::Color &p_glyphColor, const spk::Color &p_outlineColor)
	Sets glyph and outline colors.
const spk::Color &	glyphColor () const
	Returns the glyph color.
const spk::Color &	outlineColor () const
	Returns the outline color.
void	setText (const std::wstring &p_text)
	Sets the text content.
const std::wstring &	text () const
	Returns the text content.
void	setMinimalWidth (size_t p_width)
	Sets the minimal width for wrapping.
size_t	minimalWidth () const
	Returns the minimal width for wrapping.
void	setAlignment (spk::HorizontalAlignment p_horizontalAlignment, spk::VerticalAlignment p_verticalAlignment)
	Sets text alignment.
spk::HorizontalAlignment	horizontalAlignment () const
	Returns the horizontal alignment.
spk::VerticalAlignment	verticalAlignment () const
	Returns the 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.

Additional Inherited Members
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.
Static Public Member Functions inherited from spk::Widget
static Widget *	focusedWidget (FocusType p_focusType)
	Retrieves the widget currently owning a focus type.
Static Public Attributes inherited from spk::Widget
static const size_t	NbFocusType = 2
	Number of focus slots tracked at runtime.
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.
virtual void	_onUpdateEvent (spk::UpdateEvent &p_event)
	Frame update handler hook.

Detailed Description

Text display widget with wrapping and background support.

spk::TextArea area(L"Text", parent);

area.setText(L"Hello");

spk::InherenceObject< Widget >::parent

Widget * parent() const

Definition spk_inherence_object.hpp:85

spk::TextArea

Text display widget with wrapping and background support.

Definition spk_text_area.hpp:25

Constructor & Destructor Documentation

◆ TextArea()

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

Builds a text area widget.

Parameters

p_name	Widget name.
p_parent	Parent widget.

Here is the call graph for this function:

Member Function Documentation

◆ cornerSize()

const spk::Vector2UInt & spk::TextArea::cornerSize ( ) const

Returns background corner size.

Returns: Corner size in pixels.

Here is the caller graph for this function:

◆ font()

spk::Font * spk::TextArea::font ( ) const

Returns the font used for text rendering.

Returns: Font pointer.

◆ fontSize()

const spk::Font::Size & spk::TextArea::fontSize ( ) const

Returns the font size used for text rendering.

Returns: Font size.

◆ glyphColor()

const spk::Color & spk::TextArea::glyphColor ( ) const

Returns the glyph color.

Returns: Glyph color.

◆ horizontalAlignment()

spk::HorizontalAlignment spk::TextArea::horizontalAlignment ( ) const

Returns the horizontal alignment.

Returns: Horizontal alignment.

◆ minimalWidth()

size_t spk::TextArea::minimalWidth ( ) const

Returns the minimal width for wrapping.

Returns: Width in pixels.

◆ outlineColor()

const spk::Color & spk::TextArea::outlineColor ( ) const

Returns the outline color.

Returns: Outline color.

◆ setAlignment()

void spk::TextArea::setAlignment	(	spk::HorizontalAlignment	p_horizontalAlignment,
		spk::VerticalAlignment	p_verticalAlignment )

Sets text alignment.

Parameters

p_horizontalAlignment	Horizontal alignment.
p_verticalAlignment	Vertical alignment.

Here is the call graph for this function:

◆ setColors()

void spk::TextArea::setColors	(	const spk::Color &	p_glyphColor,
		const spk::Color &	p_outlineColor )

Sets glyph and outline colors.

Parameters

p_glyphColor	Glyph color.
p_outlineColor	Outline color.

◆ setCornerSize()

void spk::TextArea::setCornerSize ( const spk::Vector2UInt & p_cornerSize )

Sets background corner size.

Parameters

p_cornerSize Corner size in pixels.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFont()

void spk::TextArea::setFont ( spk::Font * p_font )

Sets the font used for text rendering.

Parameters

p_font Font pointer.

Here is the call graph for this function:

◆ setFontSize()

void spk::TextArea::setFontSize ( const spk::Font::Size & p_size )

Sets the font size used for text rendering.

Parameters

p_size Font size.

Here is the call graph for this function:

◆ setMinimalWidth()

void spk::TextArea::setMinimalWidth ( size_t p_width )

Sets the minimal width for wrapping.

Parameters

p_width Minimum width in pixels.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setText()

void spk::TextArea::setText ( const std::wstring & p_text )

Sets the text content.

Parameters

p_text Text string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTexture()

void spk::TextArea::setTexture ( const spk::SpriteSheet * p_spriteSheet )

Sets the background texture.

Parameters

p_spriteSheet Sprite sheet pointer.

Here is the caller graph for this function:

◆ text()

const std::wstring & spk::TextArea::text ( ) const

Returns the text content.

Returns: Text string.

◆ texture()

const spk::SpriteSheet * spk::TextArea::texture ( ) const

Returns the background texture.

Returns: Sprite sheet pointer or nullptr.

◆ verticalAlignment()

spk::VerticalAlignment spk::TextArea::verticalAlignment ( ) const

Returns the vertical alignment.

Returns: Vertical alignment.

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

includes/structure/widget/spk_text_area.hpp
srcs/structure/widget/spk_text_area.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextArea()

Member Function Documentation

◆ cornerSize()

◆ font()

◆ fontSize()

◆ glyphColor()

◆ horizontalAlignment()

◆ minimalWidth()

◆ outlineColor()

◆ setAlignment()

◆ setColors()

◆ setCornerSize()

◆ setFont()

◆ setFontSize()

◆ setMinimalWidth()

◆ setText()

◆ setTexture()

◆ text()

◆ texture()

◆ verticalAlignment()