1. Epic GamesDeveloper
  3. FArguments

FArguments

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SSpinBox

   
Name FArguments
Type struct
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSpinBox.h
Include Path #include "Widgets/Input/SSpinBox.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SSpinBox< NumericType > >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FArguments()

   Widgets/Input/SSpinBox.h  

Typedefs

Name Type Remarks Include Path
WidgetArgsType FArguments   Widgets/Input/SSpinBox.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
_ShiftMouseMovePixelPerDelta TAttribute< int32 > How many pixel the mouse must move to change the value of the delta step Widgets/Input/SSpinBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

WidgetArgsType & AlwaysUsesDeltaSnap ( const TAttribute< bool >& InAttribute
)

 Whether typed values should use delta snapping, defaults to false Widgets/Input/SSpinBox.h  

WidgetArgsType & BroadcastValueChangesPerKey ( bool InArg
)

 True to broadcast every time we type Widgets/Input/SSpinBox.h  

WidgetArgsType & ClearKeyboardFocusOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to clear keyboard focus when pressing enter to commit changes Widgets/Input/SSpinBox.h  

WidgetArgsType & ContentPadding ( const TAttribute< FMargin >& InAttribute
)

 Padding to add around this widget and its internal widgets Widgets/Input/SSpinBox.h  

WidgetArgsType & ContextMenuExtender ( const FMenuExtensionDelegate& InDelegate
)

 Menu extender for the right-click context menu Widgets/Input/SSpinBox.h  

WidgetArgsType & CtrlMultiplier ( const TAttribute< float >& InAttribute
)

 Multiplier to use when ctrl is held down Widgets/Input/SSpinBox.h  

WidgetArgsType & Delta ( const TAttribute< NumericType >& InAttribute
)

 Delta to increment the value as the slider moves. If not specified will determine automatically Widgets/Input/SSpinBox.h  

WidgetArgsType & EnableSlider ( const TAttribute< bool >& InAttribute
)

 Whether this spin box should have slider feature enabled, defaults to true Widgets/Input/SSpinBox.h  

WidgetArgsType & EnableWheel ( bool InArg
)

 Whether this spin box should have mouse wheel feature enabled, defaults to true Widgets/Input/SSpinBox.h  

WidgetArgsType & Font ( const TAttribute< FSlateFontInfo >& InAttribute
)

 Font used to display text in the slider Widgets/Input/SSpinBox.h  

WidgetArgsType & Justification ( const TAttribute< ETextJustify::Type >& InAttribute
)

 How should the value be justified in the spinbox. Widgets/Input/SSpinBox.h  

WidgetArgsType & KeyboardType ( const TAttribute< EKeyboardType >& InAttribute
)

 What keyboard to display. Widgets/Input/SSpinBox.h  

WidgetArgsType & LinearDeltaSensitivity ( const TAttribute< int32 >& InAttribute
)

 If we're an unbounded spinbox, what value do we divide mouse movement by before multiplying by Delta. Widgets/Input/SSpinBox.h  

WidgetArgsType & MaxFractionalDigits ( const TAttribute< TOptional< int32 > >& InAttribute
)

 The maximum fractional digits the spin box displays, defaults to 6 Widgets/Input/SSpinBox.h  

WidgetArgsType & MaxSliderValue ( const TAttribute< TOptional< NumericType > >& InAttribute
)

 The maximum value that can be specified by using the slider, defaults to MaxValue Widgets/Input/SSpinBox.h  

WidgetArgsType & MaxValue ( const TAttribute< TOptional< NumericType > >& InAttribute
)

 The maximum value that can be entered into the text edit box Widgets/Input/SSpinBox.h  

WidgetArgsType & MinDesiredWidth ( const TAttribute< float >& InAttribute
)

 Minimum width that a spin box should be Widgets/Input/SSpinBox.h  

WidgetArgsType & MinFractionalDigits ( const TAttribute< TOptional< int32 > >& InAttribute
)

 The minimum fractional digits the spin box displays, defaults to 1 Widgets/Input/SSpinBox.h  

WidgetArgsType & MinSliderValue ( const TAttribute< TOptional< NumericType > >& InAttribute
)

 The minimum value that can be specified by using the slider, defaults to MinValue Widgets/Input/SSpinBox.h  

WidgetArgsType & MinValue ( const TAttribute< TOptional< NumericType > >& InAttribute
)

 The minimum value that can be entered into the text edit box Widgets/Input/SSpinBox.h  

WidgetArgsType & OnBeginSliderMovement ( const FSimpleDelegate& InDelegate
)

 Called right before the slider begins to move Widgets/Input/SSpinBox.h  

WidgetArgsType & OnDynamicSliderMaxValueChanged ( const FOnDynamicSliderMinMaxValueChanged& InDelegate
)

 Called right after the max slider value is changed (only relevant if SupportDynamicSliderMaxValue is true) Widgets/Input/SSpinBox.h  

WidgetArgsType & OnDynamicSliderMinValueChanged ( const FOnDynamicSliderMinMaxValueChanged& InDelegate
)

 Called right after the min slider value is changed (only relevant if SupportDynamicSliderMinValue is true) Widgets/Input/SSpinBox.h  

WidgetArgsType & OnEditEditableText ( const FOnGetDisplayValue& InDelegate
)

 Called to allow customization of what text is edited when entering text mode. Widgets/Input/SSpinBox.h  

WidgetArgsType & OnEndSliderMovement ( const FOnValueChanged& InDelegate
)

 Called right after the slider handle is released by the user Widgets/Input/SSpinBox.h  

WidgetArgsType & OnGetDisplayValue ( const FOnGetDisplayValue& InDelegate
)

 Called to allow customization of what text is displayed when not typing. Widgets/Input/SSpinBox.h  

WidgetArgsType & OnValueChanged ( const FOnValueChanged& InDelegate
)

 Called when the value is changed by slider or typing Widgets/Input/SSpinBox.h  

WidgetArgsType & OnValueCommitted ( const FOnValueCommitted& InDelegate
)

 Called when the value is committed (by pressing enter) Widgets/Input/SSpinBox.h  

WidgetArgsType & PreventThrottling ( bool InArg
)

 If refresh requests for the viewport should happen for all value changes Widgets/Input/SSpinBox.h  

WidgetArgsType & RevertTextOnEscape ( bool InArg
)

 If the text should be reverted when pressing the escape key Widgets/Input/SSpinBox.h  

WidgetArgsType & SelectAllTextOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when pressing enter to commit changes Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta ( TAttribute< int32 > InAttribute
)

   Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta ( TSharedRef< UserClass > InUserObjectRef,
typename TAttribute< int32 >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc,
VarTypes... Vars
)

 Bind attribute with delegate to a shared pointer-based class method. Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta ( UserClass* InUserObject,
typename TAttribute< int32 >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc,
VarTypes... Vars
)

 Bind attribute with delegate to a shared pointer-based class method. Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta_Lambda ( TFunction< int32(void) >&& InFunctor
)

 Bind attribute with delegate to a lambda * technically this works for any functor types, but lambdas are the primary use case Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta_Raw ( UserClass* InUserObject,
typename TAttribute< int32 >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc,
VarTypes... Vars
)

 Bind attribute with delegate to a raw C++ class method Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta_Static ( TIdentity_T< typename TAttribute< int32 >::FGetter::template TFuncPtr< VarTypes... > > InFunc,
VarTypes... Vars
)

 Bind attribute with delegate to a global function * NOTE: We use a template here to avoid 'typename' issues when hosting attributes inside templated classes Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMouseMovePixelPerDelta_UObject ( UserClass* InUserObject,
typename TAttribute< int32 >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc,
VarTypes... Vars
)

 Bind attribute with delegate to a UObject-based class method Widgets/Input/SSpinBox.h  

WidgetArgsType & ShiftMultiplier ( const TAttribute< float >& InAttribute
)

 Multiplier to use when shift is held down Widgets/Input/SSpinBox.h  

WidgetArgsType & SliderExponent ( const TAttribute< float >& InAttribute
)

 Use exponential scale for the slider Widgets/Input/SSpinBox.h  

WidgetArgsType & SliderExponentNeutralValue ( const TAttribute< NumericType >& InAttribute
)

 When use exponential scale for the slider which is the neutral value Widgets/Input/SSpinBox.h  

WidgetArgsType & Style ( const FSpinBoxStyle* InArg
)

 The style used to draw this spinbox Widgets/Input/SSpinBox.h  

WidgetArgsType & SupportDynamicSliderMaxValue ( const TAttribute< bool >& InAttribute
)

 Tell us if we want to support dynamically changing of the max value using alt Widgets/Input/SSpinBox.h  

WidgetArgsType & SupportDynamicSliderMinValue ( const TAttribute< bool >& InAttribute
)

 Tell us if we want to support dynamically changing of the min value using alt Widgets/Input/SSpinBox.h  

WidgetArgsType & TypeInterface ( const TAttribute< TSharedPtr< INumericTypeInterface< NumericType > > >& InAttribute
)

 Provide custom type conversion functionality to this spin box Widgets/Input/SSpinBox.h  

WidgetArgsType & Value ( const TAttribute< NumericType >& InAttribute
)

 The value to display Widgets/Input/SSpinBox.h  

WidgetArgsType & WheelStep ( const TAttribute< TOptional< NumericType > >& InAttribute
)

 Step to increment or decrement the value by when scrolling the mouse wheel. Widgets/Input/SSpinBox.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page