TGUI  0.9-beta

Spin control widget. More...

#include <TGUI/Widgets/SpinControl.hpp>

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

Public Types

typedef std::shared_ptr< SpinControlPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const SpinControlConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::SubwidgetContainer
typedef std::shared_ptr< SubwidgetContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const SubwidgetContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

SpinButtonRenderergetSpinButtonSharedRenderer ()
 Returns the renderer of spin buttons part of widget. More...
 
SpinButtonRenderergetSpinButtonRenderer ()
 Returns the renderer of spin buttons part of widget. More...
 
EditBoxRenderergetSpinTextSharedRenderer ()
 Returns the renderer of edit box part of widget. More...
 
EditBoxRenderergetSpinTextRenderer ()
 Returns the renderer of edit box part of widget. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the spin control. More...
 
void setMinimum (float minimum)
 Sets a minimum value. More...
 
float getMinimum () const
 Returns the minimum value. More...
 
void setMaximum (float maximum)
 Sets a maximum value. More...
 
float getMaximum () const
 Returns the maximum value. More...
 
bool setValue (float value)
 Changes the current value. More...
 
float getValue () const
 Returns the current value. More...
 
void setStep (float step)
 Changes how much the value changes on each arrow press. More...
 
float getStep () const
 Returns the number of positions the thumb advances with each move. More...
 
void setDecimalPlaces (unsigned decimalPlaces)
 Changes the number of decimal places to display. More...
 
unsigned getDecimalPlaces () const
 Returns the number of decimal places to display. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::SubwidgetContainer
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
ContainergetContainer ()
 Returns a pointer to the internal container. More...
 
const ContainergetContainer () const
 Returns a const pointer to the internal container. More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
GuiBasegetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
virtual void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
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 decimal=0, float step=1.0f)
 Creates a new spin button widget. More...
 
static SpinControl::Ptr copy (SpinControl::ConstPtr SpinCtrl)
 Makes a copy of another spin control. More...
 

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.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 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. More...
 
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 draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the subwidgets to a render target. More...
 
- 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. More...
 
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.
 

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

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

◆ setDecimalPlaces()

void tgui::SpinControl::setDecimalPlaces ( unsigned  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/4]

virtual void tgui::Widget::setSize

Changes the size of the widget.

Parameters
sizeSize 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});

◆ setSize() [2/4]

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::SubwidgetContainer.

◆ setSize() [3/4]

void tgui::SubwidgetContainer::setSize
override

Changes the size of the widget.

Parameters
sizeThe new size of the widget

◆ setSize() [4/4]

void tgui::Widget::setSize
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.

◆ 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:
TGUI_API Layout bindHeight(GuiBase &gui)
Bind to the height of the gui view.