→ home

→ index of namespace ui

→ index of project tkui

→ index of module MSlider

Class `MSlider.ui::Slider`

Synopsis:

Base classes:

MControl.ui::Control

Functions:

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

Methods:

beginXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int -
calcMinimumSizeX() -
calcMinimumSizeY() -
calcPreferredSizeX() -
calcPreferredSizeY() -
cancelSliderTimer() -
consumeAction(ui::Action ac) : int -
decrementPosition() : int - Subtract stepSizeDec from current slider value
getBorderSize() -
getKnobSize() : float - Query the size of the slider knob
getMaximumPosition() : float - Query the maximum slider position
getMinimumPosition() : float - Query the minimum slider position
getMoveDirection() : int - Return direction of last slider movement, -1=up/left, 0=none, 1=right/down
getProvidedActionNames() : StringArray -
getStepSizeDec() : float - Query the default position change dec size.
getStepSizeInc() : float - Query the default position change inc size.
getValue() : float -
handleMouseClick() -
handleValueChanged() -
handleValueChanging() -
incrementPosition() : int - Add stepSizeInc to current slider value
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 -
onMouseClick(ui::MouseEvent ev) : int -
onMouseEnter(ui::MouseEvent ev) : int -
onMouseHold(ui::MouseEvent ev) : int -
onMouseLeave(ui::MouseEvent ev) : int -
onTabFocus() -
recalcKnobSize() -
setBorderSize(int bs) -
setEnableAdaptiveKnobSize(int b) -
setFlip(int b) -
setKnobSize(float size) - Set the size of the slider knob (in pixels)
setMaximumPosition(float max) - Set the maximum slider position
setMinimumPosition(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)
setStepSize(float val) - Set the default position change inc/dec size.
setStepSizeDec(float s) - Set the default position change dec size.
setStepSizeInc(float s) - Set the default position change inc size.
setValue(float value) -
setValueGrabbed(float value) -
setVertical(int b) - Enable vertical orientation instead of horizontal (default)
Slider() -
validateValue() -

Constants:

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 calcMinimumSizeX

Signature

calcMinimumSizeX

(

)

→ top of page

Method calcMinimumSizeY

Signature

calcMinimumSizeY

(

)

→ top of page

Method calcPreferredSizeX

Signature

calcPreferredSizeX

(

)

→ top of page

Method calcPreferredSizeY

Signature

calcPreferredSizeY

(

)

→ top of page

Method cancelSliderTimer

Signature

cancelSliderTimer

(

)

→ top of page

Method consumeAction

Signature

consumeAction	(	ui::Action	ac	)
	:	int

Arguments

ui::Action

–

Returns

int

–

→ top of page

Method decrementPosition

Subtract stepSizeDec from current slider value

Signature

decrementPosition

(

)

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 getMaximumPosition

Query the maximum slider position

Signature

getMaximumPosition

(

)

float

Returns

float

–

→ top of page

Method getMinimumPosition

Query the minimum slider position

Signature

getMinimumPosition

(

)

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 getStepSizeDec

Query the default position change dec size.

Signature

getStepSizeDec

(

)

float

Returns

float

–

→ top of page

Method getStepSizeInc

Query the default position change inc size.

Signature

getStepSizeInc

(

)

float

Returns

float

–

→ top of page

Method getValue

Signature

getValue

(

)

float

Returns

float

–

→ top of page

Method handleMouseClick

Signature

handleMouseClick

(

)

→ top of page

Method handleValueChanged

Signature

handleValueChanged

(

)

→ top of page

Method handleValueChanging

Signature

handleValueChanging

(

)

→ top of page

Method incrementPosition

Add stepSizeInc to current slider value

Signature

incrementPosition

(

)

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 onMouseClick

Signature

onMouseClick	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

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 onMouseLeave

Signature

onMouseLeave	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onTabFocus

Signature

onTabFocus

(

)

→ top of page

Method recalcKnobSize

Signature

recalcKnobSize

(

)

→ top of page

Method setBorderSize

Signature

setBorderSize

(

int

)

Arguments

int

–

→ top of page

Method setEnableAdaptiveKnobSize

Signature

setEnableAdaptiveKnobSize

(

int

)

Arguments

int

–

→ 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 setMaximumPosition

Set the maximum slider position

Signature

setMaximumPosition

(

float

max

)

Arguments

float

max

–

→ top of page

Method setMinimumPosition

Set the minimum slider position

Signature

setMinimumPosition

(

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 setStepSize

Set the default position change inc/dec size.

Signature

setStepSize

(

float

val

)

Arguments

float

val

–

→ top of page

Method setStepSizeDec

Set the default position change dec size.

Signature

setStepSizeDec

(

float

)

Arguments

float

–

→ top of page

Method setStepSizeInc

Set the default position change inc size.

Signature

setStepSizeInc

(

float

)

Arguments

float

–

→ 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 Slider

Signature

Slider

(

)

→ top of page

Method validateValue

Signature

validateValue

(

)

→ top of page

Constant `ACTION_VALUECHANGED (String)`

Constant `ACTION_VALUECHANGING (String)`

Constant `DELEGATE_GETSTEPSIZEDEC (String)`

Constant `DELEGATE_GETSTEPSIZEINC (String)`

Constant `MAX_KNOB_SIZE (float)`

Constant `MIN_HEIGHT (float)`

Constant `MIN_WIDTH (float)`

Project Modules:	`MAbstractXMLForm` , `MAcceleratorKey` , `MAcceleratorList` , `MAction` , `MActionConsumer` , `MActionProvider` , `MBezierEdit` , `MButton` , `MCharFilter` , `MCharFilterFloat` , `MCharFilterFloatExpr` , `MCharFilterHex` , `MCharFilterHexExpr` , `MCheckBox` , `MChoiceDialog` , `MColorBox` , `MColorButton` , `MComboBox` , `MComboBoxTM` , `MComposite` , `MControl` , `MCursorShapes` , `MDial` , `MDialog` , `MDynamicPopupMenuAction` , `MFBO` , `MFloatAction` , `MFloatField` , `MFloatingLayer` , `MFloatParam` , `MFloatParamEditor` , `MFont` , `MFontResource` , `MForm` , `MFT2Face` , `MFT2FontCache` , `MFT2Glyph` , `MGeometry4f` , `MHiddenPanel` , `MHSVColorPicker` , `MIcon` , `MIconCache` , `MInfoDialog` , `MIntAction` , `MKeyAction` , `MLabel` , `MLayer` , `MLayerSwitch` , `MLayout` , `MLookAndFeel` , `MLookAndFeel_DarkFawn` , `MLookAndFeel_Gray` , `MLookAndFeel_LightFawn` , `MLookAndFeel_LightGray` , `MMouseEvent` , `MOpaquePanel` , `MPanel` , `MPNGIcon` , `MPoint2f` , `MPopupMenu` , `MPopupMenuBar` , `MPopupMenuBarButton` , `MPopupMenuButton` , `MPopupMenuCheckButton` , `MPopupMenuFolderButton` , `MPopupMenuSeparator` , `MPopupMenuWindowDock` , `MRadioButton` , `MRadioButtonGroup` , `MRectangle2f` , `MRepeatButton` , `MScroller` , `MScrollPane` , `MSize2f` , `MSizeGroup` , `MSizeGroupX` , `MSizeGroupXY` , `MSizeGroupY` , `MSlider` , `MSpacer` , `MSplitPane` , `MStatusBar` , `MStringAction` , `MStringDialog` , `MSuperBorderLayout` , `MTabbedView` , `MTableCellEditor` , `MTableCellEditorCheckBox` , `MTableCellEditorComboBox` , `MTableCellEditorFloatParam` , `MTableModel` , `MTableView` , `MTableViewData` , `MTableViewHeader` , `MTabSwitch` , `MTextEdit` , `MTextEditDialog` , `MTextField` , `MTextFieldIncDec` , `MTextInputDialog` , `MTextView` , `MTimerAction` , `MTitledPanel` , `MToolTip` , `MTransparentPanel` , `MTreeTableModel` , `MTreeTableNode` , `MUI` , `MUIConstants` , `MUIPluginLoader` , `MUIRenderer` , `MValueAction` , `MVector2f` , `MView` , `MViewPane` , `MWindow` , `MWindowDock` , `MWindowTitleBar` , `MXFMObject` , `MXMLForm`
Project Classes:	`ColorBox` , `HSVColorPicker` , `ui::AbstractXMLForm` , `ui::AcceleratorKey` , `ui::AcceleratorList` , `ui::Action` , `ui::ActionConsumer` , `ui::ActionProvider` , `ui::BezierEdit` , `ui::BezierEditState` , `ui::BezierHistory` , `ui::BorderLayout` , `ui::Button` , `ui::CharFilter` , `ui::CharFilterFloat` , `ui::CharFilterFloatExpr` , `ui::CharFilterHex` , `ui::CharFilterHexExpr` , `ui::CheckBox` , `ui::ChoiceDialog` , `ui::ColorButton` , `ui::ComboBox` , `ui::ComboBoxPopup` , `ui::ComboBoxTM` , `ui::Composite` , `ui::Control` , `ui::CursorShapes` , `ui::Dial` , `ui::Dialog` , `ui::DynamicPopupMenuAction` , `ui::FBO` , `ui::FloatAction` , `ui::FloatField` , `ui::FloatingLayer` , `ui::FloatParam` , `ui::FloatParamEditor` , `ui::Font` , `ui::FontResource` , `ui::Form` , `ui::FT2Face` , `ui::FT2FontCache` , `ui::FT2FontResource` , `ui::FT2Glyph` , `ui::FT2LocalFileFontResource` , `ui::FT2PakFileFontResource` , `ui::Geometry4f` , `ui::HiddenPanel` , `ui::Icon` , `ui::IconCache` , `ui::InfoDialog` , `ui::IntAction` , `ui::KeyAction` , `ui::KeyRepeatAction` , `ui::KeyRepeatConsumer` , `ui::Label` , `ui::Layer` , `ui::LayerSwitch` , `ui::Layout` , `ui::LookAndFeel` , `ui::LookAndFeel_DarkFawn` , `ui::LookAndFeel_Gray` , `ui::LookAndFeel_LightFawn` , `ui::LookAndFeel_LightGray` , `ui::MouseEvent` , `ui::MouseHoldAction` , `ui::MouseHoldConsumer` , `ui::OpaquePanel` , `ui::Panel` , `ui::PNGIcon` , `ui::Point2f` , `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::Size2f` , `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::TabbedView` , `ui::TableCellEditor` , `ui::TableCellEditorCheckBox` , `ui::TableCellEditorComboBox` , `ui::TableCellEditorFloatParam` , `ui::TableModel` , `ui::TableView` , `ui::TableViewData` , `ui::TableViewHeader` , `ui::TabSwitch` , `ui::TabSwitchLabelPanel` , `ui::TextEdit` , `ui::TextEditDialog` , `ui::TextField` , `ui::TextFieldIncDec` , `ui::TextInputDialog` , `ui::TextView` , `ui::TimerAction` , `ui::TitledPanel` , `ui::ToolTip` , `ui::TransparentPanel` , `ui::TreeTableModel` , `ui::TreeTableNode` , `ui::TriadKeyConsumer` , `ui::UI` , `ui::UIConstants` , `ui::UIRenderer` , `ui::ValueAction` , `ui::Vector2f` , `ui::View` , `ui::ViewPane` , `ui::Window` , `ui::WindowDock` , `ui::WindowTitleBar` , `ui::XFMObject` , `ui::XMLForm`
Project Functions:	`getTableViewStepSizeDec` , `getTableViewStepSizeInc` , `Screen_onApplicationActive` , `Screen_onClose` , `Screen_onDraw` , `Screen_onDropFiles` , `Screen_onExpose` , `Screen_onInputFocusActive` , `Screen_onKeyboard` , `Screen_onMouse` , `Screen_onMouseFocusActive` , `Screen_onOpen` , `Screen_onResize` , `Screen_onTimer`
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 14:27:06

Class MSlider.ui::Slider

Class `MSlider.ui::Slider`