DVX_GUI/widgets/scrollPane/scrlpane.dhs

49 lines
1.3 KiB
Text

.topic widget.scrollpane
.title ScrollPane
.toc 1 ScrollPane
.index ScrollPane
.index wgtScrollPane
.index wgtScrollPaneScrollToChild
.index wgtScrollPaneSetNoBorder
.h2 ScrollPane
A scrollable container that provides vertical and/or horizontal scrollbars when its content exceeds the visible area. Place a single child (typically a VBox or HBox) inside the scroll pane.
Header: widgets/widgetScrollPane.h
.h3 Creation
.code
WidgetT *sp = wgtScrollPane(parent);
WidgetT *content = wgtVBox(sp);
// add children to content...
.endcode
.h3 Macros
.table
Macro Description
----- -----------
wgtScrollPane(parent) Create a scroll pane container.
wgtScrollPaneScrollToChild(sp, child) Scroll so that the given child widget is visible.
wgtScrollPaneSetNoBorder(w, noBorder) When true, removes the border around the scroll pane.
.endtable
.h3 Events
.table
Callback Description
-------- -----------
onScroll Fires when the scroll position changes.
.endtable
.h3 Properties (BASIC Interface)
.table
Property Type Access Description
-------- ---- ------ -----------
NoBorder Boolean Read/Write Whether the border around the scroll pane is hidden.
.endtable
.hr