Spin control widget. More...

#include <TGUI/Widgets/SpinControl.hpp>

Inheritance diagram for tgui::SpinControl:

Public Types
typedef std::shared_ptr< SpinControl >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const SpinControl >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::SubwidgetContainer
typedef std::shared_ptr< SubwidgetContainer >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const SubwidgetContainer >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	SpinControl (const char *typeName="SpinControl", bool initRenderer=true)

SpinButtonRenderer *	getSpinButtonSharedRenderer ()
	Returns the renderer of spin buttons part of widget.

const SpinButtonRenderer *	getSpinButtonSharedRenderer () const

SpinButtonRenderer *	getSpinButtonRenderer ()
	Returns the renderer of spin buttons part of widget.

const SpinButtonRenderer *	getSpinButtonRenderer () const

EditBoxRenderer *	getSpinTextSharedRenderer ()
	Returns the renderer of edit box part of widget.

const EditBoxRenderer *	getSpinTextSharedRenderer () const

EditBoxRenderer *	getSpinTextRenderer ()
	Returns the renderer of edit box part of widget.

const EditBoxRenderer *	getSpinTextRenderer () const

void	setSize (const Layout2d &size) override
	Changes the size of the spin control.

void	setMinimum (float minimum)
	Sets a minimum value.

float	getMinimum () const
	Returns the minimum value.

void	setMaximum (float maximum)
	Sets a maximum value.

float	getMaximum () const
	Returns the maximum value.

bool	setValue (float value)
	Changes the current value.

float	getValue () const
	Returns the current value.

void	setStep (float step)
	Changes how much the value changes on each arrow press.

float	getStep () const
	Returns the number of positions the thumb advances with each move.

void	setDecimalPlaces (unsigned int decimalPlaces)
	Changes the number of decimal places to display.

unsigned int	getDecimalPlaces () const
	Returns the number of decimal places to display.

void	setSize (const Layout2d &size) override
	Changes the size of the widget.

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::SubwidgetContainer
	SubwidgetContainer (const char *typeName, bool initRenderer)

void	setSize (const Layout2d &size) override
	Changes the size of the widget.

void	setFocused (bool focused) override
	Focus or unfocus the widget.

void	setTextSize (unsigned int size) override
	Changes the character size of all subwidgets.

Container *	getContainer ()
	Returns a pointer to the internal container.

const Container *	getContainer () const
	Returns a const pointer to the internal container.

void	leftMousePressed (Vector2f pos) override

void	leftMouseReleased (Vector2f pos) override

void	rightMousePressed (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

void	keyPressed (const Event::KeyEvent &event) override

void	textEntered (char32_t key) override

bool	mouseWheelScrolled (float delta, Vector2f pos) override

void	mouseNoLongerOnWidget () override

void	leftMouseButtonNoLongerDown () override

void	rightMouseButtonNoLongerDown () override

Widget::Ptr	askToolTip (Vector2f mousePos) override

bool	updateTime (Duration elapsedTime) override

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

void	setParent (Container *parent) override

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&)
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getSharedRenderer () const

WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getRenderer () const

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

Vector2f	getSize () const
	Returns the size of the widget.

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the top-left point of the widget instead of the relative position to its parent.

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

bool	isVisible () const
	Returns true when the widget is visible.

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

bool	isEnabled () const
	Returns true when the widget is enabled.

bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

const String &	getWidgetType () const
	Returns the type of the widget.

Container *	getParent () const
	Returns a pointer to the parent widget.

GuiBase *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

void	moveToFront ()
	Places the widget before all other widgets.

void	moveToBack ()
	Places the widget behind all other widgets.

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename T >
T	getUserData () const
	Returns data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

virtual unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

void	setWidgetName (const String &name)
	Changes the name of a widget.

String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

bool	isFocusable () const
	Returns whether a widget could be focused.

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual Signal &	getSignal (String signalName)
	Retrieves a signal based on its name.

virtual void	mousePressed (Event::MouseButton button, Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Static Public Member Functions
static SpinControl::Ptr	create (float min=0.0f, float max=10.0f, float value=0.0f, unsigned int decimal=0, float step=1.0f)
	Creates a new spin button widget.

static SpinControl::Ptr	copy (SpinControl::ConstPtr SpinCtrl)
	Makes a copy of another spin control.

Public Attributes
SignalFloat	onValueChange = {"ValueChanged"}
	Value of the spin control changed. Optional parameter: new value.

Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalShowEffect	onAnimationFinish = {"AnimationFinished"}

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Protected Member Functions
Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.

std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node in order to save it to a file.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

Protected Member Functions inherited from tgui::SubwidgetContainer
std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node in order to save it to a file.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the subwidgets to a render target.

Protected Member Functions inherited from tgui::Widget
virtual void	rendererChanged (const String &property)
	Function called when one of the properties of the renderer is changed.

virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

Protected Attributes
unsigned int	m_decimalPlaces = 0

Protected Attributes inherited from tgui::SubwidgetContainer
CopiedSharedPtr< Group >	m_container

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position

Layout2d	m_size

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true

bool	m_visible = true

Container *	m_parent = nullptr

GuiBase *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

Duration	m_animationTimeElapsed

bool	m_draggableWidget = false

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::shared_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

Additional Inherited Members
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >

using	LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >

Detailed Description

Spin control widget.

Member Function Documentation

◆ clone()

Widget::Ptr tgui::SpinControl::clone ( ) const

inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns: Copy of the widget

Implements tgui::Widget.

◆ copy()

static SpinControl::Ptr tgui::SpinControl::copy ( SpinControl::ConstPtr SpinCtrl )

static

Makes a copy of another spin control.

Parameters

SpinCtrl The other spin control

Returns: The new spin control

◆ create()

static SpinControl::Ptr tgui::SpinControl::create	(	float	min = `0.0f`,
		float	max = `10.0f`,
		float	value = `0.0f`,
		unsigned int	decimal = `0`,
		float	step = `1.0f`
	)

static

Creates a new spin button widget.

Parameters

min	The minimum value of the spin control
max	The maximum value of the spin control
value	Initial value
decimal	Number of decimal places to display
step	Increment value

Returns: The new spin control

◆ getDecimalPlaces()

unsigned int tgui::SpinControl::getDecimalPlaces ( ) const

Returns the number of decimal places to display.

Returns: The current number of decimal places

See also: setDecimalPlaces

The default value is 0, which means that the value has to be an integer.

◆ getMaximum()

float tgui::SpinControl::getMaximum ( ) const

Returns the maximum value.

Returns: The current maximum value

The default maximum value 10.

◆ getMinimum()

float tgui::SpinControl::getMinimum ( ) const

Returns the minimum value.

Returns: The current minimum value

The default minimum value 0.

◆ getSpinButtonRenderer()

SpinButtonRenderer * tgui::SpinControl::getSpinButtonRenderer ( )

Returns the renderer of spin buttons part of widget.

Returns: Temporary pointer to the renderer

Warning: After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSpinButtonSharedRenderer()

SpinButtonRenderer * tgui::SpinControl::getSpinButtonSharedRenderer ( )

Returns the renderer of spin buttons part of widget.

Returns: Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSpinTextRenderer()

EditBoxRenderer * tgui::SpinControl::getSpinTextRenderer ( )

Returns the renderer of edit box part of widget.

Returns: Temporary pointer to the renderer

Warning: After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSpinTextSharedRenderer()

EditBoxRenderer * tgui::SpinControl::getSpinTextSharedRenderer ( )

Returns the renderer of edit box part of widget.

Returns: Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getStep()

float tgui::SpinControl::getStep ( ) const

Returns the number of positions the thumb advances with each move.

Returns: The current step size

See also: setStep

The default value is 1.0.

◆ getValue()

float tgui::SpinControl::getValue ( ) const

Returns the current value.

Returns: The current value

The default value is 0.

◆ load()

void tgui::SpinControl::load	(	const std::unique_ptr< DataIO::Node > &	node,
		const LoadingRenderersMap &	renderers
	)

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ save()

std::unique_ptr< DataIO::Node > tgui::SpinControl::save ( SavingRenderersMap & renderers ) const

overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ setDecimalPlaces()

void tgui::SpinControl::setDecimalPlaces ( unsigned int decimalPlaces )

Changes the number of decimal places to display.

Parameters

decimalPlaces The new number of decimal places

The default value is 0, which means that the value has to be an integer.

◆ setMaximum()

void tgui::SpinControl::setMaximum ( float maximum )

Sets a maximum value.

Parameters

maximum The new maximum value

When the value is too big then it will be changed to this maximum. The default maximum value is 10.

◆ setMinimum()

void tgui::SpinControl::setMinimum ( float minimum )

Sets a minimum value.

Parameters

minimum The new minimum value

When the value is too small then it will be changed to this minimum. The default minimum value is 0.

◆ setSize() [1/4]

virtual void tgui::Widget::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize() [2/4]

void tgui::SpinControl::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the spin control.

Parameters

size	The new size of the spin control

Reimplemented from tgui::Widget.

◆ setSize() [3/4]

void tgui::SubwidgetContainer::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the widget.

Parameters

size	The new size of the widget

Reimplemented from tgui::Widget.

◆ setSize() [4/4]

void tgui::Widget::setSize	(	Layout	width,
		Layout	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setStep()

void tgui::SpinControl::setStep ( float step )

Changes how much the value changes on each arrow press.

Parameters

step	The new step size

Precondition: The step size must be a positive value or 0.

◆ setValue()

bool tgui::SpinControl::setValue ( float value )

Changes the current value.

Parameters

value The new value

Returns: Was the value actually set

The value can't be smaller than the minimum or bigger than the maximum. The default value is 0.

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

include/TGUI/Widgets/SpinControl.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ getDecimalPlaces()

◆ getMaximum()

◆ getMinimum()

◆ getSpinButtonRenderer()

◆ getSpinButtonSharedRenderer()

◆ getSpinTextRenderer()

◆ getSpinTextSharedRenderer()

◆ getStep()

◆ getValue()

◆ load()

◆ save()

◆ setDecimalPlaces()

◆ setMaximum()

◆ setMinimum()

◆ setSize() [1/4]

◆ setSize() [2/4]

◆ setSize() [3/4]

◆ setSize() [4/4]

◆ setStep()

◆ setValue()