API Docs (pts)

Back to index...

Name	Type	Description
Layout		A UI element of type Layout or derived from Layout.
Layout.Event:Move		Signals that the frame's vertices have moved.
Layout.Event:Size		Signals that the frame's size has changed.
Layout:EventAttach	function	Attaches an event handler to an event.
Layout:EventDetach	function	Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Layout:EventList	function	Lists the current event handlers for an event.
Layout:EventMacroGet	function	Gets the macro that will be triggered when this event occurs.
Layout:EventMacroSet	function	Sets the macro that will be triggered when this event occurs.
Layout:GetBottom	function	Retrieves the Y position of the bottom edge of this element.
Layout:GetBounds	function	Retrieves the complete bounds of this element.
Layout:GetEventTable	function	Retrieves the event table of this element. By default, this value is also stored in "this.Event".
Layout:GetHeight	function	Retrieves the height of this element.
Layout:GetLeft	function	Retrieves the X position of the left edge of this element.
Layout:GetName	function	Retrieves the name of this element.
Layout:GetOwner	function	Retrieves the owner of this element.
Layout:GetRight	function	Retrieves the X position of the right edge of this element.
Layout:GetTop	function	Retrieves the Y position of the top edge of this element.
Layout:GetType	function	Retrieves the type of this element.
Layout:GetWidth	function	Retrieves the width of this element.
Layout:ReadAll	function	Read all set points and sizes from this frame.
Layout:ReadHeight	function	Read a set height from this frame.
Layout:ReadPoint	function	Read a set point from this frame. Must be given a single-axis coordinate.
Layout:ReadWidth	function	Read a set width from this frame.

Layout

A UI element of type Layout or derived from Layout.

Layout.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Layout.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Layout:EventAttach

Attaches an event handler to an event.

Usage:

Parameter	Type	Datatype	Description
Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
callback	parameter	function	A global event handler function. This will be called when the event fires. The first parameter will be the standard frame event handle, any other parameters will follow that.
handle	parameter	eventFrame	A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
label	parameter	string	Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priority	parameter	number	Priority of the event handler. Higher numbers trigger first.

noSecureFrameAndEnvironment: true

Layout:EventDetach

Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a wildcard. If multiple events match the constraints, only one will be detached.

Usage:

Parameter	Type	Datatype	Description
Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
callback	parameter	function/nil	A callback function to search for.
handle	parameter	eventFrame	A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
label	parameter	string/nil	Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
owner	parameter	string/nil	Owner to search for.
priority	parameter	number/nil	Priority of the event handler. Higher numbers trigger first.

Layout:EventList

Lists the current event handlers for an event.

Usage:

Parameter	Type	Datatype	Description
result = Layout:EventList(handle)
handle	parameter	eventFrame	A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
result	result	table	A table of event handlers for this event.

members

handler	The handler that will be called when the event fires.
label	Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro	The macro that will run when the event fires.
owner	Owner to search for.
priority	Priority of the event handler. Higher numbers trigger first.

Layout:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

Parameter	Type	Datatype	Description
macro = Layout:EventMacroGet(handle)
handle	parameter	eventFrame	A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macro	result	string/nil	The macro that will be triggered.

Layout:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Parameter	Type	Datatype	Description
Layout:EventMacroSet(handle, macro)
handle	parameter	eventFrame	A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macro	parameter	string/nil	The macro to trigger. nil to clear the macro.

requireSecureFrameAndInsecureEnvironment: true

Layout:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

Parameter	Type	Datatype	Description
bottom = Layout:GetBottom()
bottom	result	number	The Y position of the bottom edge of this element.

Layout:GetBounds

Retrieves the complete bounds of this element.

Usage:

Parameter	Type	Datatype	Description
left, top, right, bottom = Layout:GetBounds()
bottom	result	number	The Y position of the bottom edge of this element.
left	result	number	The X position of the left edge of this element.
right	result	number	The X position of the right edge of this element.
top	result	number	The Y position of the top edge of this element.

Layout:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

Parameter	Type	Datatype	Description
eventTable = Layout:GetEventTable()
eventTable	result	table	The event table of this element.

Layout:GetHeight

Retrieves the height of this element.

Usage:

Parameter	Type	Datatype	Description
height = Layout:GetHeight()
height	result	number	The height of this element.

Layout:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

Parameter	Type	Datatype	Description
left = Layout:GetLeft()
left	result	number	The X position of the left edge of this element.

Layout:GetName

Retrieves the name of this element.

Usage:

Parameter	Type	Datatype	Description
name = Layout:GetName()
name	result	string	The name of this element, as provided by the addon that created it.

Layout:GetOwner

Retrieves the owner of this element.

Usage:

Parameter	Type	Datatype	Description
owner = Layout:GetOwner()
owner	result	string	The owner of this element. Given as an addon identifier.

Layout:GetRight

Retrieves the X position of the right edge of this element.

Usage:

Parameter	Type	Datatype	Description
right = Layout:GetRight()
right	result	number	The X position of the right edge of this element.

Layout:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

Parameter	Type	Datatype	Description
top = Layout:GetTop()
top	result	number	The Y position of the top edge of this element.

Layout:GetType

Retrieves the type of this element.

Usage:

Parameter	Type	Datatype	Description
type = Layout:GetType()
type	result	string	The type of this element.

Layout:GetWidth

Retrieves the width of this element.

Usage:

Parameter	Type	Datatype	Description
width = Layout:GetWidth()
width	result	number	The width of this element.

Layout:ReadAll

Read all set points and sizes from this frame.

Usage:

Parameter	Type	Datatype	Description
results = Layout:ReadAll()
results	result	table	Result table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

Layout:ReadHeight

Read a set height from this frame.

Usage:

Parameter	Type	Datatype	Description
height = Layout:ReadHeight()
height	result	number	The parameter passed to SetHeight(), or nil if no such parameter has been passed.

Layout:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

Parameter	Type	Datatype	Description
layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
coordinate	parameter	string	Named coordinate. Must be a one-axis coordinate.
x	parameter	number/nil	X coordinate of the point. Either this or Y must be nil.
y	parameter	number/nil	Y coordinate of the point. Either this or X must be nil.
layout	result	Layout	The table that this point is pinned to.
offset	result	number	The offset in pixels from the source location to the actual location.
origin	result	string	The string "origin".
position	result	number	The position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

Layout:ReadWidth

Read a set width from this frame.

Usage:

Parameter	Type	Datatype	Description
width = Layout:ReadWidth()
width	result	number	The parameter passed to SetWidth(), or nil if no such parameter has been passed.