1. Epic GamesDeveloper
  3. SSpinBox

SSpinBox

A Slate SpinBox resembles traditional spin boxes in that it is a widget that provides keyboard-based and mouse-based manipulation of a numeric value.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSpinBox.h
Include #include "Widgets/Input/SSpinBox.h"

Syntax

template<typename NumericType>  
class SSpinBox : public SCompoundWidget

Remarks

A Slate SpinBox resembles traditional spin boxes in that it is a widget that provides keyboard-based and mouse-based manipulation of a numeric value. Mouse-based manipulation: drag anywhere on the spinbox to change the value. Keyboard-based manipulation: click on the spinbox to enter text mode.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

ApplySliderMaxValueChanged ( float SliderDeltaToAdd,
bool UpdateOnlyIfHigher
)

  
Public function void

ApplySliderMinValueChanged ( float SliderDeltaToAdd,
bool UpdateOnlyIfLower
)

  
Protected function void

CommitValue ( NumericType NewValue,
double NewSpinValue,
ECommitMethod CommitMethod,
ETextCommit::Type OriginalCommitInfo
)

 Call this method when the user's interaction has changed the value
Public function void

Construct ( const FArguments& InArgs
)

 Construct the widget
Protected function void Make the spinbox switch to keyboard-based input mode.
Protected function void Make the spinbox switch to mouse-based input mode.
Protected function Static float

Fraction ( double InValue,
double InMinValue,
double InMaxValue
)

 Calculates range fraction. Possible to use on full numeric range
Public function Const bool See the AlwaysUsesDeltaSnap attribute
Public function Const NumericType See the Delta attribute
Public function Const bool See the EnableSlider attribute
Public function Const int32 See the MaxFractionalDigits attribute
Public function Const NumericType  
Public function Const NumericType See the MaxValue attribute
Public function Const float See the MinDesiredWidth attribute
Public function Const int32 See the MinFractionalDigits attribute
Public function Const NumericType  
Public function Const NumericType See the MinValue attribute
Public function Const float See the SliderExponent attribute
Public function Const NumericType See the Value attribute
Protected function Const FString  
Protected function Const FText  
Public function Const TAttribute< NumericType > Return the Value attribute
Public function Const const FSpinBoxStyle *  
Public function void  
Protected function Const bool  
Public function Const bool See the MaxSliderValue attribute
Public function Const bool See the MinSliderValue attribute
Protected function Const void

NotifyValueCommitted ( NumericType CurrentValue
)

  
Public function void

SetAlwaysUsesDeltaSnap ( bool bNewValue
)

  
Public function void

SetDelta ( NumericType InDelta
)

  
Public function void

SetEnableSlider ( bool bNewValue
)

  
Public function void

SetMaxFractionalDigits ( const TAttribute< TOptional< int32 >>& InMaxFractionalDigits
)

  
Public function void

SetMaxSliderValue ( const TAttribute< TOptional< NumericType >>& InMaxSliderValue
)

  
Public function void

SetMaxValue ( const TAttribute< TOptional< NumericType >>& InMaxValue
)

  
Public function void

SetMinDesiredWidth ( const TAttribute< float >& InMinDesiredWidth
)

  
Public function void

SetMinFractionalDigits ( const TAttribute< TOptional< int32 >>& InMinFractionalDigits
)

  
Public function void

SetMinSliderValue ( const TAttribute< TOptional< NumericType >>& InMinSliderValue
)

  
Public function void

SetMinValue ( const TAttribute< TOptional< NumericType >>& InMinValue
)

  
Public function void

SetSliderExponent ( const TAttribute< float >& InSliderExponent
)

  
Public function void  
Public function void  
Public function void  
Public function void

SetTextSelectAllTextOnCommit ( bool bNewValue
)

  
Public function void

SetValue ( const TAttribute< NumericType >& InValueAttribute
)

  
Public function void

SetWidgetStyle ( const FSpinBoxStyle* InStyle
)

  
Protected function void

TextField_OnTextChanged ( const FText& NewText
)

 Invoked when the text in the text field changes
Protected function void

TextField_OnTextCommitted ( const FText& NewText,
ETextCommit::Type CommitInfo
)

 Invoked when the text field commits its text.

Overridden from SWidget

  Type Name Description
Public function Virtual Const bool Checks to see if this widget currently has the keyboard focus
Public function Virtual Const FCursorReply

OnCursorQuery ( const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
)

 The system asks each widget under the mouse to provide a cursor. This event is bubbled.
Public function Virtual FReply

OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

 KEY INPUT Called when focus is given to this widget. This event does not bubble.
Public function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual FReply

OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual FReply

OnMouseWheel ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Called when the mouse wheel is spun. This event is bubbled.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

  Type Name Description
Public struct FArguments    

Enums

  Type Name Description
Protected enum ECommitMethod How user changed the value in the spinbox  

Typedefs

Name Description
FOnDynamicSliderMinMaxValueChanged Notification when the max/min spinner values are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)
FOnValueChanged Notification for numeric value change
FOnValueCommitted Notification for numeric value committed

Constants

Name Description
DefaultMaxFractionalDigits The default maximum fractional digits
DefaultMinFractionalDigits The default minimum fractional digits

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page