Panel combining a text area with command buttons. More...

#include <spk_prompt_panel.hpp>

Inheritance diagram for spk::PromptPanel:

Collaboration diagram for spk::PromptPanel:

Public Member Functions
	PromptPanel (const std::wstring &p_name, Widget *p_parent)
	Builds a prompt panel widget.
void	setMessage (const std::wstring &p_text)
	Sets the message text.
const std::wstring &	message () const
	Returns the message text.
PushButton &	addButton (const std::wstring &p_name, const std::wstring &p_text)
	Adds a button to the command panel.
PushButton *	button (const std::wstring &p_name)
	Finds a button by name.
void	removeButton (const std::wstring &p_name)
	Removes a button by name.
void	setButtonPadding (size_t p_elementPadding)
	Sets padding between command buttons.
const uint32_t &	buttonPadding () const
	Returns padding between command buttons.
void	setButtonsAlignment (HorizontalAlignment p_alignment)
	Sets button alignment within the command panel.
HorizontalAlignment	buttonsAlignment () const noexcept
	Returns the button alignment.
void	setButtonSizePolicy (Layout::SizePolicy::Value p_policy)
	Sets button size policy.
Layout::SizePolicy::Value	buttonSizePolicy () const noexcept
	Returns the button size policy.
TextArea &	textArea ()
	Returns the text area.
CommandPanel &	commandPanel ()
	Returns the command panel.
void	refreshSizeHints ()
	Refreshes size hints for layout.
void	setBackgroundTexture (const spk::SpriteSheet *p_texture)
	Sets the background texture.
const spk::SpriteSheet *	backgroundTexture () const
	Returns the background texture.
void	setCornerSize (const spk::Vector2UInt &p_cornerSize)
	Sets the background corner size.
const spk::Vector2UInt &	cornerSize () const
	Returns the background corner size.
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.

Protected Member Functions
void	_onGeometryChange () override
	Updates layout geometry when size changes.
void	_onPaintEvent (spk::PaintEvent &p_event) override
	Paints the background.
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.

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.

Detailed Description

Panel combining a text area with command buttons.

See also: CommandPanel

spk::PromptPanel panel(L"Prompt", parent);

panel.setMessage(L"Message");

spk::InherenceObject< Widget >::parent

Widget * parent() const

Definition spk_inherence_object.hpp:85

spk::PromptPanel

Panel combining a text area with command buttons.

Definition spk_prompt_panel.hpp:27

Constructor & Destructor Documentation

◆ PromptPanel()

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

Builds a prompt panel widget.

Parameters

p_name	Widget name.
p_parent	Parent widget.

Here is the call graph for this function:

Member Function Documentation

◆ _onGeometryChange()

void spk::PromptPanel::_onGeometryChange ( )

overrideprotectedvirtual

Updates layout geometry when size changes.

Reimplemented from spk::Widget.

Here is the call graph for this function:

◆ _onPaintEvent()

void spk::PromptPanel::_onPaintEvent ( spk::PaintEvent & p_event )

overrideprotectedvirtual

Paints the background.

Parameters

p_event Paint event payload.

Reimplemented from spk::Widget.

◆ addButton()

PushButton & spk::PromptPanel::addButton	(	const std::wstring &	p_name,
		const std::wstring &	p_text )

Adds a button to the command panel.

Parameters

p_name	Button name.
p_text	Button text.

Returns: Reference to the created button.

Here is the call graph for this function:

◆ backgroundTexture()

const spk::SpriteSheet * spk::PromptPanel::backgroundTexture ( ) const

Returns the background texture.

Returns: Sprite sheet pointer or nullptr.

◆ button()

PushButton * spk::PromptPanel::button ( const std::wstring & p_name )

Finds a button by name.

Parameters

p_name Button name.

Returns: Pointer to the button or nullptr.

Here is the caller graph for this function:

◆ buttonPadding()

const uint32_t & spk::PromptPanel::buttonPadding ( ) const

Returns padding between command buttons.

Returns: Padding value.

◆ buttonsAlignment()

HorizontalAlignment spk::PromptPanel::buttonsAlignment ( ) const

noexcept

Returns the button alignment.

Returns: Alignment value.

◆ buttonSizePolicy()

Layout::SizePolicy::Value spk::PromptPanel::buttonSizePolicy ( ) const

noexcept

Returns the button size policy.

Returns: Size policy value.

◆ commandPanel()

CommandPanel & spk::PromptPanel::commandPanel ( )

Returns the command panel.

Returns: Command panel reference.

Here is the caller graph for this function:

◆ cornerSize()

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

Returns the background corner size.

Returns: Corner size in pixels.

◆ message()

const std::wstring & spk::PromptPanel::message ( ) const

Returns the message text.

Returns: Message string.

◆ removeButton()

void spk::PromptPanel::removeButton ( const std::wstring & p_name )

Removes a button by name.

Parameters

p_name Button name.

Here is the call graph for this function:

◆ setBackgroundTexture()

void spk::PromptPanel::setBackgroundTexture ( const spk::SpriteSheet * p_texture )

Sets the background texture.

Parameters

p_texture Sprite sheet pointer.

Here is the call graph for this function:

◆ setButtonPadding()

void spk::PromptPanel::setButtonPadding ( size_t p_elementPadding )

Sets padding between command buttons.

Parameters

p_elementPadding Padding value.

Here is the call graph for this function:

◆ setButtonsAlignment()

void spk::PromptPanel::setButtonsAlignment ( HorizontalAlignment p_alignment )

Sets button alignment within the command panel.

Parameters

p_alignment Alignment value.

Here is the call graph for this function:

◆ setButtonSizePolicy()

void spk::PromptPanel::setButtonSizePolicy ( Layout::SizePolicy::Value p_policy )

Sets button size policy.

Parameters

p_policy Size policy value.

Here is the call graph for this function:

◆ setCornerSize()

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

Sets the background corner size.

Parameters

p_cornerSize Corner size in pixels.

Here is the call graph for this function:

◆ setMessage()

void spk::PromptPanel::setMessage ( const std::wstring & p_text )

Sets the message text.

Parameters

p_text Message text.

Here is the call graph for this function:

◆ textArea()

TextArea & spk::PromptPanel::textArea ( )

Returns the text area.

Returns: Text area reference.

Here is the caller graph for this function:

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PromptPanel()

Member Function Documentation

◆ _onGeometryChange()

◆ _onPaintEvent()

◆ addButton()

◆ backgroundTexture()

◆ button()

◆ buttonPadding()

◆ buttonsAlignment()

◆ buttonSizePolicy()

◆ commandPanel()

◆ cornerSize()

◆ message()

◆ removeButton()

◆ setBackgroundTexture()

◆ setButtonPadding()

◆ setButtonsAlignment()

◆ setButtonSizePolicy()

◆ setCornerSize()

◆ setMessage()

◆ textArea()