spk::CommandPanel Class Reference

Horizontal panel that manages a collection of command buttons. More...

#include <spk_command_panel.hpp>

Inheritance diagram for spk::CommandPanel:

Collaboration diagram for spk::CommandPanel:

Public Member Functions
	CommandPanel (const std::wstring &p_name, Widget *p_parent)
	Builds a command panel widget.
PushButton &	addButton (const std::wstring &p_name, const std::wstring &p_text)
	Adds a button with a name and display text.
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	setElementPadding (size_t p_elementPadding)
	Sets spacing between buttons.
const uint32_t &	elementPadding () const
	Returns the spacing between buttons.
void	setAlignment (HorizontalAlignment p_alignment)
	Sets the horizontal alignment of the panel.
HorizontalAlignment	alignment () const noexcept
	Returns the current horizontal alignment.
void	setButtonSizePolicy (Layout::SizePolicy::Value p_policy)
	Sets the button size policy.
Layout::SizePolicy::Value	buttonSizePolicy () const noexcept
	Returns the button size policy.
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 geometry when layout changes.
Protected Member Functions inherited from spk::Widget
virtual void	_onPaintEvent (spk::PaintEvent &p_event)
	Paint event hook for derived widgets.
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

Horizontal panel that manages a collection of command buttons.

spk::CommandPanel panel(L"Commands", parent);
panel.addButton(L"Ok", L"OK");

Constructor & Destructor Documentation

CommandPanel()

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

Builds a command 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::CommandPanel::_onGeometryChange ( )

overrideprotectedvirtual

Updates geometry when layout changes.

Reimplemented from spk::Widget.

Here is the call graph for this function:

addButton()

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

Adds a button with a name and display text.

Parameters

p_name	Button identifier.
p_text	Button label.

Returns

Reference to the created button.

Here is the call graph for this function:

Here is the caller graph for this function:

alignment()

HorizontalAlignment spk::CommandPanel::alignment ( ) const

noexcept

Returns the current horizontal alignment.

Returns

Alignment value.

button()

PushButton * spk::CommandPanel::button

(

const std::wstring &

p_name

)

Finds a button by name.

Parameters

p_name

Button identifier.

Returns

Pointer to the button or nullptr.

Here is the caller graph for this function:

buttonSizePolicy()

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

noexcept

Returns the button size policy.

Returns

Size policy value.

elementPadding()

const uint32_t & spk::CommandPanel::elementPadding

(

)

const

Returns the spacing between buttons.

Returns

Padding value.

removeButton()

void spk::CommandPanel::removeButton

(

const std::wstring &

p_name

)

Removes a button by name.

Parameters

p_name

Button identifier.

setAlignment()

void spk::CommandPanel::setAlignment

(

HorizontalAlignment

p_alignment

)

Sets the horizontal alignment of the panel.

Parameters

p_alignment

Alignment value.

Here is the caller graph for this function:

setButtonSizePolicy()

void spk::CommandPanel::setButtonSizePolicy

(

Layout::SizePolicy::Value

p_policy

)

Sets the button size policy.

Parameters

p_policy

Size policy value.

setElementPadding()

void spk::CommandPanel::setElementPadding

(

size_t

p_elementPadding

)

Sets spacing between buttons.

Parameters

p_elementPadding

Padding value.

Here is the call graph for this function:

---

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

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