💫 SpinBox

A numerical entry box that allows for direct entry of the number or allows the user to click and slide the number.

This class shares methods and events from Base Widget.

🦠 Functions

SetStyleSheet

MySpinBox:SetStyleSheet(SpinBoxStyle)

Type	Parameter	Description
SpinBoxStyle	SpinBoxStyle

GetStyleSheet

— Returns SpinBoxStyle.

local ret = MySpinBox:GetStyleSheet()

---

SetFont

MySpinBox:SetFont(FontName?, Typeface?, FontSize?)

Type	Parameter	Description
string	FontName?
string	Typeface?
integer	FontSize?

GetFont

— Returns table.

local ret = MySpinBox:GetFont()

---

SetTextColor

MySpinBox:SetTextColor(Color)

Type	Parameter	Description
Color	Color

SetLetterSpacing

MySpinBox:SetLetterSpacing(InLetterSpacing)

Type	Parameter	Description
number	InLetterSpacing

GetLetterSpacing

— Returns table.

local ret = MySpinBox:GetFont()

---

SetFontOutlineSettings

MySpinBox:SetLetterSpacing(FontOutlineSettings)

Type	Parameter	Description
FontOutlineSettings	FontOutlineSettings

GetFontOutlineSettings

— Returns FontOutlineSettings.

local ret = MySpinBox:GetFontOutlineSettings()

---

SetJustification

MySpinBox:SetJustification(InJustification)

Type	Parameter	Description
TextJustify	InJustification

GetJustification

— Returns TextJustify.

local ret = MySpinBox:GetJustification()

---

SetSpinBoxValue

MySpinBox:SetSpinBoxValue(NewValue)

Type	Parameter	Description
number	NewValue

GetSpinBoxValue

— Returns number.

local ret = MySpinBox:GetSpinBoxValue()

---

SetMinValue

MySpinBox:SetMinValue(NewMinValue)

Type	Parameter	Description
number	NewMinValue

GetMinValue

— Returns number.

local ret = MySpinBox:GetMinValue()

---

SetMaxValue

MySpinBox:SetMaxValue(NewMaxValue)

Type	Parameter	Description
number	NewMaxValue

GetMaxValue

— Returns number.

local ret = MySpinBox:GetMaxValue()

---

SetSliderMinValue

MySpinBox:SetSliderMinValue(NewMinSliderValue)

Type	Parameter	Description
number	NewMinSliderValue

GetSliderMinValue

— Returns number.

local ret = MySpinBox:GetSliderMinValue()

---

SetSliderMaxValue

MySpinBox:SetSliderMaxValue(NewMaxSliderValue)

Type	Parameter	Description
number	NewMaxSliderValue

GetSliderMaxValue

— Returns number.

local ret = MySpinBox:GetSliderMaxValue()

---

SetMinFractionalDigits

MySpinBox:SetMinFractionaLDigits(MinFractionalDigits)

Type	Parameter	Description
number	MinFractionalDigits

GetMinFractionalDigits

— Returns number.

local ret = MySpinBox:GetMinFractionalDigits()

---

SetMaxFractionalDigits

MySpinBox:SetMaxFractionaLDigits(MaxFractionalDigits)

Type	Parameter	Description
number	MaxFractionalDigits

GetMaxFractionalDigits

— Returns number.

local ret = MySpinBox:GetMaxFractionalDigits()

---

SetAlwaysUsesDeltaSnap

MySpinBox:SetAlwaysUsesDeltaSnap(AlwaysUse)

Type	Parameter	Description
boolean	AlwaysUse

GetAlwaysUseDeltaSnap

— Returns boolean.

local ret = MySpinBox:GetAlwaysUseDeltaSnap()

---

SetIsSliderEnabled

MySpinBox:SetIsSliderEnabled(EnableSlider)

Type	Parameter	Description
boolean	EnableSlider

SetDelta

MySpinBox:SetDelta(NewDelta)

Type	Parameter	Description
number	NewDelta

GetDelta

— Returns number.

local ret = MySpinBox:GetDelta()

🚀 Events

On Value Changed

Triggered when the value is changed interactively by the user

MySpinBox:BindDispatcher("OnValueChanged", function(self, Value)
    -- On Value Changed was called
end)

Type	Parameter	Description
number	Value

---

On Value Committed

Triggered when the value is committed. Occurs when the user presses Enter or the text box loses focus.

MySpinBox:BindDispatcher("OnValueCommitted", function(self, Value, TextCommit)
    -- On Value Committed was called
end)

Type	Parameter	Description
number	Value
TextCommit	TextCommit

---

On Begin Slider Movement

Triggered right before the slider begins to move

MySpinBox:BindDispatcher("OnBeginSliderMovement", function()
    -- On Begin Slider Movement was called
end)

---

On End Slider Movement

Triggered right after the slider is released by the user.

MySpinBox:BindDispatcher("OnEndSliderMovement", function(self, Value)
    -- On End Slider Movement was called
end)

Type	Parameter	Description
number	Value