→ home

→ index of namespace ui

→ index of project tkui

→ index of module MScroller

Class `MScroller.ui::Scroller`

Synopsis:

Base classes:

MControl.ui::Control

Functions:

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

Methods:

beginXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int -
consumeAction(ui::Action ac) : int -
decrementPosition() : int -
getDecrementButton() : ui::RepeatButton - Returns the Button control which is used to to scroll up/left
getIncrementButton() : ui::RepeatButton - Returns the Button control which is used to to scroll down/right
getKnobSize() : float -
getMaximumPosition() : float -
getMinimumPosition() : float -
getMoveDirection() : int -
getSlider() : ui::Slider - Query the current slider control
getStepSizeDec() : float -
getStepSizeInc() : float -
getValue() : float -
incrementPosition() : int -
init(float min, max, value, step) -
initLayout() -
isKnobSizeAdaptive() : int -
isVertical() : int -
recalcKnobSize() -
setEnableAdaptiveKnobSize(int b) -
setFlip(int b) -
setKnobSize(float size) -
setMaximumPosition(float max) -
setMinimumPosition(float min) -
setRange(float min, max) -
setRelativeKnobSize(float visible) -
setStepSize(float s) -
setStepSizeDec(float s) -
setStepSizeInc(float s) -
setValue(float value) -
setVertical(int b) -
updateButtonActionAliases() -
validateValue() -

Constants:

Function New

Signature

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

Arguments

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

Returns

ui::Scroller

–

→ top of page

Function NewVertical

Signature

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

Arguments

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

Returns

ui::Scroller

–

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

Signature

consumeAction	(	ui::Action	ac	)
	:	int

Arguments

ui::Action

–

Returns

int

–

→ top of page

Method decrementPosition

Signature

decrementPosition

(

)

int

Returns

int

–

→ top of page

Method getDecrementButton

Returns the Button control which is used to to scroll up/left

Signature

getDecrementButton

(

)

ui::RepeatButton

Returns

ui::RepeatButton

–

→ top of page

Method getIncrementButton

Returns the Button control which is used to to scroll down/right

Signature

getIncrementButton

(

)

ui::RepeatButton

Returns

ui::RepeatButton

–

→ top of page

Method getKnobSize

Signature

getKnobSize

(

)

float

Returns

float

–

→ top of page

Method getMaximumPosition

Signature

getMaximumPosition

(

)

float

Returns

float

–

→ top of page

Method getMinimumPosition

Signature

getMinimumPosition

(

)

float

Returns

float

–

→ top of page

Method getMoveDirection

Signature

getMoveDirection

(

)

int

Returns

int

–

→ top of page

Method getSlider

Query the current slider control

Signature

getSlider

(

)

ui::Slider

Returns

ui::Slider

–

→ top of page

Method getStepSizeDec

Signature

getStepSizeDec

(

)

float

Returns

float

–

→ top of page

Method getStepSizeInc

Signature

getStepSizeInc

(

)

float

Returns

float

–

→ top of page

Method getValue

Signature

getValue

(

)

float

Returns

float

–

→ top of page

Method incrementPosition

Signature

incrementPosition

(

)

int

Returns

int

–

→ top of page

Method init

Signature

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

Arguments

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

→ top of page

Method initLayout

Signature

initLayout

(

)

→ top of page

Method isKnobSizeAdaptive

Signature

isKnobSizeAdaptive

(

)

int

Returns

int

–

→ top of page

Method isVertical

Signature

isVertical

(

)

int

Returns

int

–

→ top of page

Method recalcKnobSize

Signature

recalcKnobSize

(

)

→ 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

Signature

setKnobSize

(

float

size

)

Arguments

float

size

–

→ top of page

Method setMaximumPosition

Signature

setMaximumPosition

(

float

max

)

Arguments

float

max

–

→ top of page

Method setMinimumPosition

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

Signature

setRelativeKnobSize

(

float

visible

)

Arguments

float

visible

–

→ top of page

Method setStepSize

Signature

setStepSize

(

float

)

Arguments

float

–

→ top of page

Method setStepSizeDec

Signature

setStepSizeDec

(

float

)

Arguments

float

–

→ top of page

Method setStepSizeInc

Signature

setStepSizeInc

(

float

)

Arguments

float

–

→ top of page

Method setValue

Signature

setValue

(

float

value

)

Arguments

float

value

–

→ top of page

Method setVertical

Signature

setVertical

(

int

)

Arguments

int

–

→ top of page

Method updateButtonActionAliases

Signature

updateButtonActionAliases

(

)

→ top of page

Method validateValue

Signature

validateValue

(

)

→ top of page

Constant `ACTION_DECVALUE (String)`

Constant `ACTION_INCVALUE (String)`

Constant `ACTION_VALUECHANGED (String)`

Constant `ACTION_VALUECHANGING (String)`

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 MScroller.ui::Scroller

Class `MScroller.ui::Scroller`