→ home
 
→ index of namespace ui
 
→ index of project tkui
 
→ index of module MScrollPane

Class MScrollPane.ui::ScrollPane


Synopsis: 

  Base classes:
  Functions:
  Methods:
  Constants:
Function New
Signature
New(ObjectinnerLayer)
 :ui::ScrollPane
Arguments
ObjectinnerLayer–
Returns

 
→ top of page
Method addXFMChild
Signature
addXFMChild(Objectc)
Arguments
Objectc–

 
→ top of page
Method beginXFMTag
Signature
beginXFMTag(ui::AbstractXMLFormform,
  HashTableattributes 
  )  
 :int
Arguments
ui::AbstractXMLFormform–
HashTableattributes–
Returns
int–

 
→ top of page
Method calcScrollers
Signature
calcScrollers()

 
→ top of page
Method consumeAction
Signature
consumeAction(ui::Actionac)
 :int
Arguments
ui::Actionac–
Returns
int–

 
→ top of page
Method endXFMTag
Signature
endXFMTag(ui::AbstractXMLFormform,
  HashTableattributes 
  )  
 :int
Arguments
ui::AbstractXMLFormform–
HashTableattributes–
Returns
int–

 
→ top of page
Method getAutoScrollerMode
Query whether horizontal/vertical auto-scrollers are enabled.
Signature
getAutoScrollerMode():int
Returns
int–

 
→ top of page
Method getEnableScrollers
Query the enabled scrollers
Signature
getEnableScrollers():int
Returns
int–

 
→ top of page
Method getEnableScrollersCurrent
Query the currently enabled scrollers
Signature
getEnableScrollersCurrent():int
Returns
int–

 
→ top of page
Method getHorizontalScroller
Query the left/right scroller control
Signature
getHorizontalScroller():ui::Scroller
Returns

 
→ top of page
Method getHorizontalScrollerPlacement
Query the placement of the left/right scroller (UIConstants.TOP|BOTTOM)
Signature
getHorizontalScrollerPlacement():int
Returns
int–

 
→ top of page
Method getInnerLayer
Returns the layer currently being displayed in the ViewPane
Signature
getInnerLayer():ui::Layer
Returns

 
→ top of page
Method getVerticalScroller
Query the up/down scroller control
Signature
getVerticalScroller():ui::Scroller
Returns

 
→ top of page
Method getVerticalScrollerPlacement
Query the placement of the up/down scroller (UIConstants.LEFT|RIGHT)
Signature
getVerticalScrollerPlacement():int
Returns
int–

 
→ top of page
Method getViewOffsetX
Query the horizontal view offset (distance to the left border of the inner layer)
Signature
getViewOffsetX():float
Returns
float–

 
→ top of page
Method getViewOffsetY
Query the vertical view offset (distance to the top of the inner layer)
Signature
getViewOffsetY():float
Returns
float–

 
→ top of page
Method getViewPane
Returns a reference to the inner ViewPane object
Signature
getViewPane():ui::ViewPane
Returns

 
→ top of page
Method getViewSizeX
Query the h-size available for the inner layer
Signature
getViewSizeX():float
Returns
float–

 
→ top of page
Method getViewSizeY
Query the y-size available for the inner layer
Signature
getViewSizeY():float
Returns
float–

 
→ top of page
Method init
Signature
init(ObjectinnerLayer)
Arguments
ObjectinnerLayer–

 
→ top of page
Method invalidateAbsolutePositions
Signature
invalidateAbsolutePositions()

 
→ top of page
Method isMouseFocusLocked
Signature
isMouseFocusLocked():int
Returns
int–

 
→ top of page
Method isTranslucent
Signature
isTranslucent():int
Returns
int–

 
→ top of page
Method layoutHierarchy
Signature
layoutHierarchy(intbInvalidateSizeCaches,
  intbLayoutFinal 
  )  
Arguments
intbInvalidateSizeCaches–
intbLayoutFinal–

 
→ top of page
Method makeWidgetVisible
Signature
makeWidgetVisible(Objectl)
Arguments
Objectl–

 
→ top of page
Method onMouse
Signature
onMouse(ui::MouseEventev)
 :int
Arguments
Returns
int–

 
→ top of page
Method onMouseBeginDrag
Signature
onMouseBeginDrag(ui::MouseEventdragStart,
  ui::MouseEventev 
  )  
 :int
Arguments
ui::MouseEventdragStart–
ui::MouseEventev–
Returns
int–

 
→ top of page
Method onMouseDrag
Signature
onMouseDrag(ui::MouseEventlastEv,
  ui::MouseEventev 
  )  
 :int
Arguments
Returns
int–

 
→ top of page
Method onMouseEndDrag
Signature
onMouseEndDrag(ui::MouseEventev)
Arguments

 
→ top of page
Method setAlpha
Signature
setAlpha(intalpha)
Arguments
intalpha–

 
→ top of page
Method setAutoScrollerMode
Enable/disable horizontal auto-scrollers (Layout.HORIZONTAL|VERTICAL)
Signature
setAutoScrollerMode(intmode)
Arguments
intmode–

 
→ top of page
Method setEnableAdaptiveViewSize
Signature
setEnableAdaptiveViewSize(intbEnabled)
Arguments
intbEnabled–

 
→ top of page
Method setEnableScrollers
Enable/disable scrollers for the given directions.
Signature
setEnableScrollers(intdirections)
Arguments
intdirections–
Description
Enabling scrollers will override the auto-scroller mode.

 
→ top of page
Method setEnableWheel
Signature
setEnableWheel(intbEnable)
Arguments
intbEnable–

 
→ top of page
Method setHorizontalScrollerPlacement
Set the placement of the left/right scroller (UIConstants.TOP|BOTTOM)
Signature
setHorizontalScrollerPlacement(intdir)
Arguments
intdir–

 
→ top of page
Method setInnerLayer
Set the layer to be displayed in the ViewPane
Signature
setInnerLayer(Objectl)
Arguments
Objectl–

 
→ top of page
Method setVerticalScrollerPlacement
Set the placement of the up/down scroller (UIConstants.LEFT|RIGHT)
Signature
setVerticalScrollerPlacement(intdir)
Arguments
intdir–

 
→ top of page
Method setViewOffset
Set the top left position of the inner Layer
Signature
setViewOffset(floattop,
  floatleft 
  )  
Arguments
floattop–
floatleft–

 
→ top of page
Method setViewOffsetX
Set the horizontal offset of the inner layer
Signature
setViewOffsetX(floatleft)
Arguments
floatleft–

 
→ top of page
Method setViewOffsetY
Set the vertical offset of the inner layer
Signature
setViewOffsetY(floattop)
Arguments
floattop–

 
→ top of page
Method setViewSize2f
Set the size available for the inner layer
Signature
setViewSize2f(floatwidth,
  floatheight 
  )  
Arguments
floatwidth–
floatheight–

 
→ top of page
Method setViewSizeX
Set the horizontal size available for the inner layer
Signature
setViewSizeX(floatw)
Arguments
floatw–

 
→ top of page
Method setViewSizeY
Signature
setViewSizeY(floath)
Arguments
floath–

 
→ top of page
Method updateLayout
Must be called when inner layer has changed.
Signature
updateLayout()

 
→ top of page
Constant HSCROLL_REL_STEPSIZE (float)
Constant VSCROLL_REL_STEPSIZE (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