→ index of namespace ui

→ index of project ui

→ index of module MSlider

Class `MSlider.ui::Slider`

Synopsis:

Base classes:

MControl.ui::Control

Functions:

GetDefaultKnobSize() : float -
GetMinHeight() : int -
GetMinWidth() : int -
New(float min, max, value, step) : ui::Slider -
NewVertical(float min, max, value, step) : ui::Slider -

Methods:

beginXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int -
calcSizeX() : float -
calcSizeY() : float -
cancelSliderTimer() -
consumeAction(ui::Action action) : int -
continueGrabAtNewMousePosition() -
decCoarse() : int - Subtract step_coarse from current slider value
decFine() : int -
getBorderSize() -
getKnobSize() : float - Query the size of the slider knob
getMaxValue() : float - Query the maximum slider position
getMinValue() : float - Query the minimum slider position
getMoveDirection() : int - Return direction of last slider movement, -1=up/left, 0=none, 1=right/down
getProvidedActionNames() : StringArray -
getStepCoarse() : float - Query the default position change inc/dec size.
getValue() : float -
grabMouse() -
handleMouseClickOrPress() -
handleResetValue() : int -
handleValueChanged() -
handleValueChanging() -
incCoarse() : int - Add step_coarse to current slider value
incFine() : int -
initSlider(float min, max, value, step) -
isFlipped() : int -
isKnobSizeAdaptive() : int -
isMouseFocusLocked() : int -
isTabCycleMember() : int -
isVertical() : int - Query orientation of the slider; true=vertical, false=horizontal
onDraw() -
onKey(Key k) : int -
onKeyboardFocusLost(int bQuiet) -
onMouse(ui::MouseEvent ev) : int -
onMouseBeginDrag(ui::MouseEvent dragStart, ev) : int -
onMouseCancelDrag(ui::MouseEvent ev) -
onMouseClick(ui::MouseEvent ev) : int -
onMouseDoubleClick(ui::MouseEvent ev) : int -
onMouseDrag(ui::MouseEvent lastEv, currentEv) : int -
onMouseEnter(ui::MouseEvent ev) : int -
onMouseHold(ui::MouseEvent ev) : int -
onMouseKey(Key k) : int -
onMouseLeave(ui::MouseEvent ev) : int -
onTabFocus() -
quantizeValue(float value) : float -
recalcKnobSize() -
setBorderSize(int bs) -
setCustomMinSize(float w, h) -
setEnableAdaptiveKnobSize(int b) -
setEnableBlendReplaceAlpha(int bEnable) -
setEnableDetailEdit(int bEnable) -
setFlip(int b) -
setKnobSize(float size) - Set the size of the slider knob (in pixels)
setLayerStyle(int style) -
setMaxValue(float max) - Set the maximum slider position
setMinMaxValues(float min, max) -
setMinValue(float min) - Set the minimum slider position
setRange(float min, max) -
setRelativeKnobSize(float visible) - Set the size of the slider knob (visible range of values)
setResetValue(float reset) -
setResetValues(FloatArray fa) -
setStepCoarse(float val) - Set the default position change inc/dec size.
setValue(float value) -
setValueGrabbed(float value) -
setVertical(int b) - Enable vertical orientation instead of horizontal (default)
showDetailEdit() -
ungrabMouse() -
validateValue() -
wantOnMouseClickAfterOnMouseWasHandled() : int -

Constants:

Function GetDefaultKnobSize

Signature

GetDefaultKnobSize

(

)

float

Returns

float

–

→ top of page

Function GetMinHeight

Signature

GetMinHeight

(

)

int

Returns

int

–

→ top of page

Function GetMinWidth

Signature

GetMinWidth

(

)

int

Returns

int

–

→ top of page

Function New

Signature

New	(	float	min	,
		float	max	,
		float	value	,
		float	step
		)
	:	ui::Slider

Arguments

float	min	–
float	max	–
float	value	–
float	step	–

Returns

ui::Slider

–

→ top of page

Function NewVertical

Signature

NewVertical	(	float	min	,
		float	max	,
		float	value	,
		float	step
		)
	:	ui::Slider

Arguments

float	min	–
float	max	–
float	value	–
float	step	–

Returns

ui::Slider

–

→ top of page

Method beginXFMTag

Signature

beginXFMTag	(	ui::AbstractXMLForm	form	,
		HashTable	attributes
		)
	:	int

Arguments

ui::AbstractXMLForm	form	–
HashTable	attributes	–

Returns

int

–

→ top of page

Method calcSizeX

Signature

calcSizeX

(

)

float

Returns

float

–

→ top of page

Method calcSizeY

Signature

calcSizeY

(

)

float

Returns

float

–

→ top of page

Method cancelSliderTimer

Signature

cancelSliderTimer

(

)

→ top of page

Method consumeAction

Signature

consumeAction	(	ui::Action	action	)
	:	int

Arguments

ui::Action

action

–

Returns

int

–

→ top of page

Method continueGrabAtNewMousePosition

Signature

continueGrabAtNewMousePosition

(

)

→ top of page

Method decCoarse

Subtract step_coarse from current slider value

Signature

decCoarse

(

)

int

Returns

int

–

→ top of page

Method decFine

Signature

decFine

(

)

int

Returns

int

–

→ top of page

Method getBorderSize

Signature

getBorderSize

(

)

→ top of page

Method getKnobSize

Query the size of the slider knob

Signature

getKnobSize

(

)

float

Returns

float

–

→ top of page

Method getMaxValue

Query the maximum slider position

Signature

getMaxValue

(

)

float

Returns

float

–

→ top of page

Method getMinValue

Query the minimum slider position

Signature

getMinValue

(

)

float

Returns

float

–

→ top of page

Method getMoveDirection

Return direction of last slider movement, -1=up/left, 0=none, 1=right/down

Signature

getMoveDirection

(

)

int

Returns

int

–

→ top of page

Method getProvidedActionNames

Signature

getProvidedActionNames

(

)

StringArray

Returns

StringArray

–

→ top of page

Method getStepCoarse

Query the default position change inc/dec size.

Signature

getStepCoarse

(

)

float

Returns

float

–

→ top of page

Method getValue

Signature

getValue

(

)

float

Returns

float

–

→ top of page

Method grabMouse

Signature

grabMouse

(

)

→ top of page

Method handleMouseClickOrPress

Signature

handleMouseClickOrPress

(

)

→ top of page

Method handleResetValue

Signature

handleResetValue

(

)

int

Returns

int

–

→ top of page

Method handleValueChanged

Signature

handleValueChanged

(

)

→ top of page

Method handleValueChanging

Signature

handleValueChanging

(

)

→ top of page

Method incCoarse

Add step_coarse to current slider value

Signature

incCoarse

(

)

int

Returns

int

–

→ top of page

Method incFine

Signature

incFine

(

)

int

Returns

int

–

→ top of page

Method initSlider

Signature

initSlider	(	float	min	,
		float	max	,
		float	value	,
		float	step
		)

Arguments

float	min	–
float	max	–
float	value	–
float	step	–

→ top of page

Method isFlipped

Signature

isFlipped

(

)

int

Returns

int

–

→ top of page

Method isKnobSizeAdaptive

Signature

isKnobSizeAdaptive

(

)

int

Returns

int

–

→ top of page

Method isMouseFocusLocked

Signature

isMouseFocusLocked

(

)

int

Returns

int

–

→ top of page

Method isTabCycleMember

Signature

isTabCycleMember

(

)

int

Returns

int

–

→ top of page

Method isVertical

Query orientation of the slider; true=vertical, false=horizontal

Signature

isVertical

(

)

int

Returns

int

–

→ top of page

Method onDraw

Signature

onDraw

(

)

→ top of page

Method onKey

Signature

onKey	(	Key	k	)
	:	int

Arguments

Key

–

Returns

int

–

→ top of page

Method onKeyboardFocusLost

Signature

onKeyboardFocusLost

(

int

bQuiet

)

Arguments

int

bQuiet

–

→ top of page

Method onMouse

Signature

onMouse	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseBeginDrag

Signature

onMouseBeginDrag	(	ui::MouseEvent	dragStart	,
		ui::MouseEvent	ev
		)
	:	int

Arguments

ui::MouseEvent	dragStart	–
ui::MouseEvent	ev	–

Returns

int

–

→ top of page

Method onMouseCancelDrag

Signature

onMouseCancelDrag

(

ui::MouseEvent

)

Arguments

ui::MouseEvent

–

→ top of page

Method onMouseClick

Signature

onMouseClick	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseDoubleClick

Signature

onMouseDoubleClick	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseDrag

Signature

onMouseDrag	(	ui::MouseEvent	lastEv	,
		ui::MouseEvent	currentEv
		)
	:	int

Arguments

ui::MouseEvent	lastEv	–
ui::MouseEvent	currentEv	–

Returns

int

–

→ top of page

Method onMouseEnter

Signature

onMouseEnter	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseHold

Signature

onMouseHold	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseKey

Signature

onMouseKey	(	Key	k	)
	:	int

Arguments

Key

–

Returns

int

–

→ top of page

Method onMouseLeave

Signature

onMouseLeave	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onTabFocus

Signature

onTabFocus

(

)

→ top of page

Method quantizeValue

Signature

quantizeValue	(	float	value	)
	:	float

Arguments

float

value

–

Returns

float

–

→ top of page

Method recalcKnobSize

Signature

recalcKnobSize

(

)

→ top of page

Method setBorderSize

Signature

setBorderSize

(

int

)

Arguments

int

–

→ top of page

Method setCustomMinSize

Signature

setCustomMinSize	(	float	w	,
		float	h
		)

Arguments

float	w	–
float	h	–

→ top of page

Method setEnableAdaptiveKnobSize

Signature

setEnableAdaptiveKnobSize

(

int

)

Arguments

int

–

→ top of page

Method setEnableBlendReplaceAlpha

Signature

setEnableBlendReplaceAlpha

(

int

bEnable

)

Arguments

int

bEnable

–

→ top of page

Method setEnableDetailEdit

Signature

setEnableDetailEdit

(

int

bEnable

)

Arguments

int

bEnable

–

→ top of page

Method setFlip

Signature

setFlip

(

int

)

Arguments

int

–

→ top of page

Method setKnobSize

Set the size of the slider knob (in pixels)

Signature

setKnobSize

(

float

size

)

Arguments

float

size

–

→ top of page

Method setLayerStyle

Signature

setLayerStyle

(

int

style

)

Arguments

int

style

–

→ top of page

Method setMaxValue

Set the maximum slider position

Signature

setMaxValue

(

float

max

)

Arguments

float

max

–

→ top of page

Method setMinMaxValues

Signature

setMinMaxValues	(	float	min	,
		float	max
		)

Arguments

float	min	–
float	max	–

→ top of page

Method setMinValue

Set the minimum slider position

Signature

setMinValue

(

float

min

)

Arguments

float

min

–

→ top of page

Method setRange

Signature

setRange	(	float	min	,
		float	max
		)

Arguments

float	min	–
float	max	–

→ top of page

Method setRelativeKnobSize

Set the size of the slider knob (visible range of values)

Signature

setRelativeKnobSize

(

float

visible

)

Arguments

float

visible

–

→ top of page

Method setResetValue

Signature

setResetValue

(

float

reset

)

Arguments

float

reset

–

→ top of page

Method setResetValues

Signature

setResetValues

(

FloatArray

)

Arguments

FloatArray

–

→ top of page

Method setStepCoarse

Set the default position change inc/dec size.

Signature

setStepCoarse

(

float

val

)

Arguments

float

val

–

→ top of page

Method setValue

Signature

setValue

(

float

value

)

Arguments

float

value

–

→ top of page

Method setValueGrabbed

Signature

setValueGrabbed

(

float

value

)

Arguments

float

value

–

→ top of page

Method setVertical

Enable vertical orientation instead of horizontal (default)

Signature

setVertical

(

int

)

Arguments

int

–

→ top of page

Method showDetailEdit

Signature

showDetailEdit

(

)

→ top of page

Method ungrabMouse

Signature

ungrabMouse

(

)

→ top of page

Method validateValue

Signature

validateValue

(

)

→ top of page

Method wantOnMouseClickAfterOnMouseWasHandled

Signature

wantOnMouseClickAfterOnMouseWasHandled

(

)

int

Returns

int

–

→ top of page

Constant `ACTION_VALUECHANGED (String)`

Constant `ACTION_VALUECHANGING (String)`

Constant `DELEGATE_GETSTEPCOARSE (String)`

Constant `MAX_KNOB_SIZE (float)`

Constant `MIN_HEIGHT (float)`

Constant `MIN_WIDTH (float)`

Constant `TA_REPEAT (String)`

Project Modules:	`MAbstractXMLForm` , `MAcceleratorKey` , `MAcceleratorList` , `MAction` , `MActionConsumer` , `MActionProvider` , `MBezier01Edit` , `MBezierEdit` , `MButton` , `MCharFilter` , `MCharFilterBinary255Expr` , `MCharFilterFloat` , `MCharFilterFloatExpr` , `MCharFilterHex` , `MCharFilterHexExpr` , `MCharFilterHexShort` , `MCharFilterHexShortExpr` , `MCharFilterUFix16` , `MCheckBox` , `MChoiceDialog` , `MCmdProvider` , `MColorBox` , `MColorButton` , `MComboBox` , `MComboBoxPopup` , `MComboBoxTM` , `MComboField` , `MComposite` , `MControl` , `MCursorShapes` , `MDial` , `MDialog` , `MDragHandleLabel` , `MDynamicPopupMenuAction` , `MFBO` , `MFloatAction` , `MFloatField` , `MFloatingLayer` , `MFloatParam` , `MFloatParamDialog` , `MFloatParamEditor` , `MFlowLayout` , `MFont` , `MFontCache` , `MFontResource` , `MForm` , `MFT2Face` , `MFT2FontResource` , `MFT2Glyph` , `MGeometry4f` , `MGraph` , `MGraphForm` , `MGridLayout` , `MHiddenPanel` , `MHSVColorPicker` , `MIcon` , `MIconCache` , `MInfoDialog` , `MIntAction` , `MKeyAction` , `MKeyboardMonitor` , `MKeyHelpDialog` , `MLabel` , `MLayer` , `MLayerSwitch` , `MLayout` , `MLogger` , `MLookAndFeel` , `MLookAndFeel_Dark` , `MLookAndFeel_Light` , `MLookAndFeel_Mono` , `MMouseEvent` , `MObjectAction` , `MOpaquePanel` , `MPanel` , `MPNGIcon` , `MPopupMenu` , `MPopupMenuBar` , `MPopupMenuBarButton` , `MPopupMenuButton` , `MPopupMenuCheckButton` , `MPopupMenuFolderButton` , `MPopupMenuSeparator` , `MPopupMenuWindowDock` , `MRadioButton` , `MRadioButtonGroup` , `MRectangle2f` , `MRepeatButton` , `MScroller` , `MScrollPane` , `MShader` , `MShader_ColorGrading` , `MShader_GradientH` , `MShader_GradientR` , `MShader_GradientV` , `MShader_InvertColor` , `MShader_PatternFill` , `MShader_PatternGradientH` , `MShader_PatternGradientR` , `MShader_PatternGradientV` , `MShader_SharpenFilter` , `MShader_SharpenFilterAndColorGrading` , `MShape` , `MShapePolyline` , `MSizeGroup` , `MSizeGroupX` , `MSizeGroupXY` , `MSizeGroupY` , `MSlider` , `MSpacer` , `MSplitPane` , `MStatusBar` , `MStringAction` , `MStringDialog` , `MSuperBorderLayout` , `MTableCellEditor` , `MTableCellEditorCheckBox` , `MTableCellEditorComboBox` , `MTableCellEditorFloatParam` , `MTableCellEditorString` , `MTableModel` , `MTableView` , `MTableViewData` , `MTableViewHeader` , `MTabSwitch` , `MTextEdit` , `MTextEditDialog` , `MTextField` , `MTextFieldIncDec` , `MTextInputDialog` , `MTextView` , `MTimerAction` , `MTitledPanel` , `MToolTip` , `MTransparentPanel` , `MTreeTableModel` , `MTreeTableNode` , `MUI` , `MUIConstants` , `MUIPluginLoader` , `MUIRenderer` , `MUserDataContainer` , `MValueAction` , `MView` , `MViewPane` , `MWindow` , `MWindowDock` , `MWindowTitleBar` , `MXFMObject` , `MXMLForm` , `MXYPad`
Project Classes:	`CmdProvider` , `ColorBox` , `graph::AttribsBase` , `graph::BBox` , `graph::Canvas` , `graph::Cell` , `graph::Edge` , `graph::GR` , `graph::Graph` , `graph::GRGradient` , `graph::GRPalette` , `graph::GRParseContext` , `graph::GRStyle` , `graph::GRUtils` , `graph::Node` , `graph::Port` , `graph::PortsBase` , `HSVColorPicker` , `ui::AbstractXMLForm` , `ui::AcceleratorKey` , `ui::AcceleratorList` , `ui::Action` , `ui::ActionConsumer` , `ui::ActionProvider` , `ui::Bezier01Edit` , `ui::BezierEdit` , `ui::BezierEditState` , `ui::BezierHistory` , `ui::BezierLUT01` , `ui::BorderLayout` , `ui::Button` , `ui::CharFilter` , `ui::CharFilterBinary255Expr` , `ui::CharFilterFloat` , `ui::CharFilterFloatExpr` , `ui::CharFilterHex` , `ui::CharFilterHexExpr` , `ui::CharFilterHexShort` , `ui::CharFilterHexShortExpr` , `ui::CharFilterUFix16` , `ui::CheckBox` , `ui::ChoiceDialog` , `ui::ColorButton` , `ui::ComboBox` , `ui::ComboBoxPopup` , `ui::ComboBoxTM` , `ui::ComboField` , `ui::Composite` , `ui::Control` , `ui::CursorShapes` , `ui::Dial` , `ui::Dialog` , `ui::DragHandleLabel` , `ui::DynamicPopupMenuAction` , `ui::FBO` , `ui::FloatAction` , `ui::FloatField` , `ui::FloatingLayer` , `ui::FloatParam` , `ui::FloatParamDialog` , `ui::FloatParamEditor` , `ui::FlowLayout` , `ui::Font` , `ui::FontCache` , `ui::FontResource` , `ui::Form` , `ui::FT2Face` , `ui::FT2FontResource` , `ui::FT2Glyph` , `ui::FT2LocalFileFontResource` , `ui::FT2PakFileFontResource` , `ui::Geometry4f` , `ui::GraphEdge` , `ui::GraphEdgeArrow` , `ui::GraphForm` , `ui::GraphPortButton` , `ui::GridLayout` , `ui::HiddenPanel` , `ui::Icon` , `ui::IconCache` , `ui::InfoDialog` , `ui::IntAction` , `ui::KeyAction` , `ui::KeyboardFocusListener` , `ui::KeyboardMonitor` , `ui::KeyboardMonitorEntry` , `ui::KeyHelpButton` , `ui::KeyHelpDialog` , `ui::KeyHelpToolTip` , `ui::KeyRepeatAction` , `ui::KeyRepeatConsumer` , `ui::Label` , `ui::Layer` , `ui::LayerSwitch` , `ui::Layout` , `ui::Logger` , `ui::LookAndFeel` , `ui::LookAndFeelDefs` , `ui::LookAndFeel_Dark` , `ui::LookAndFeel_Light` , `ui::LookAndFeel_Mono` , `ui::MouseEvent` , `ui::MouseHoldAction` , `ui::MouseHoldConsumer` , `ui::ObjectAction` , `ui::OpaquePanel` , `ui::Panel` , `ui::PNGIcon` , `ui::PopupMenu` , `ui::PopupMenuBar` , `ui::PopupMenuBarButton` , `ui::PopupMenuButton` , `ui::PopupMenuCheckButton` , `ui::PopupMenuFolderButton` , `ui::PopupMenuRadioButton` , `ui::PopupMenuSeparator` , `ui::PopupMenuWindowDock` , `ui::RadioButton` , `ui::RadioButtonGroup` , `ui::Rectangle2f` , `ui::RepeatButton` , `ui::Scroller` , `ui::ScrollPane` , `ui::Shader` , `ui::Shader_ColorGrading` , `ui::Shader_GradientH` , `ui::Shader_GradientR` , `ui::Shader_GradientV` , `ui::Shader_InvertColor` , `ui::Shader_PatternFill` , `ui::Shader_PatternGradientH` , `ui::Shader_PatternGradientR` , `ui::Shader_PatternGradientV` , `ui::Shader_SharpenFilter` , `ui::Shader_SharpenFilterAndColorGrading` , `ui::Shape` , `ui::ShapePolyline` , `ui::SizeGroup` , `ui::SizeGroupX` , `ui::SizeGroupXY` , `ui::SizeGroupY` , `ui::Slider` , `ui::Spacer` , `ui::SplitPane` , `ui::StatusBar` , `ui::StatusBarListener` , `ui::StatusBarMessage` , `ui::StringAction` , `ui::StringDialog` , `ui::StringDialogTextField` , `ui::SuperBorderLayout` , `ui::TableCellEditor` , `ui::TableCellEditorCheckBox` , `ui::TableCellEditorComboBox` , `ui::TableCellEditorFloatParam` , `ui::TableCellEditorString` , `ui::TableGraphPanel` , `ui::TableModel` , `ui::TableView` , `ui::TableViewData` , `ui::TableViewHeader` , `ui::TabSwitch` , `ui::TabSwitchLabelPanel` , `ui::TextEdit` , `ui::TextEditDialog` , `ui::TextEditPlugin` , `ui::TextEditUndoEntry` , `ui::TextField` , `ui::TextFieldIncDec` , `ui::TextInputDialog` , `ui::TextView` , `ui::TextViewSyntaxHighlighter` , `ui::TimerAction` , `ui::TitledPanel` , `ui::ToolTip` , `ui::TransparentPanel` , `ui::TreeTableModel` , `ui::TreeTableNode` , `ui::TriadKeyConsumer` , `ui::UI` , `ui::UIConstants` , `ui::UIRenderer` , `ui::UserDataContainer` , `ui::ValueAction` , `ui::View` , `ui::ViewPane` , `ui::Window` , `ui::WindowDock` , `ui::WindowTitleBar` , `ui::XFMObject` , `ui::XMLForm` , `ui::XYPad`
Project Functions:	`getTableViewStepCoarse` , `Screen_onApplicationActive` , `Screen_onClose` , `Screen_onDrainEventQueue` , `Screen_onDraw` , `Screen_onDropFiles` , `Screen_onExpose` , `Screen_onInputFocusActive` , `Screen_onKeyboard` , `Screen_onMouse` , `Screen_onMouseFocusActive` , `Screen_onMoveWindow` , `Screen_onOpen` , `Screen_onResize` , `Screen_onTimer` , `SetDebugLevel` , `SetDebugLevel` , `SetEnableProfiling`
All Namespaces:	`default` , `graph` , `ui`
All Projects:	`core` , `eqxmms` , `ShaderVG` , `ShaderVG_Text` , `tkanalogrytm` , `tkchipmunk` , `tkclap` , `tkfileutils` , `tkfreeglut` , `tkfreetype2` , `tkfreeverb` , `tkmath` , `tkmidi` , `tkmidipipe` , `tkminnie` , `tkoldmath` , `tkopengl` , `tkportaudio` , `tkradiastools` , `tksamplechain` , `tksampleedit` , `tksampler` , `tksdl` , `tksdl_net` , `tksidplay2` , `tkspeexdsp` , `tksqlite` , `tktriangulate` , `tkui` , `tkvst2` , `tkzip` , `ui` , `yingtest`

auto-generated by "DOG", the TkScript document generator. Wed, 27/May/2026 15:27:24

Class MSlider.ui::Slider

Class `MSlider.ui::Slider`