TGUI  1.3.0
Loading...
Searching...
No Matches

Spin control widget. More...

#include <TGUI/Widgets/SpinControl.hpp>

Inheritance diagram for tgui::SpinControl:
tgui::SubwidgetContainer tgui::Widget

Public Types

using Ptr = std::shared_ptr<SpinControl>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const SpinControl>
 Shared constant widget pointer.
 
- Public Types inherited from tgui::SubwidgetContainer
using Ptr = std::shared_ptr<SubwidgetContainer>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const SubwidgetContainer>
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
using Ptr = std::shared_ptr<Widget>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const Widget>
 Shared constant widget pointer.
 

Public Member Functions

 SpinControl (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
 SpinControl (const SpinControl &copy)
 Copy constructor.
 
 SpinControl (SpinControl &&copy) noexcept
 Move constructor.
 
SpinControloperator= (const SpinControl &right)
 Overload of copy assignment operator.
 
SpinControloperator= (SpinControl &&right) noexcept
 Overload of move assignment operator.
 
TGUI_NODISCARD SpinButtonRenderergetSpinButtonSharedRenderer ()
 Returns the renderer of spin buttons part of widget.
 
TGUI_NODISCARD const SpinButtonRenderergetSpinButtonSharedRenderer () const
 
TGUI_NODISCARD SpinButtonRenderergetSpinButtonRenderer ()
 Returns the renderer of spin buttons part of widget.
 
TGUI_NODISCARD EditBoxRenderergetSpinTextSharedRenderer ()
 Returns the renderer of edit box part of widget.
 
TGUI_NODISCARD const EditBoxRenderergetSpinTextSharedRenderer () const
 
TGUI_NODISCARD EditBoxRenderergetSpinTextRenderer ()
 Returns the renderer of edit box part of widget.
 
void setSize (const Layout2d &size) override
 Changes the size of the spin control.
 
void setMinimum (float minimum)
 Sets a minimum value.
 
TGUI_NODISCARD float getMinimum () const
 Returns the minimum value.
 
void setMaximum (float maximum)
 Sets a maximum value.
 
TGUI_NODISCARD float getMaximum () const
 Returns the maximum value.
 
bool setValue (float value)
 Changes the current value.
 
TGUI_NODISCARD float getValue () const
 Returns the current value.
 
void setStep (float step)
 Changes how much the value changes on each arrow press.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD unsigned int getDecimalPlaces () const
 Returns the number of decimal places to display.
 
void setUseWideArrows (bool useWideArrows)
 Changes whether the spin button width equals the heigh or the widget or only half of the height (default)
 
TGUI_NODISCARD bool getUseWideArrows () const
 Returns whether the spin button width equals the heigh or the widget or only half of the height (default)
 
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 setEnabled (bool enabled) override
 Enables or disables the widget.
 
TGUI_NODISCARD ContainergetContainer ()
 Returns a pointer to the internal container.
 
TGUI_NODISCARD const ContainergetContainer () const
 Returns a const pointer to the internal container.
 
bool leftMousePressed (Vector2f pos) override
 Called by the parent when the left mouse button goes down on top of the widget.
 
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 scrolled (float delta, Vector2f pos, bool touch) override
 Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void rightMouseButtonNoLongerDown () override
 
TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos) override
 
bool updateTime (Duration elapsedTime) override
 
TGUI_NODISCARD 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
 
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 &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks.
 
virtual TGUI_NODISCARD WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
virtual TGUI_NODISCARD const WidgetRenderergetSharedRenderer () const
 
virtual TGUI_NODISCARD WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 Sets how the position is determined compared to the other widgets in the parent.
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 Returns how the position is determined compared to the other widgets in the parent.
 
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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD 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.
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration.
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD 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 DataType >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD bool hasUserData () const
 Returns whether 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.
 
TGUI_NODISCARD const FontgetInheritedFont () 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.
 
TGUI_NODISCARD float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD bool isFocusable () const
 Returns whether a widget could be focused.
 
void setNavigationUp (const Widget::Ptr &widgetAbove)
 Changes which widget should become focused when navigating upwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationUp () const
 Returns which widget would become focused when navigating upwards from this widget.
 
void setNavigationDown (const Widget::Ptr &widgetBelow)
 Changes which widget should become focused when navigating downwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationDown () const
 Returns which widget would become focused when navigating downwards from this widget.
 
void setNavigationLeft (const Widget::Ptr &widgetLeft)
 Changes which widget should become focused when navigating to the left from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationLeft () const
 Returns which widget would become focused when navigating to the left from this widget.
 
void setNavigationRight (const Widget::Ptr &widgetRight)
 Changes which widget should become focused when navigating to the right from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void setIgnoreMouseEvents (bool ignore)
 Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
 
TGUI_NODISCARD bool getIgnoreMouseEvents () const
 Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual bool canHandleKeyPress (const Event::KeyEvent &event)
 Called by the parent of the widget to check if keyPressed would process the event.
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static TGUI_NODISCARD 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 TGUI_NODISCARD SpinControl::Ptr copy (const 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 onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "SpinControl"
 Type name of the widget.
 

Protected Member Functions

TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
TGUI_NODISCARD Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type.
 
TGUI_NODISCARD 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
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
TGUI_NODISCARD 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 updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer)
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the subwidgets to a render target.
 
- Protected Member Functions inherited from tgui::Widget
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.
 
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

unsigned int m_decimalPlaces = 0
 
bool m_useWideArrows = false
 
- Protected Attributes inherited from tgui::SubwidgetContainer
CopiedSharedPtr< Groupm_container
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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
 Stores the flag indicating whether this widget is enabled.
 
bool m_visible = true
 Stores the flag indicating whether this widget is visible.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::unique_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
AutoLayout m_autoLayout = AutoLayout::Manual
 
bool m_autoLayoutUpdateEnabled = true
 
bool m_ignoreMouseEvents = false
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

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()

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

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 TGUI_NODISCARD SpinControl::Ptr tgui::SpinControl::copy ( const SpinControl::ConstPtr & SpinCtrl)
static

Makes a copy of another spin control.

Parameters
SpinCtrlThe other spin control
Returns
The new spin control

◆ create()

static TGUI_NODISCARD 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
minThe minimum value of the spin control
maxThe maximum value of the spin control
valueInitial value
decimalNumber of decimal places to display
stepIncrement value
Returns
The new spin control

◆ getDecimalPlaces()

TGUI_NODISCARD 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()

TGUI_NODISCARD float tgui::SpinControl::getMaximum ( ) const

Returns the maximum value.

Returns
The current maximum value

The default maximum value 10.

◆ getMinimum()

TGUI_NODISCARD float tgui::SpinControl::getMinimum ( ) const

Returns the minimum value.

Returns
The current minimum value

The default minimum value 0.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::SpinControl::getSignal ( String signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getSpinButtonRenderer()

TGUI_NODISCARD 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()

TGUI_NODISCARD 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()

TGUI_NODISCARD 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()

TGUI_NODISCARD 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()

TGUI_NODISCARD 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.

◆ getUseWideArrows()

TGUI_NODISCARD bool tgui::SpinControl::getUseWideArrows ( ) const

Returns whether the spin button width equals the heigh or the widget or only half of the height (default)

Returns
Does the width of the spin button equal its height instead of half the height?

◆ getValue()

TGUI_NODISCARD 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()

TGUI_NODISCARD 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
decimalPlacesThe 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
maximumThe 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
minimumThe 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/2]

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

Changes the size of the spin control.

Parameters
sizeThe new size of the spin control

Reimplemented from tgui::Widget.

◆ setSize() [2/2]

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

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight 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
stepThe new step size
Precondition
The step size must be a positive value or 0.

◆ setUseWideArrows()

void tgui::SpinControl::setUseWideArrows ( bool useWideArrows)

Changes whether the spin button width equals the heigh or the widget or only half of the height (default)

Parameters
useWideArrowsShould the width of the spin button equal its height instead of half the height?

◆ setValue()

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

Changes the current value.

Parameters
valueThe 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: