spk::Slider Class Reference

Slider widget for selecting a ratio within [0,1]. More...

#include <spk_slider.hpp>

Inheritance diagram for spk::Slider:

Collaboration diagram for spk::Slider:

Public Member Functions
	Slider (const std::wstring &p_name, spk::Widget *p_parent)
	Builds a slider widget.
void	setThumbSizeRatio (float p_ratio)
	Sets the thumb size ratio relative to the track.
void	setOrientation (spk::Orientation p_orientation)
	Sets the slider orientation.
void	setRatio (float p_ratio)
	Sets the ratio value.
void	adjustRatio (float p_delta)
	Adjusts the ratio by a delta.
float	ratioValue () const
	Returns the ratio value.
float	thumbSizeRatio () const
	Returns the thumb size ratio.
void	setBackgroundTexture (const spk::SpriteSheet *p_spriteSheet)
	Sets the background texture.
void	setBodyTexture (const spk::SpriteSheet *p_spriteSheet)
	Sets the body texture.
void	setBackgroundCornerSize (const spk::Vector2UInt &p_cornerSize)
	Sets the background corner size.
void	setBodyCornerSize (const spk::Vector2UInt &p_cornerSize)
	Sets the body corner size.
spk::ObservableValue< float > &	ratio ()
	Returns the ratio observable.
const spk::ObservableValue< float > &	ratio () const
	Returns the ratio observable.
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 size changes.
void	_onPaintEvent (spk::PaintEvent &p_event) override
	Paints the slider visuals.
void	_onMousePressEvent (spk::MousePressEvent &p_event) override
	Handles mouse press events.
void	_onMouseReleaseEvent (spk::MouseReleaseEvent &p_event) override
	Handles mouse release events.
void	_onMouseMotionEvent (spk::MouseMotionEvent &p_event) override
	Handles mouse motion events.
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	_onMouseDoubleClickEvent (spk::MouseDoubleClickEvent &p_event)
	Mouse double click 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

Slider widget for selecting a ratio within [0,1].

spk::Slider slider(L"Slider", parent);
slider.setRatio(0.5f);

Constructor & Destructor Documentation

Slider()

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

Builds a slider widget.

Parameters

p_name	Widget name.
p_parent	Parent widget.

Here is the call graph for this function:

Member Function Documentation

_onGeometryChange()

void spk::Slider::_onGeometryChange ( )

overrideprotectedvirtual

Updates geometry when size changes.

Reimplemented from spk::Widget.

Here is the call graph for this function:

_onMouseMotionEvent()

void spk::Slider::_onMouseMotionEvent ( spk::MouseMotionEvent & p_event )

overrideprotectedvirtual

Handles mouse motion events.

Parameters

p_event

Mouse motion event payload.

Reimplemented from spk::Widget.

Here is the call graph for this function:

_onMousePressEvent()

void spk::Slider::_onMousePressEvent ( spk::MousePressEvent & p_event )

overrideprotectedvirtual

Handles mouse press events.

Parameters

p_event

Mouse press event payload.

Reimplemented from spk::Widget.

Here is the call graph for this function:

_onMouseReleaseEvent()

void spk::Slider::_onMouseReleaseEvent ( spk::MouseReleaseEvent & p_event )

overrideprotectedvirtual

Handles mouse release events.

Parameters

p_event

Mouse release event payload.

Reimplemented from spk::Widget.

Here is the call graph for this function:

_onPaintEvent()

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

overrideprotectedvirtual

Paints the slider visuals.

Parameters

p_event

Paint event payload.

Reimplemented from spk::Widget.

adjustRatio()

void spk::Slider::adjustRatio

(

float

p_delta

)

Adjusts the ratio by a delta.

Parameters

p_delta

Ratio delta.

Here is the call graph for this function:

ratio() [1/2]

spk::ObservableValue< float > & spk::Slider::ratio

(

)

Returns the ratio observable.

Returns

Mutable ratio observable.

ratio() [2/2]

const spk::ObservableValue< float > & spk::Slider::ratio

(

)

const

Returns the ratio observable.

Returns

Const ratio observable.

ratioValue()

float spk::Slider::ratioValue

(

)

const

Returns the ratio value.

Returns

Ratio value.

setBackgroundCornerSize()

void spk::Slider::setBackgroundCornerSize

(

const spk::Vector2UInt &

p_cornerSize

)

Sets the background corner size.

Parameters

p_cornerSize

Corner size in pixels.

setBackgroundTexture()

void spk::Slider::setBackgroundTexture

(

const spk::SpriteSheet *

p_spriteSheet

)

Sets the background texture.

Parameters

p_spriteSheet

Sprite sheet pointer.

setBodyCornerSize()

void spk::Slider::setBodyCornerSize

(

const spk::Vector2UInt &

p_cornerSize

)

Sets the body corner size.

Parameters

p_cornerSize

Corner size in pixels.

setBodyTexture()

void spk::Slider::setBodyTexture

(

const spk::SpriteSheet *

p_spriteSheet

)

Sets the body texture.

Parameters

p_spriteSheet

Sprite sheet pointer.

setOrientation()

void spk::Slider::setOrientation

(

spk::Orientation

p_orientation

)

Sets the slider orientation.

Parameters

p_orientation

Orientation value.

Here is the call graph for this function:

setRatio()

void spk::Slider::setRatio

(

float

p_ratio

)

Sets the ratio value.

Parameters

p_ratio

Ratio in [0,1].

Here is the caller graph for this function:

setThumbSizeRatio()

void spk::Slider::setThumbSizeRatio

(

float

p_ratio

)

Sets the thumb size ratio relative to the track.

Parameters

p_ratio

Thumb ratio in [0,1].

Here is the call graph for this function:

Here is the caller graph for this function:

thumbSizeRatio()

float spk::Slider::thumbSizeRatio

(

)

const

Returns the thumb size ratio.

Returns

Thumb ratio.

---

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

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