TGUI
0.9.5
|
Spin button widget. More...
#include <TGUI/Widgets/SpinButton.hpp>
Public Types | |
typedef std::shared_ptr< SpinButton > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const SpinButton > | ConstPtr |
Shared constant widget pointer. | |
Public Types inherited from tgui::ClickableWidget | |
typedef std::shared_ptr< ClickableWidget > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const ClickableWidget > | 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 | |
SpinButton (const char *typeName="SpinButton", bool initRenderer=true) | |
SpinButtonRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const SpinButtonRenderer * | getSharedRenderer () const |
SpinButtonRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const SpinButtonRenderer * | getRenderer () const |
void | setSize (const Layout2d &size) override |
Changes the size of the spin button. | |
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. | |
void | 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 | setVerticalScroll (bool vertical) |
Changes whether the spin button lies horizontally or vertically. | |
bool | getVerticalScroll () const |
Returns whether the spin button lies horizontally or vertically. | |
void | leftMousePressed (Vector2f pos) override |
void | leftMouseReleased (Vector2f pos) override |
void | mouseMoved (Vector2f pos) override |
void | draw (BackendRenderTargetBase &target, RenderStates states) const override |
Draw the widget to a render target. | |
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::ClickableWidget | |
ClickableWidget (const char *typeName="ClickableWidget", bool initRenderer=true) | |
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 | rightMousePressed (Vector2f pos) override |
void | rightMouseReleased (Vector2f pos) override |
void | rightMouseButtonNoLongerDown () override |
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. | |
virtual void | setFocused (bool focused) |
Focus or unfocus the widget. | |
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 void | setTextSize (unsigned int size) |
Changes the character size of text in this widget if it uses text. | |
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 void | setParent (Container *parent) |
virtual bool | updateTime (Duration elapsedTime) |
virtual void | mousePressed (Event::MouseButton button, Vector2f pos) |
virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
virtual void | keyPressed (const Event::KeyEvent &event) |
virtual void | textEntered (char32_t key) |
virtual bool | mouseWheelScrolled (float delta, Vector2f pos) |
virtual void | mouseNoLongerOnWidget () |
virtual void | leftMouseButtonNoLongerDown () |
virtual Widget::Ptr | askToolTip (Vector2f mousePos) |
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 SpinButton::Ptr | create (float minimum=0, float maximum=10) |
Creates a new spin button widget. | |
static SpinButton::Ptr | copy (SpinButton::ConstPtr spinButton) |
Makes a copy of another spin button. | |
Static Public Member Functions inherited from tgui::ClickableWidget | |
static ClickableWidget::Ptr | create (Layout2d size={"100%", "100%"}) |
Creates a new clickable widget. | |
static ClickableWidget::Ptr | copy (ClickableWidget::ConstPtr widget) |
Makes a copy of another clickable widget. | |
Public Attributes | |
SignalFloat | onValueChange = {"ValueChanged"} |
Value of the spin button changed. Optional parameter: new value. | |
Public Attributes inherited from tgui::ClickableWidget | |
SignalVector2f | onMousePress = {"MousePressed"} |
The mouse went down on the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onMouseRelease = {"MouseReleased"} |
The mouse was released on top of the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onClick = {"Clicked"} |
The widget was clicked. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onRightMousePress = {"RightMousePressed"} |
The right mouse button went down on the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onRightMouseRelease = {"RightMouseReleased"} |
The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onRightClick = {"RightClicked"} |
The widget was right clicked. Optional parameter: mouse position relative to widget. | |
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 | |
Signal & | getSignal (String signalName) override |
Retrieves a signal based on its name. | |
void | rendererChanged (const String &property) override |
Function called when one of the properties of the renderer is changed. | |
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. | |
Vector2f | getArrowSize () const |
Widget::Ptr | clone () const override |
Makes a copy of the widget if you don't know its exact type. | |
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. | |
Protected Attributes | |
bool | m_verticalScroll = true |
std::chrono::time_point< std::chrono::steady_clock > | m_PressedAt |
float | m_minimum = 0 |
float | m_maximum = 10 |
float | m_value = 0 |
float | m_step = 1 |
bool | m_mouseHoverOnTopArrow = false |
bool | m_mouseDownOnTopArrow = false |
Sprite | m_spriteArrowUp |
Sprite | m_spriteArrowUpHover |
Sprite | m_spriteArrowDown |
Sprite | m_spriteArrowDownHover |
Borders | m_bordersCached |
Color | m_borderColorCached |
Color | m_backgroundColorCached |
Color | m_backgroundColorHoverCached |
Color | m_arrowColorCached |
Color | m_arrowColorHoverCached |
float | m_borderBetweenArrowsCached = 0 |
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 > > |
Spin button widget.
|
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.
Reimplemented from tgui::ClickableWidget.
|
static |
Makes a copy of another spin button.
spinButton | The other spin button |
|
static |
Creates a new spin button widget.
minimum | The minimum value of the spin button |
maximum | The maximum value of the spin button |
|
overridevirtual |
Draw the widget to a render target.
target | Render target to draw to |
states | Current render states |
Reimplemented from tgui::ClickableWidget.
float tgui::SpinButton::getMaximum | ( | ) | const |
Returns the maximum value.
The default maximum value 10.
float tgui::SpinButton::getMinimum | ( | ) | const |
Returns the minimum value.
The default minimum value 0.
SpinButtonRenderer * tgui::SpinButton::getRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
SpinButtonRenderer * tgui::SpinButton::getSharedRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Retrieves a signal based on its name.
signalName | Name of the signal |
Exception | when the name does not match any signal |
Reimplemented from tgui::ClickableWidget.
float tgui::SpinButton::getStep | ( | ) | const |
Returns the number of positions the thumb advances with each move.
float tgui::SpinButton::getValue | ( | ) | const |
Returns the current value.
The default value is 0.
bool tgui::SpinButton::getVerticalScroll | ( | ) | const |
Returns whether the spin button lies horizontally or vertically.
|
overridevirtual |
Reimplemented from tgui::ClickableWidget.
|
overridevirtual |
Reimplemented from tgui::ClickableWidget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Name of the property that was changed |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
void tgui::SpinButton::setMaximum | ( | float | maximum | ) |
Sets a maximum value.
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.
void tgui::SpinButton::setMinimum | ( | float | minimum | ) |
Sets a minimum value.
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.
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the size of the spin button.
size | The new size of the spin button |
Note that the VerticalScroll property is changed by this function based on the given width and height.
Reimplemented from tgui::Widget.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
void tgui::SpinButton::setStep | ( | float | step | ) |
Changes how much the value changes on each arrow press.
step | The new step size |
void tgui::SpinButton::setValue | ( | float | value | ) |
Changes the current value.
value | The new value |
The value can't be smaller than the minimum or bigger than the maximum. The default value is 0.
void tgui::SpinButton::setVerticalScroll | ( | bool | vertical | ) |
Changes whether the spin button lies horizontally or vertically.
vertical | Should the spin button lie vertically? |
This function will swap the width and height of the spin button if it didn't lie in the wanted direction.