→ home

→ index of namespace ui

→ index of project tkui

→ index of module MViewPane

Class `MViewPane.ui::ViewPane`

Synopsis: Virtual root layer that supports clipping and scrolling of child hierarchies.

Base classes:

MControl.ui::Control

Methods:

addXFMChild(Object c) -
beginXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int -
calcPreferredSizeX() -
calcPreferredSizeY() : float -
calcSizeX() : float -
calcSizeY() : float -
drawChildHierarchy(int bForceRedraw, bCheckIntersect) -
endXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int -
getInnerLayer() : ui::Layer - Returns the layer currently being displayed in the ViewPane
getLayoutFirstChild() : ui::Layer -
getLayoutSizeX() : float -
getLayoutSizeY() : float -
getViewOffsetX() : float - Query the horizontal view offset (distance to the left border of the inner layer)
getViewOffsetY() : float - Query the vertical view offset (distance to the top of the inner layer)
getViewSizeX() : float - Query the h-size available for the inner layer
getViewSizeY() : float - Query the y-size available for the inner layer
invalidateAbsolutePositions() -
layoutHierarchy(int bInvalidateSizeCaches, bLayoutFinal) -
makeWidgetVisible(Object l) - Adjust scroll offsets so that the widget becomes visible
onDraw() -
onOpen() -
setEnableAdaptiveViewSize(int bEnabled) -
setEnableCollapse(int bEnabled) -
setEnableForceMinSizeX(int bEnabled) -
setEnableForceMinSizeY(int bEnabled) -
setInnerLayer(Object l) - Set the layer to be displayed in the ViewPane
setViewOffset(float top, left) - Set the top left position of the inner Layer
setViewOffsetX(float left) - Set the horizontal offset of the inner layer
setViewOffsetY(float top) - Set the vertical offset of the inner layer
setViewSize2f(float width, height) - Set the size available for the inner layer
setViewSizeX(float w) - Set the horizontal size available for the inner layer
setViewSizeY(float h) - Set the vertical size available for the inner layer
validateViewOffset() -
validateViewOffsetX() -
validateViewOffsetY() -
ViewPane() -

Method addXFMChild

Signature

addXFMChild

(

Object

)

Arguments

Object

–

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

Signature

calcPreferredSizeX

(

)

→ top of page

Method calcPreferredSizeY

Signature

calcPreferredSizeY

(

)

float

Returns

float

–

→ top of page

Method calcSizeX

Signature

calcSizeX

(

)

float

Returns

float

–

→ top of page

Method calcSizeY

Signature

calcSizeY

(

)

float

Returns

float

–

→ top of page

Method drawChildHierarchy

Signature

drawChildHierarchy	(	int	bForceRedraw	,
		int	bCheckIntersect
		)

Arguments

int	bForceRedraw	–
int	bCheckIntersect	–

→ top of page

Method endXFMTag

Signature

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

Arguments

ui::AbstractXMLForm	form	–
HashTable	attributes	–

Returns

int

–

→ top of page

Method getInnerLayer

Returns the layer currently being displayed in the ViewPane

Signature

getInnerLayer

(

)

ui::Layer

Returns

ui::Layer

–

→ top of page

Method getLayoutFirstChild

Signature

getLayoutFirstChild

(

)

ui::Layer

Returns

ui::Layer

–

→ top of page

Method getLayoutSizeX

Signature

getLayoutSizeX

(

)

float

Returns

float

–

→ top of page

Method getLayoutSizeY

Signature

getLayoutSizeY

(

)

float

Returns

float

–

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

Signature

invalidateAbsolutePositions

(

)

→ top of page

Method layoutHierarchy

Signature

layoutHierarchy	(	int	bInvalidateSizeCaches	,
		int	bLayoutFinal
		)

Arguments

int	bInvalidateSizeCaches	–
int	bLayoutFinal	–

→ top of page

Method makeWidgetVisible

Adjust scroll offsets so that the widget becomes visible

Signature

makeWidgetVisible

(

Object

)

Arguments

Object

–

→ top of page

Method onDraw

Signature

onDraw

(

)

→ top of page

Method onOpen

Signature

onOpen

(

)

→ top of page

Method setEnableAdaptiveViewSize

Signature

setEnableAdaptiveViewSize

(

int

bEnabled

)

Arguments

int

bEnabled

–

→ top of page

Method setEnableCollapse

Signature

setEnableCollapse

(

int

bEnabled

)

Arguments

int

bEnabled

–

→ top of page

Method setEnableForceMinSizeX

Signature

setEnableForceMinSizeX

(

int

bEnabled

)

Arguments

int

bEnabled

–

→ top of page

Method setEnableForceMinSizeY

Signature

setEnableForceMinSizeY

(

int

bEnabled

)

Arguments

int

bEnabled

–

→ top of page

Method setInnerLayer

Set the layer to be displayed in the ViewPane

Signature

setInnerLayer

(

Object

)

Arguments

Object

–

→ top of page

Method setViewOffset

Set the top left position of the inner Layer

Signature

setViewOffset	(	float	top	,
		float	left
		)

Arguments

float	top	–
float	left	–

→ top of page

Method setViewOffsetX

Set the horizontal offset of the inner layer

Signature

setViewOffsetX

(

float

left

)

Arguments

float

left

–

→ top of page

Method setViewOffsetY

Set the vertical offset of the inner layer

Signature

setViewOffsetY

(

float

top

)

Arguments

float

top

–

→ top of page

Method setViewSize2f

Set the size available for the inner layer

Signature

setViewSize2f	(	float	width	,
		float	height
		)

Arguments

float	width	–
float	height	–

→ top of page

Method setViewSizeX

Set the horizontal size available for the inner layer

Signature

setViewSizeX

(

float

)

Arguments

float

–

→ top of page

Method setViewSizeY

Set the vertical size available for the inner layer

Signature

setViewSizeY

(

float

)

Arguments

float

–

→ top of page

Method validateViewOffset

Signature

validateViewOffset

(

)

→ top of page

Method validateViewOffsetX

Signature

validateViewOffsetX

(

)

→ top of page

Method validateViewOffsetY

Signature

validateViewOffsetY

(

)

→ top of page

Method ViewPane

Signature

ViewPane

(

)

→ top of page

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 MViewPane.ui::ViewPane

Class `MViewPane.ui::ViewPane`