spk::ScrolableArea< TContent > Class Template Reference

Scrollable container that hosts a content widget. More...

#include <spk_scrollable_area.hpp>

Inheritance diagram for spk::ScrolableArea< TContent >:

Collaboration diagram for spk::ScrolableArea< TContent >:

Public Member Functions
template<typename... TContentArguments>
	ScrolableArea (const std::wstring &p_name, Widget *p_parent, TContentArguments &&...p_contentArgs)
	Builds a scrollable area with the given content arguments.
void	setScrollBarWidth (const size_t p_scrollBarWidth)
	Sets the scrollbar width for both orientations.
size_t	scrollBarWidth () const
	Returns the scrollbar width.
TContent &	content ()
	Returns the content widget.
const TContent &	content () const
	Returns the content widget.
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 when geometry changes.
void	_onMouseWheelEvent (MouseWheelEvent &p_event) override
	Handles mouse wheel scrolling.
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	_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

template<typename TContent>
class spk::ScrolableArea< TContent >

Scrollable container that hosts a content widget.

Template Parameters

TContent

Content widget type.

spk::ScrolableArea<MyContent> area(L"Scroll", parent);
area.setScrollBarWidth(24);

Constructor & Destructor Documentation

ScrolableArea()

template<typename TContent>

template<typename... TContentArguments>

spk::ScrolableArea< TContent >::ScrolableArea ( const std::wstring & p_name, Widget * p_parent, TContentArguments &&... p_contentArgs )

inline

Builds a scrollable area with the given content arguments.

Template Parameters

TContentArguments

Content constructor argument types.

Parameters

p_name	Widget name.
p_parent	Parent widget.
p_contentArgs	Arguments forwarded to the content constructor.

Here is the call graph for this function:

Member Function Documentation

_onGeometryChange()

template<typename TContent>

void spk::ScrolableArea< TContent >::_onGeometryChange ( )

inlineoverrideprotectedvirtual

Updates layout when geometry changes.

Reimplemented from spk::Widget.

_onMouseWheelEvent()

template<typename TContent>

void spk::ScrolableArea< TContent >::_onMouseWheelEvent ( MouseWheelEvent & p_event )

inlineoverrideprotectedvirtual

Handles mouse wheel scrolling.

Parameters

p_event

Mouse wheel event payload.

Reimplemented from spk::Widget.

content() [1/2]

template<typename TContent>

TContent & spk::ScrolableArea< TContent >::content ( )

inline

Returns the content widget.

Returns

Mutable content reference.

content() [2/2]

template<typename TContent>

const TContent & spk::ScrolableArea< TContent >::content ( ) const

inline

Returns the content widget.

Returns

Const content reference.

scrollBarWidth()

template<typename TContent>

size_t spk::ScrolableArea< TContent >::scrollBarWidth ( ) const

inline

Returns the scrollbar width.

Returns

Scrollbar width in pixels.

Here is the caller graph for this function:

setScrollBarWidth()

template<typename TContent>

void spk::ScrolableArea< TContent >::setScrollBarWidth ( const size_t p_scrollBarWidth )

inline

Sets the scrollbar width for both orientations.

Parameters

p_scrollBarWidth

Scrollbar width in pixels.

Here is the call graph for this function:

---

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

• includes/structure/widget/spk_scrollable_area.hpp