Dragengine.Gui.Container Class Reference

Groups child widgets arranged by a layout instance. More...

Inheritance diagram for Dragengine.Gui.Container:

Public Member Functions
void	addWidget (Widget widget)
void	addWidget (Widget widget, Object settings)
bool	allowsChildGrabFocus ()
void	doLayout ()
Widget	findFocusableWidget ()
Widget	findLastFocusableWidget ()
Widget	findWidget (Block ablock)
	Find widget using block or null if not found. More...
int	getContainerHeight ()
Point	getContainerSize ()
int	getContainerWidth ()
bool	getHasBlockedDoLayout ()
	doLayout calls happened during runWhileBlockingLayout. More...
Layout	getLayout ()
Point	getMinimumSize ()
Point	getMinimumSizeForHeight (int height)
	Minimum size of widget using reference widget height and variable width. More...
Point	getMinimumSizeForWidth (int width)
	Minimum size of widget using reference widget width and variable height. More...
bool	getStateChangeNotifyChildren ()
	Notify children if state changed. More...
Widget	getWidget (int index)
Widget	getWidgetAt (Point position)
	Widget at coordinates or null if not found. More...
int	getWidgetCount ()
void	giveUpFocus ()
bool	hasFocusWidget ()
	Focus widget is inside container somewhere. More...
bool	hasWidget (Widget widget)
int	indexOfWidget (Widget widget)
Object	injectWidget (Object injectValue, Block ablock)
	Process value visiting widgets using block. More...
bool	isChildVisible (Widget child)
bool	isMouseInside ()
	Mouse is hovering over this widget. More...
void	layoutParent ()
void	moveWidget (Widget widget, int newPosition)
Container	new ()
Container	new (int x, int y, int width, int height)
Container	new (Layout layout)
	Create container with layout. More...
Container	new (Layout layout, Block blockAddContent)
	Create container with layout calling block to add content. More...
Container	new (Point position, Point size)
Widget	nextFocusWidgetAfter (Widget widget)
	Find next widget in the focus cycle that can grab the focus. More...
void	onGuiThemeChanged ()
void	onPaddingChanged ()
	Padding changed. More...
void	onStateChanged (StateChangeEvent event)
	State changed. More...
Widget	prevFocusWidgetAfter (Widget widget)
	Find previous widget in the focus cycle that can grab the focus. More...
void	removeAllWidgets ()
	Remove and dispose all widgets. More...
void	removeWidget (Widget widget)
	Remove widget without disposing. More...
bool	requestCaptureMouse (Widget widget)
bool	requestReleaseMouse (Widget widget)
void	runWhileBlockingLayout (Block ablock)
	Run block while layouting is blocked. More...
void	setEnabled (bool enabled)
void	setHasBlockedDoLayout (bool hasBlockedDoLayout)
	Set if doLayout calls happened during runWhileBlockingLayout. More...
void	setLayout (Layout layout)
void	setMousePointer (MousePointerFactory mousePointer)
	Set mouse pointer to use. More...
void	setStateChangeNotifyChildren (bool notify)
	Set to notify children if state changed. More...
Public Member Functions inherited from Dragengine.Gui.Widget
void	addDragListener (DragListener listener)
void	addFocusListener (FocusListener listener)
	Add focus listener. More...
void	addGamepadListener (GamepadListener listener)
	Add gamepad listener. More...
void	addKeyListener (KeyListener listener)
void	addMouseListener (MouseListener listener)
void	addStateChangeListener (StateChangeListener listener)
	Add state change listener. More...
void	addWidgetListener (WidgetListener listener)
	Add widget listener. More...
bool	canGrabFullFocus ()
void	captureMouse ()
void	design ()
	Design widget using WidgetDesigner. More...
void	dispose ()
CanvasCreator	getBackgroundCanvasCreator ()
	Background canvas creator or null to use background color. More...
bool	getBlockLayoutParent ()
	Block layoutParent calls. More...
Border	getBorder ()
BorderSize	getBorderSize ()
RectArea	getBoundary ()
	Rectangulare boundary of the widget. More...
RectArea	getBoundaryWithBorder ()
	Rectangulare boundary of the widget including border. More...
bool	getCanFocus ()
CanvasView	getCanvasBackground ()
CanvasView	getCanvasContent ()
CanvasView	getCanvasWidget ()
Clipboard	getClipboard ()
	Clipboard or null to use parent clipboard. More...
ColorMatrix	getColorTransformation ()
	Color transformation. More...
WidgetDesigner	getDesigner ()
	Designer. More...
String	getDesignerSelector ()
	Designer selector. More...
Desktop	getDesktop ()
Point	getDesktopPosition ()
	Widget position in desktop coordinates. More...
bool	getEnabled ()
MousePointerFactory	getFirstMousePointer ()
	First assigned mouse pointer. More...
Font	getFont ()
bool	getHasBlockedLayoutParent ()
	layoutParent calls happened during runWhileBlockingLayoutParent. More...
bool	getHasFocus ()
int	getHeight ()
	Height of widget. More...
RangeModel	getHorizontalRangeModel ()
	Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
Widget	getHoverWidget ()
	Widget the mouse hovers above or null. More...
Point	getLocalMouseLocation ()
	Parent desktop mouse location in widget coordinates. More...
Point	getMinimumSizeWithBorder ()
Point	getMinimumSizeWithBorderForHeight (int height)
	Minimum size of widget with border using reference height. More...
Point	getMinimumSizeWithBorderForWidth (int width)
	Minimum size of widget with border for reference width. More...
MousePointerFactory	getMousePointer ()
	Mouse pointer to use. More...
BorderSize	getPadding ()
	Padding. More...
Container	getParent ()
Point	getPosition ()
	Position of the widget. More...
bool	getProtectBackgroundCanvasCreator ()
	Protect custom set background canvas creator. More...
bool	getProtectBorder ()
	Protect custom set border. More...
bool	getProtectFont ()
	Protect custom set font. More...
bool	getProtectMinimumSize ()
	Protect custom set minimumsize. More...
bool	getProtectMousePointer ()
	Protect custom set mouse pointer. More...
bool	getProtectPadding ()
	Protect custom set padding. More...
bool	getProtectTextColor ()
	Protect custom set text color. More...
Point	getRelativePosition (Container parent)
	Widget position in parent widget coordinates. More...
Point	getScreenPosition ()
	Widget position in screen coordinates. More...
RectArea	getScreenRectArea ()
Point	getSetMinimumSize ()
Point	getSize ()
	Size of the widget. More...
Color	getTextColor ()
	Text color. More...
String	getTitle ()
	Widget title. More...
Object	getToolTip ()
	Tooltip or null. More...
float	getTotalTransparency ()
TexMatrix2	getTransformation ()
float	getTransparency ()
RangeModel	getVerticalRangeModel ()
	Vertical range model for viewports to synchronize the vertical scrollbar. More...
bool	getVisible ()
int	getWidth ()
	Width of widget. More...
Window	getWindow ()
Point	getWindowPosition ()
	Widget position in window coordinates. More...
int	getX ()
	X position of widget. More...
int	getY ()
	Y position of widget. More...
void	grabFocus ()
bool	hasParent (Container container)
bool	isDesignerSet ()
	Custom designer is set. More...
bool	isFullEnabled ()
	Widget and all parent widgets are enabled. More...
bool	isMinimumSizeSet ()
bool	isPointInside (Point position)
bool	isTransformationSet ()
void	layoutParentIfBlocked ()
	Calls layoutParent if getHasBlockedLayoutParent() is true. More...
Widget	nextFocusWidget ()
	Find next widget in the focus cycle that can grab the focus. More...
void	notifyBorderParametersChanged ()
void	onDesignerChanged ()
	Designer changed. More...
void	onDesignerSelectorChanged ()
	Designer selector changed. More...
void	onDispose (WidgetEvent event)
	Window is disposing. More...
void	onFocusLost (FocusEvent event)
	Widget lost focus. More...
void	onFocusReceived (FocusEvent event)
	Widget received focus. More...
void	onFrameUpdate (float elapsed)
	Do frame update. More...
void	onGamepadButtonPressed (GamepadEvent event)
	Gamepad button has been pressed. More...
void	onGamepadButtonReleased (GamepadEvent event)
	Gamepad button has been released. More...
void	onHidden (WidgetEvent event)
	Widget has been hidden. More...
void	onParentStateChanged ()
	Parent state changed. More...
void	onParentStateChanged (bool force)
	Parent state changed. More...
void	onReposition (WidgetEvent event)
	Position changed. More...
void	onResize (WidgetEvent event)
	Size changed. More...
void	onSetFont ()
void	onSetTextColor ()
	Text color changed. More...
void	onShown (WidgetEvent event)
	Widget has been shown. More...
void	onTranslationChanged ()
	Translation manager or active language pack changed. More...
void	popdownVirtualKeyboard ()
	Popdown virtual keyboard if Desktop has one assigned. More...
void	popupVirtualKeyboard ()
	Popup virtual keyboard if Desktop has one assigned. More...
Widget	prevFocusWidget ()
	Find previous widget in the focus cycle that can grab the focus. More...
void	processEvent (Event event)
void	releaseMouse ()
void	removeDragListener (DragListener listener)
void	removeFocusListener (FocusListener listener)
	Remove focus listener. More...
void	removeGamepadListener (GamepadListener listener)
	Remove gamepad listener. More...
void	removeKeyListener (KeyListener listener)
void	removeMouseListener (MouseListener listener)
void	removeStateChangeListener (StateChangeListener listener)
	Remove state change listener. More...
void	removeWidgetListener (WidgetListener listener)
	Remove widget listener. More...
void	requestGrabFocus (Widget widget)
void	runWhileBlockingLayoutParent (Block ablock)
	Run block while layouting is blocked. More...
void	safeDispose ()
	Safely dispose of widget. More...
void	sendEvent (Event event)
void	sendEventToListeners (Event event, bool sendToParent)
	Send event to all appropriate listeners for events of its kind. More...
void	setBackgroundCanvasCreator (CanvasCreator creator)
	Set background canvas creator or null to use background color. More...
void	setBlockLayoutParent (bool blockLayoutParent)
	Set block layoutParent calls. More...
void	setBorder (Border border)
void	setCanFocus (bool canFocus)
void	setClipboard (Clipboard clipboard)
	Set clipboard or null to use parent clipboard. More...
void	setColorTransformation (ColorMatrix transformation)
	Set color transformation. More...
void	setDesigner (WidgetDesigner designer)
	Set designer. More...
void	setDesignerSelector (String selector)
	Set designer selector. More...
void	setFont (Font font)
void	setHasBlockedLayoutParent (bool hasBlockedLayoutParent)
	Set if layoutParent calls happened during runWhileBlockingLayoutParent. More...
void	setHasFocus (bool hasFocus)
void	setHeight (int height)
	Set height of widget. More...
void	setMinimumSize (Point size)
void	setPadding (BorderSize padding)
	Set padding. More...
void	setParent (Container parent)
void	setPosition (Point position)
	Set position of widget. More...
void	setProtectBackgroundCanvasCreator (bool protect)
	Set protect custom set background canvas creator. More...
void	setProtectBorder (bool protect)
	Set protect custom set border. More...
void	setProtectFont (bool protect)
	Set protect custom set font. More...
void	setProtectMinimumSize (bool protect)
	Set protect custom set minimumsize. More...
void	setProtectMousePointer (bool protect)
	Set protect custom set mouse pointer. More...
void	setProtectPadding (bool protect)
	Set protect custom set padding. More...
void	setProtectTextColor (bool protect)
	Set protect custom set text color. More...
void	setSize (Point size)
	Set size of widget. More...
void	setTextColor (Color color)
	Set text color. More...
void	setTitle (String title)
	Set widget title. More...
void	setToolTip (Object toolTip)
	Set tooltip or null. More...
void	setTransformation (TexMatrix2 transformation)
void	setTransparency (float transparency)
void	setVisible (bool visible)
void	setWidth (int width)
	Set width of widget. More...
void	setX (int x)
	Set X position of widget. More...
void	setY (int y)
	Set Y Position of widget. More...
void	startFrameUpdater ()
	Start frame updater if not running. More...
void	stopFrameUpdater ()
	Stop frame updater if running. More...

Public Attributes
bool	pBlockLayout
Point	pCachedMinSize
int	pCachedMinSizeForHeightHeight
Point	pCachedMinSizeForHeightSize
Point	pCachedMinSizeForWidthSize
int	pCachedMinSizeForWidthWidth
Array	pChildren
bool	pHasBlockedDoLayout
Layout	pLayout
bool	pStateChangeNotifyChildren
Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator	pBackgroundCanvasCreator
bool	pBlockLayoutParent
Border	pBorder
bool	pCanFocus
CanvasView	pCanvasBackground
CanvasView	pCanvasContent
CanvasView	pCanvasWidget
Clipboard	pClipboard
WidgetDesigner	pDesigner
String	pDesignerSelector
Array	pDragListeners
bool	pEnabled
Array	pFocusListeners
Font	pFont
FrameUpdater	pFrameUpdater
Array	pGamepadListeners
bool	pHasBlockedLayoutParent
bool	pHasFocus
bool	pIsDesignerSet
Array	pKeyListeners
Point	pMinSize
Array	pMouseListeners
MousePointerFactory	pMousePointer
BorderSize	pPadding
Container	pParent
Point	pPosition
bool	pProtectBackgroundCanvasCreator
bool	pProtectBorder
bool	pProtectFont
bool	pProtectMinimumSize
bool	pProtectMousePointer
bool	pProtectPadding
bool	pProtectTextColor
RepeatKeyEventTimer	pRepeatEventTimer
Point	pSize
Array	pStateChangeListeners
Color	pTextColor
GuiTheme	pTheme
String	pThemeSelector
String	pTitle
Object	pToolTip
TexMatrix2	pTransformation
TranslationManager	pTranslationManager
float	pTransparency
bool	pVisible
Array	pWidgetListeners

Additional Inherited Members
Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner	getDesignerFromTheme ()
	Get designer from gui theme. More...
void	updateCanvasBackground ()
	Update background canvas content. More...
void	updateCanvasGeometry ()
	Update canvas position and size. More...

Detailed Description

Groups child widgets arranged by a layout instance.

Member Function Documentation

addWidget() [1/2]

void Dragengine.Gui.Container.addWidget

(

Widget

widget

)

Adds a widget to this container using default settings.

Reimplemented in Dragengine.Gui.SwitchPanel, Dragengine.Gui.MenuPopup, and Dragengine.Gui.Desktop.

addWidget() [2/2]

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

Adds a widget to this container using the specified settings.

Reimplemented in Dragengine.Gui.SwitchPanel, Dragengine.Gui.MenuPopup, and Dragengine.Gui.Desktop.

allowsChildGrabFocus()

bool Dragengine.Gui.Container.allowsChildGrabFocus

(

)

Determines if the container allows child widgets to grab the focus.

Reimplemented in Dragengine.Gui.ListBox, and Dragengine.Gui.Desktop.

doLayout()

void Dragengine.Gui.Container.doLayout

(

)

Lay out widgets using the set layout. This call is protected against loops caused by layoutParent called from inside a widget being laid out. Furthermore changes to the minimum, preferred and maximum size are tracked to call layoutParent() only if required.

Reimplemented in Dragengine.Gui.Viewport, Dragengine.Gui.WindowSubTitle, and Dragengine.Gui.ScrollPanel.

findFocusableWidget()

Widget Dragengine.Gui.Container.findFocusableWidget

(

)

Find first widget that can grab the focus or null if none exists.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ListBox.

findLastFocusableWidget()

Widget Dragengine.Gui.Container.findLastFocusableWidget

(

)

Find last widget that can grab the focus or null if none exists.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ListBox.

findWidget()

Widget Dragengine.Gui.Container.findWidget

(

Block

ablock

)

Find widget using block or null if not found.

Block is called with single parameter of type Widget and has to return true to stop visiting and return widget or false to continue visiting.

getContainerHeight()

int Dragengine.Gui.Container.getContainerHeight

(

)

Retrieve height of area for child widgets excluding the padding. This calculates the the height remaining after subtracting the padding.

getContainerSize()

Point Dragengine.Gui.Container.getContainerSize

(

)

Size of area for child widgets excluding the padding. This calculates the size remaining after subtracting the padding.

getContainerWidth()

int Dragengine.Gui.Container.getContainerWidth

(

)

Retrieve width of area for child widgets excluding the padding. This calculates the the width remaining after subtracting the padding.

getHasBlockedDoLayout()

bool Dragengine.Gui.Container.getHasBlockedDoLayout

(

)

doLayout calls happened during runWhileBlockingLayout.

getLayout()

Layout Dragengine.Gui.Container.getLayout

(

)

Retrieve the layout of the container.

getMinimumSize()

Point Dragengine.Gui.Container.getMinimumSize

(

)

Returns the minimal size calculated by our layout object for this widget.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ListBox.

getMinimumSizeForHeight()

Point Dragengine.Gui.Container.getMinimumSizeForHeight

(

int

height

)

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

Default implementation uses getMinimumSize().

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ListBox.

getMinimumSizeForWidth()

Point Dragengine.Gui.Container.getMinimumSizeForWidth

(

int

width

)

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

Default implementation uses getMinimumSize().

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ListBox.

getStateChangeNotifyChildren()

bool Dragengine.Gui.Container.getStateChangeNotifyChildren

(

)

Notify children if state changed.

Version

1.5

getWidget()

Widget Dragengine.Gui.Container.getWidget

(

int

index

)

Retrieve widget at the given index position.

getWidgetAt()

Widget Dragengine.Gui.Container.getWidgetAt

(

Point

position

)

Widget at coordinates or null if not found.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.WindowToolTip, and Dragengine.Gui.WindowOverColor.

getWidgetCount()

int Dragengine.Gui.Container.getWidgetCount

(

)

Retrieve number of child widgets.

giveUpFocus()

void Dragengine.Gui.Container.giveUpFocus

(

)

Notifies that the current focus widget can no longer hold the focus.

Reimplemented in Dragengine.Gui.Desktop.

hasFocusWidget()

bool Dragengine.Gui.Container.hasFocusWidget

(

)

Focus widget is inside container somewhere.

Reimplemented in Dragengine.Gui.ListBox.

hasWidget()

bool Dragengine.Gui.Container.hasWidget

(

Widget

widget

)

Determines if the widget is part of the container.

indexOfWidget()

int Dragengine.Gui.Container.indexOfWidget

(

Widget

widget

)

Retrieves the index of the widget or -1 if not found.

injectWidget()

Object Dragengine.Gui.Container.injectWidget	(	Object	injectValue,
		Block	ablock
	)

Process value visiting widgets using block.

Works like Array.inject(). Block receives as first argument the Object injected value and as second argument Widget widget.

isChildVisible()

bool Dragengine.Gui.Container.isChildVisible

(

Widget

child

)

Determines if the given child widget is visible. This check if the widget is visible and that the widget boundaries lie inside the viewable area of the container.

isMouseInside()

bool Dragengine.Gui.Container.isMouseInside

(

)

Mouse is hovering over this widget.

Tests if the hover widget is this widget.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.MenuBarItem.

layoutParent()

void Dragengine.Gui.Container.layoutParent

(

)

Layout parent if existing. Modified version to respect layout blocking.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.Viewport, and Dragengine.Gui.Desktop.

moveWidget()

void Dragengine.Gui.Container.moveWidget	(	Widget	widget,
		int	newPosition
	)

Move widget from one position to another.

new() [1/5]

Container Dragengine.Gui.Container.new

(

)

Creates a new container.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.WindowVirtualKeyboard, Dragengine.Gui.WindowToolTip, Dragengine.Gui.WindowPopup, Dragengine.Gui.WindowOverColor, Dragengine.Gui.WindowModal, Dragengine.Gui.WindowLogo, Dragengine.Gui.WindowLoading, Dragengine.Gui.WindowGameWorld, Dragengine.Gui.WindowDialog, Dragengine.Gui.WindowConsole, Dragengine.Gui.Window, Dragengine.Gui.Viewport, Dragengine.Gui.ToggleButton, Dragengine.Gui.SwitchPanel, Dragengine.Gui.WindowSubTitle, Dragengine.Gui.SubTitleBox, Dragengine.Gui.SpinButton, Dragengine.Gui.ScrollPanel, Dragengine.Gui.PanelPlayerChoice, Dragengine.Gui.PanelHud, Dragengine.Gui.PanelFPSRates, Dragengine.Gui.Panel, Dragengine.Gui.OptionBox, Dragengine.Gui.ModManagement.MMWindowModManagement, Dragengine.Gui.MenuPopup, Dragengine.Gui.MenuItem, Dragengine.Gui.MenuBar, Dragengine.Gui.ListBox, Dragengine.Gui.PanelInteractPromptController, Dragengine.Gui.PanelInteractPrompt, Dragengine.Gui.DisplayInteractPromptEntry, Dragengine.Gui.GameRoot, Dragengine.Gui.EditModuleParametersPanel, Dragengine.Gui.ComboBox, Dragengine.Gui.CheckBox, and Dragengine.Gui.Button.

new() [2/5]

Container Dragengine.Gui.Container.new	(	int	x,
		int	y,
		int	width,
		int	height
	)

Creates a new container located at (x,y) with the given size.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.WindowModal, Dragengine.Gui.WindowDialog, Dragengine.Gui.WindowConsole, Dragengine.Gui.Window, Dragengine.Gui.WindowSettings, Dragengine.Gui.Panel, and Dragengine.Gui.Desktop.

new() [3/5]

Container Dragengine.Gui.Container.new

(

Layout

layout

)

Create container with layout.

Reimplemented in Dragengine.Gui.Panel.

new() [4/5]

Container Dragengine.Gui.Container.new	(	Layout	layout,
		Block	blockAddContent
	)

Create container with layout calling block to add content.

Block receives container as argument. Block call is wrapped inside runWhileBlockingLayout() for efficiency. doLayout() will be called after leaving the block.

Reimplemented in Dragengine.Gui.Panel.

new() [5/5]

Container Dragengine.Gui.Container.new	(	Point	position,
		Point	size
	)

Creates a new container located at (x,y) with the given size.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.Window.

nextFocusWidgetAfter()

Widget Dragengine.Gui.Container.nextFocusWidgetAfter

(

Widget

widget

)

Find next widget in the focus cycle that can grab the focus.

Reimplemented in Dragengine.Gui.Window, and Dragengine.Gui.ListBox.

onGuiThemeChanged()

void Dragengine.Gui.Container.onGuiThemeChanged

(

)

Notification that the gui theme changed.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.WindowConsole, Dragengine.Gui.Window, Dragengine.Gui.SpinButton, Dragengine.Gui.ModManagement.MMPanelModInfo, Dragengine.Gui.ListBox, Dragengine.Gui.ComboBox, and Dragengine.Gui.Button.

onPaddingChanged()

void Dragengine.Gui.Container.onPaddingChanged

(

)

Padding changed.

Reimplemented from Dragengine.Gui.Widget.

onStateChanged()

void Dragengine.Gui.Container.onStateChanged

(

StateChangeEvent

event

)

State changed.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ListBox, and Dragengine.Gui.BgButton.

prevFocusWidgetAfter()

Widget Dragengine.Gui.Container.prevFocusWidgetAfter

(

Widget

widget

)

Find previous widget in the focus cycle that can grab the focus.

Reimplemented in Dragengine.Gui.Window, and Dragengine.Gui.ListBox.

removeAllWidgets()

void Dragengine.Gui.Container.removeAllWidgets

(

)

Remove and dispose all widgets.

Reimplemented in Dragengine.Gui.SwitchPanel, Dragengine.Gui.SpinButton, and Dragengine.Gui.Desktop.

removeWidget()

void Dragengine.Gui.Container.removeWidget

(

Widget

widget

)

Remove widget without disposing.

Reimplemented in Dragengine.Gui.SwitchPanel, Dragengine.Gui.GameRoot, and Dragengine.Gui.Desktop.

requestCaptureMouse()

bool Dragengine.Gui.Container.requestCaptureMouse

(

Widget

widget

)

Request to capture the mouse for the specified widget. Returns true if the request has been accepted.

Reimplemented in Dragengine.Gui.Desktop.

requestReleaseMouse()

bool Dragengine.Gui.Container.requestReleaseMouse

(

Widget

widget

)

Request to release mouse capture. Returns true if the request has been accepted.

Reimplemented in Dragengine.Gui.WindowPopup, Dragengine.Gui.Desktop, and Dragengine.Gui.ComboBox.

runWhileBlockingLayout()

void Dragengine.Gui.Container.runWhileBlockingLayout

(

Block

ablock

)

Run block while layouting is blocked.

This method is useful when you have to add or remove multiple widgets avoiding layout calls to be done for each modification except once to avoid performance loss. The method ensures the blocking state is restored to the value present before even in case of exceptions. You still have to call doLayout() to trigger an update after returning from the method call. This method call can be nested safely.

setEnabled()

void Dragengine.Gui.Container.setEnabled

(

bool

enabled

)

Set if widget is enabled.

Reimplemented from Dragengine.Gui.Widget.

setHasBlockedDoLayout()

void Dragengine.Gui.Container.setHasBlockedDoLayout

(

bool

hasBlockedDoLayout

)

Set if doLayout calls happened during runWhileBlockingLayout.

setLayout()

void Dragengine.Gui.Container.setLayout

(

Layout

layout

)

Set layout.

setMousePointer()

void Dragengine.Gui.Container.setMousePointer

(

MousePointerFactory

mousePointer

)

Set mouse pointer to use.

If widget has no mouse pointer the parent mouse pointer is used.

Reimplemented from Dragengine.Gui.Widget.

setStateChangeNotifyChildren()

void Dragengine.Gui.Container.setStateChangeNotifyChildren

(

bool

notify

)

Set to notify children if state changed.

Version

1.5

Member Data Documentation

pBlockLayout

bool Dragengine.Gui.Container.pBlockLayout

pCachedMinSize

Point Dragengine.Gui.Container.pCachedMinSize

pCachedMinSizeForHeightHeight

int Dragengine.Gui.Container.pCachedMinSizeForHeightHeight

pCachedMinSizeForHeightSize

Point Dragengine.Gui.Container.pCachedMinSizeForHeightSize

pCachedMinSizeForWidthSize

Point Dragengine.Gui.Container.pCachedMinSizeForWidthSize

pCachedMinSizeForWidthWidth

int Dragengine.Gui.Container.pCachedMinSizeForWidthWidth

pChildren

Array Dragengine.Gui.Container.pChildren

pHasBlockedDoLayout

bool Dragengine.Gui.Container.pHasBlockedDoLayout

pLayout

Layout Dragengine.Gui.Container.pLayout

pStateChangeNotifyChildren

bool Dragengine.Gui.Container.pStateChangeNotifyChildren

---

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

• Container.ds