Dragengine.Gui.Layouts.ScrollPanelLayout Class Reference

Arrange content widget using the position value of two scrollbars. More...

Inheritance diagram for Dragengine.Gui.Layouts.ScrollPanelLayout:

Classes
enum	Area
	Area to place widget in. More...

Public Member Functions
void	addWidget (Widget widget, Object settings)
	Add widget to layout into area.
void	doLayout (Container container)
	Layout widgets in container.
Widget	getContent ()
	Content widget or null if not set.
int	getGap ()
	Gap between areas in pixels.
ScrollBar	getHorizontalScrollBar ()
	Horizontal scrollbar or null if not set.
Point	getMinimumSize (Container container)
	Minimal size required for layout in container.
Point	getMinimumSizeForHeight (Container container, int height)
	Minimum size of layout using reference widget height and variable width.
Point	getMinimumSizeForWidth (Container container, int width)
	Minimum size of layout using reference width and variable height.
ScrollBar	getVerticalScrollBar ()
	Vertical scrollbar or null if not set.
ScrollPanelLayout	new ()
	Create layout with 0 gap.
ScrollPanelLayout	new (int gap)
	Create layout.
void	removeWidget (Widget widget)
	Remove widget from layout.
void	setGap (int gap)
	Set gap between areas in pixels.

Public Attributes
Widget	pContent
int	pGap
ScrollBar	pHorizontalScrollBar

Protected Member Functions
Point	getBaseMinimumSize (Container container)
	Reference size independend minimum size.

Detailed Description

Arrange content widget using the position value of two scrollbars.

Instances of this layout can not be shared by multiple widgets.

Member Function Documentation

addWidget()

void Dragengine.Gui.Layouts.ScrollPanelLayout.addWidget	(	Widget	widget,
		Object	settings
	)

Add widget to layout into area.

Parameters

widget	Widget to add to layout.
settings	Area to place widget in. Has to be of type Area .

Exceptions

EInvalidParam

widget is null.

Implements Dragengine.Gui.Layout.

doLayout()

void Dragengine.Gui.Layouts.ScrollPanelLayout.doLayout

(

Container

container

)

Layout widgets in container.

Implements Dragengine.Gui.Layout.

getBaseMinimumSize()

Point Dragengine.Gui.Layouts.ScrollPanelLayout.getBaseMinimumSize ( Container  container )

protected

Reference size independend minimum size.

getContent()

Widget Dragengine.Gui.Layouts.ScrollPanelLayout.getContent

(

)

Content widget or null if not set.

getGap()

int Dragengine.Gui.Layouts.ScrollPanelLayout.getGap

(

)

Gap between areas in pixels.

getHorizontalScrollBar()

ScrollBar Dragengine.Gui.Layouts.ScrollPanelLayout.getHorizontalScrollBar

(

)

Horizontal scrollbar or null if not set.

getMinimumSize()

Point Dragengine.Gui.Layouts.ScrollPanelLayout.getMinimumSize

(

Container

container

)

Minimal size required for layout in container.

Implements Dragengine.Gui.Layout.

getMinimumSizeForHeight()

Point Dragengine.Gui.Layouts.ScrollPanelLayout.getMinimumSizeForHeight	(	Container	container,
		int	height
	)

Minimum size of layout using reference widget height and variable width.

Implements Dragengine.Gui.Layout.

getMinimumSizeForWidth()

Point Dragengine.Gui.Layouts.ScrollPanelLayout.getMinimumSizeForWidth	(	Container	container,
		int	width
	)

Minimum size of layout using reference width and variable height.

Implements Dragengine.Gui.Layout.

getVerticalScrollBar()

ScrollBar Dragengine.Gui.Layouts.ScrollPanelLayout.getVerticalScrollBar

(

)

Vertical scrollbar or null if not set.

new() [1/2]

ScrollPanelLayout Dragengine.Gui.Layouts.ScrollPanelLayout.new

(

)

Create layout with 0 gap.

new() [2/2]

ScrollPanelLayout Dragengine.Gui.Layouts.ScrollPanelLayout.new

(

int

gap

)

Create layout.

Parameters

gap	Gap in pixels between areas.

removeWidget()

void Dragengine.Gui.Layouts.ScrollPanelLayout.removeWidget

(

Widget

widget

)

Remove widget from layout.

Implements Dragengine.Gui.Layout.

setGap()

void Dragengine.Gui.Layouts.ScrollPanelLayout.setGap

(

int

gap

)

Set gap between areas in pixels.

Member Data Documentation

pContent

Widget Dragengine.Gui.Layouts.ScrollPanelLayout.pContent

pGap

int Dragengine.Gui.Layouts.ScrollPanelLayout.pGap

pHorizontalScrollBar

ScrollBar Dragengine.Gui.Layouts.ScrollPanelLayout.pHorizontalScrollBar

---

The documentation for this class was generated from the following file:

• ScrollPanelLayout.ds