interface IWidgetBounds in Tinman.AddOns.Widgets

Base interface for classes that compute pixel bounds of IWidget objects.

interface	IWidgetBounds	extends	IVersioned
		base of	WidgetBounds

Attributes

Version

Returns the current version of object.

property	Version { get }
type	int32
value		The current version number.
inherited	IVersioned.Version

Remarks:

For each modification, the version is incremented by at least one.

Methods

ComputeWidgetBounds

Returns the pixel bounds of the widget on the render target surface.

method	ComputeWidgetBounds (int32 width, int32 height)
type	Box2I
params	width	[>0]	The screen width (see ScreenWidth).
	height	[>0]	The screen height (see ScreenWidth).
returns			The pixel bounds.

Remarks:

This method called once during GraphicsAttach.

Padding

Adjust the widget bounds by padding its edges.

method	Padding (int32 top, int32 left, int32 bottom, int32 right)
type	IWidgetBounds
params	top		Padding amount at top edge.
	left		Padding amount at left edge.
	bottom		Padding amount at bottom edge.
	right		Padding amount at right edge.
returns		[not-null]	The resulting widget bounds.

Extensions

Grid

Divides the widget bounds into a regular grid and fits the widget into the given cell.

method	Grid (int32 countX, int32 countY, int32 x, int32 y)
type	IWidgetBounds
params	countX	[>0]	Number of grid columns.
	countY	[>0]	Number of grid rows.
	x	[0..countX-1]	Column index of grid cell.
	y	[0..countY-1]	Row index of grid cell.
returns		[not-null]	The resulting widget bounds.

Padding

Adjust the widget bounds by padding its edges.

method	Padding (int32 padding)
type	IWidgetBounds
params	padding	[>=0]	Padding amount at each edge.
returns		[not-null]	The resulting widget bounds.

Split

method	Split (bool first)
type	IWidgetBounds
params	first