API Docs (pts)

Back to index...

Name	Type	Deprecated	Description
Text			A UI element of type Text or derived from Text.
Text.Event:KeyDown			Signals a key pressed.
Text.Event:KeyFocusGain			Signals gaining key focus.
Text.Event:KeyFocusLoss			Signals losing key focus.
Text.Event:KeyRepeat			Frame.Event:KeyRepeat@summary
Text.Event:KeyType			Signals text typed.
Text.Event:KeyUp			Signals a key released.
Text.Event:Layer			Signals a change in the item's layer.
Text.Event:LeftClick			Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
Text.Event:LeftDown			Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
Text.Event:LeftUp			Signals that the mouse's left button has been released inside the frame. Blocks left mouse events...
Text.Event:LeftUpoutside			Signals that the mouse's left button has been released outside the frame, after a "Down" message....
Text.Event:MiddleClick			Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
Text.Event:MiddleDown			Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
Text.Event:MiddleUp			Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
Text.Event:MiddleUpoutside			Signals that the mouse's middle button has been released outside the frame, after a "Down" messag...
Text.Event:Mouse4Click			Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
Text.Event:Mouse4Down			Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
Text.Event:Mouse4Up			Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
Text.Event:Mouse4Upoutside			Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
Text.Event:Mouse5Click			Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
Text.Event:Mouse5Down			Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
Text.Event:Mouse5Up			Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
Text.Event:Mouse5Upoutside			Signals that the mouse's fifth button has been released outside the frame, after a "Down" message...
Text.Event:MouseIn			Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
Text.Event:MouseMove			Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
Text.Event:MouseOut			Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
Text.Event:Move			Signals that the frame's vertices have moved.
Text.Event:RightClick			Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
Text.Event:RightDown			Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
Text.Event:RightUp			Signals that the mouse's right button has been released inside the frame. Blocks right mouse even...
Text.Event:RightUpoutside			Signals that the mouse's right button has been released outside the frame, after a "Down" message...
Text.Event:Size			Signals that the frame's size has changed.
Text.Event:Strata			Signals a change in the item's strata.
Text.Event:WheelBack			Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
Text.Event:WheelForward			Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
Text:ClearAll	function		Clear all set points and sizes from this frame.
Text:ClearHeight	function		Clear a set height from this frame.
Text:ClearPoint	function		Clear a set point from this frame.
Text:ClearWidth	function		Clear a set width from this frame.
Text:EventAttach	function		Attaches an event handler to an event.
Text:EventDetach	function		Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Text:EventList	function		Lists the current event handlers for an event.
Text:EventMacroGet	function		Gets the macro that will be triggered when this event occurs.
Text:EventMacroSet	function		Sets the macro that will be triggered when this event occurs.
Text:GetAlpha	function		Gets the alpha multiplier of this frame.
Text:GetBackgroundColor	function		Retrieves the background color of this frame.
Text:GetBottom	function		Retrieves the Y position of the bottom edge of this element.
Text:GetBounds	function		Retrieves the complete bounds of this element.
Text:GetChildren	function		Returns a table containing all of this element's children.
Text:GetEffectBlur	function		Gets the current parameters for the Blur effect.
Text:GetEffectGlow	function		Gets the current parameters for the Glow effect.
Text:GetEventTable	function		Retrieves the event table of this element. By default, this value is also stored in "this.Event".
Text:GetFont	function		Gets the current font used for this element.
Text:GetFontColor	function		Gets the current font color for this element.
Text:GetFontSize	function		Gets the font size of the current element.
Text:GetFullHeight	function	deprecated	Get the height that would be required for this element to display all lines of text.
Text:GetFullWidth	function	deprecated	Get the width that would be required for this element to avoid word wrapping or truncation.
Text:GetHeight	function		Retrieves the height of this element.
Text:GetKeyFocus	function		Gets the key focus status.
Text:GetLayer	function		Gets the frame's layer order.
Text:GetLeft	function		Retrieves the X position of the left edge of this element.
Text:GetMouseMasking	function		Get the current mouse masking mode. See SetMouseMasking for details.
Text:GetMouseoverUnit	function		Gets the unit that is being represented by this frame.
Text:GetName	function		Retrieves the name of this element.
Text:GetOwner	function		Retrieves the owner of this element.
Text:GetParent	function		Gets the parent of this frame.
Text:GetRight	function		Retrieves the X position of the right edge of this element.
Text:GetSecureMode	function		Get the current secure mode. See SetSecureMode for details.
Text:GetStrata	function		Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
Text:GetStrataList	function		Gets a list of valid stratas for this frame.
Text:GetText	function		Get the current text for this element.
Text:GetTop	function		Retrieves the Y position of the top edge of this element.
Text:GetType	function		Retrieves the type of this element.
Text:GetVisible	function		Gets the visibility flag for this frame.
Text:GetWidth	function		Retrieves the width of this element.
Text:GetWordwrap	function		Gets the wordwrap flag for this element.
Text:ReadAll	function		Read all set points and sizes from this frame.
Text:ReadHeight	function		Read a set height from this frame.
Text:ReadPoint	function		Read a set point from this frame. Must be given a single-axis coordinate.
Text:ReadWidth	function		Read a set width from this frame.
Text:ResizeToText	function	deprecated	Sets the element's width and height to display all text without wordwrapping or truncation.
Text:SetAllPoints	function		Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
Text:SetAlpha	function		Sets the alpha transparency multiplier for this frame and its children.
Text:SetBackgroundColor	function		Sets the background color of this frame.
Text:SetEffectBlur	function		Sets the parameters for the Blur effect.
Text:SetEffectGlow	function		Sets the parameters for the Glow effect.
Text:SetFont	function		Sets the current font used for this element.
Text:SetFontColor	function		Sets the current font color for this element.
Text:SetFontSize	function		Sets the current font size of this element.
Text:SetHeight	function		Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
Text:SetKeyFocus	function		Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
Text:SetLayer	function		Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
Text:SetMouseMasking	function		Sets the frame's mouse masking mode.
Text:SetMouseoverUnit	function		Sets the unit that will be represented by this frame.
Text:SetParent	function		Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
Text:SetPoint	function		Pins a point on this frame to a location on another frame. This is a rather complex function and ...
Text:SetSecureMode	function		Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ...
Text:SetStrata	function		Sets the strata for this frame.
Text:SetText	function		Sets the current text for this element.
Text:SetVisible	function		Sets the frame's visibility flag. If set to false, then this frame and all its children will not ...
Text:SetWidth	function		Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
Text:SetWordwrap	function		Sets the wordwrap flag for this element.

Text

A UI element of type Text or derived from Text.

Text.Event:KeyDown

Signals a key pressed.

Usage:

Parameter	Type	Datatype	Description
Frame.Event:KeyDown(button)
button	parameter	variant	The key, in string form.

Text.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

Text.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

Text.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Parameter	Type	Datatype	Description
Frame.Event:KeyRepeat(button)
button	parameter	variant	The key, in string form.

Text.Event:KeyType

Signals text typed.

Usage:

Parameter	Type	Datatype	Description
Frame.Event:KeyType(typed)
typed	parameter	variant	The text.

Text.Event:KeyUp

Signals a key released.

Usage:

Parameter	Type	Datatype	Description
Frame.Event:KeyUp(button)
button	parameter	variant	The key, in string form.

Text.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

Text.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

Text.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

Text.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

Text.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

Text.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

Text.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

Text.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

Text.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

Text.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

Text.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

Text.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

Text.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

Text.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

Text.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

Text.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

Text.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

Text.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Parameter	Type	Datatype	Description
Frame.Event:MouseMove(x, y)
x	parameter	variant	X coordinate.
y	parameter	<nope>	Y coordinate.

Text.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

Text.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Text.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

Text.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

Text.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

Text.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

Text.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Text.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

Text.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

Text.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

Text:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()

noSecureFrameAndEnvironment: true

Text:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()

noSecureFrameAndEnvironment: true

Text:ClearPoint

Clear a set point from this frame.

Usage:

Parameter	Type	Datatype	Description
Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
coordinate	parameter	string	Named coordinate.
x	parameter	number/nil	X coordinate of the point.
y	parameter	number/nil	Y coordinate of the point.

noSecureFrameAndEnvironment: true

Text:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()

noSecureFrameAndEnvironment: true

Text: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

Text: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.

Text: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.

Text: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.

Text: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

Text:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

Parameter	Type	Datatype	Description
alpha = Element:GetAlpha()
alpha	result	number	The alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

Text:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

Parameter	Type	Datatype	Description
r, g, b, a = Element:GetBackgroundColor()
a	result	number	Alpha. 1 is fully opaque, 0 is fully transparent.
b	result	number	Blue.
g	result	number	Green.
r	result	number	Red.

Text: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.

Text: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.

Text:GetChildren

Returns a table containing all of this element's children.

Usage:

Parameter	Type	Datatype	Description
children = Element:GetChildren()
children	result	table	A table containing this element's children.

Text:GetEffectBlur

Gets the current parameters for the Blur effect.

Usage:

Parameter	Type	Datatype	Description
effect = Text:GetEffectBlur()
effect	result	nil, table	The current parameters for this effect. All members are optional. Pass nil to disable the effect.

members

blurX	Controls how much blurring exists along the X axis. Defaults to 2.
blurY	Controls how much blurring exists along the Y axis. Defaults to 2.

Text:GetEffectGlow

Gets the current parameters for the Glow effect.

Usage:

Parameter	Type	Datatype	Description
effect = Text:GetEffectGlow()
effect	result	nil, table	The current parameters for this effect. All members are optional. Pass nil to disable the effect.

members

blurX	Controls how much blurring exists along the X axis. Defaults to 2.
blurY	Controls how much blurring exists along the Y axis. Defaults to 2.
colorA	Controls the alpha channel of the glow effect. Defaults to 1.
colorB	Controls the blue channel of the glow effect. Defaults to 0.
colorG	Controls the green channel of the glow effect. Defaults to 0.
colorR	Controls the red channel of the glow effect. Defaults to 0.
knockout	Enables the "knockout" effect. Defaults to false.
offsetX	Controls the glow offset along the X axis. Defaults to 0.
offsetY	Controls the glow offset along the Y axis. Defaults to 0.
replace	Hides the original text. Defaults to false.
strength	Controls the strength of the glow. Defaults to 1.

Text: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.

Text:GetFont

Gets the current font used for this element.

Usage:

Parameter	Type	Datatype	Description
source, font = Text:GetFont()
font	result	string	The actual font identifier. Either a resource identifier or a filename.
source	result	string	The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.

Text:GetFontColor

Gets the current font color for this element.

Usage:

Parameter	Type	Datatype	Description
r, g, b, a = Text:GetFontColor()
a	result	number	Alpha. 1 is fully opaque, 0 is fully transparent.
b	result	number	Blue.
g	result	number	Green.
r	result	number	Red.

Text:GetFontSize

Gets the font size of the current element.

Usage:

Parameter	Type	Datatype	Description
fontsize = Text:GetFontSize()
fontsize	result	number	The current font size of this element.

Text:GetFullHeight

Get the height that would be required for this element to display all lines of text.

Usage:

Parameter	Type	Datatype	Description
height = Text:GetFullHeight()
height	result	number	The element height needed to display all lines of text.

deprecated: hard
disabled: true

Text:GetFullWidth

Get the width that would be required for this element to avoid word wrapping or truncation.

Usage:

Parameter	Type	Datatype	Description
width = Text:GetFullWidth()
width	result	number	The element width needed to avoid word wrapping or truncation.

deprecated: hard
disabled: true

Text:GetHeight

Retrieves the height of this element.

Usage:

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

Text:GetKeyFocus

Gets the key focus status.

Usage:

Parameter	Type	Datatype	Description
focus = Element:GetKeyFocus()
focus	result	boolean	Whether this frame is the current key focus.

Text:GetLayer

Gets the frame's layer order.

Usage:

Parameter	Type	Datatype	Description
layer = Frame:GetLayer()
layer	result	number	The render layer of this frame. See Frame:SetLayer for details.

Text: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.

Text:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

Parameter	Type	Datatype	Description
mask = Element:GetMouseMasking()
mask	result	string	The current mouse masking mode.

Text:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

Parameter	Type	Datatype	Description
unit = Frame:GetMouseoverUnit()
unit	result	string	The current mouseover unit. May be nil if there is no mouseover unit.

Text: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.

Text: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.

Text:GetParent

Gets the parent of this frame.

Usage:

Parameter	Type	Datatype	Description
parent = Frame:GetParent()
parent	result	Element	The parent element of this frame.

Text: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.

Text:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

Parameter	Type	Datatype	Description
secure = Frame:GetSecureMode()
secure	result	string	The current secure mode.

Text:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

Parameter	Type	Datatype	Description
strata = Frame:GetStrata()
strata	result	string	The item's current strata.

Text:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

Parameter	Type	Datatype	Description
stratas = Frame:GetStrataList()
stratas	result	table	An array of valid stratas, in order.

Text:GetText

Get the current text for this element.

Usage:

Parameter	Type	Datatype	Description
text, html = Text:GetText()
html	result	boolean	The current HTML flag.
text	result	string	The current text of the element.

Text: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.

Text:GetType

Retrieves the type of this element.

Usage:

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

Text:GetVisible

Gets the visibility flag for this frame.

Usage:

Parameter	Type	Datatype	Description
visible = Element:GetVisible()
visible	result	boolean	This frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

Text:GetWidth

Retrieves the width of this element.

Usage:

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

Text:GetWordwrap

Gets the wordwrap flag for this element.

Usage:

Parameter	Type	Datatype	Description
wordwrap = Text:GetWordwrap()
wordwrap	result	boolean	The current wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.

Text: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)}.

Text: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.

Text: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.

Text: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.

Text:ResizeToText

Sets the element's width and height to display all text without wordwrapping or truncation.

Usage:

Text:ResizeToText()

deprecated: hard
noSecureFrameAndEnvironment: true
disabled: true

Text:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Parameter	Type	Datatype	Description
Frame:SetAllPoints()
Frame:SetAllPoints(target)
target	parameter	Layout	Target Layout to pin this frame's edges to.

noSecureFrameAndEnvironment: true

Text:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Parameter	Type	Datatype	Description
Element:SetAlpha(alpha)
alpha	parameter	number	The new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

Text:SetBackgroundColor

Sets the background color of this frame.

Usage:

Parameter	Type	Datatype	Description
Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
a	parameter	number	Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
b	parameter	number	Blue.
g	parameter	number	Green.
r	parameter	number	Red.

Text:SetEffectBlur

Sets the parameters for the Blur effect.

Usage:

Parameter	Type	Datatype	Description
Text:SetEffectBlur(effect)
effect	parameter	nil, table	The parameters for this effect. All members are optional. Pass nil to disable the effect.

members

blurX	Controls how much blurring exists along the X axis. Defaults to 2.
blurY	Controls how much blurring exists along the Y axis. Defaults to 2.

Text:SetEffectGlow

Sets the parameters for the Glow effect.

Usage:

Parameter	Type	Datatype	Description
Text:SetEffectGlow(effect)
effect	parameter	nil, table	The parameters for this effect. All members are optional. Pass nil to disable the effect.

members

blurX	Controls how much blurring exists along the X axis. Defaults to 2.
blurY	Controls how much blurring exists along the Y axis. Defaults to 2.
colorA	Controls the alpha channel of the glow effect. Defaults to 1.
colorB	Controls the blue channel of the glow effect. Defaults to 0.
colorG	Controls the green channel of the glow effect. Defaults to 0.
colorR	Controls the red channel of the glow effect. Defaults to 0.
knockout	Enables the "knockout" effect. Defaults to false.
offsetX	Controls the glow offset along the X axis. Defaults to 0.
offsetY	Controls the glow offset along the Y axis. Defaults to 0.
replace	Hides the original text. Defaults to false.
strength	Controls the strength of the glow. Defaults to 1.

Text:SetFont

Sets the current font used for this element.

Usage:

Parameter	Type	Datatype	Description
Text:SetFont(source, font)
font	parameter	string	The actual font identifier. Either a resource identifier or a filename.
source	parameter	string	The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.

Text:SetFontColor

Sets the current font color for this element.

Usage:

Parameter	Type	Datatype	Description
Text:SetFontColor(r, g, b)
Text:SetFontColor(r, g, b, a)
a	parameter	number	Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
b	parameter	number	Blue.
g	parameter	number	Green.
r	parameter	number	Red.

Text:SetFontSize

Sets the current font size of this element.

Usage:

Parameter	Type	Datatype	Description
Text:SetFontSize(fontsize)
fontsize	parameter	number	The new font size of this element.

Text:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Parameter	Type	Datatype	Description
Frame:SetHeight(height)
height	parameter	number	The new height of this frame.

noSecureFrameAndEnvironment: true

Text:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Parameter	Type	Datatype	Description
Element:SetKeyFocus(focus)
focus	parameter	boolean	The new key focus setting.

Text:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Parameter	Type	Datatype	Description
Frame:SetLayer(layer)
layer	parameter	number	The new layer for this frame.

noSecureFrameAndEnvironment: true

Text:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Parameter	Type	Datatype	Description
Element:SetMouseMasking(mask)
mask	parameter	string	The new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.

noSecureFrameAndEnvironment: true

Text:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Parameter	Type	Datatype	Description
Frame:SetMouseoverUnit(unit)
unit	parameter	nil, unit	The new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.

requireSecureFrameAndInsecureEnvironment: true

Text:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Parameter	Type	Datatype	Description
Frame:SetParent(parent)
parent	parameter	Element	The new parent for this frame.

noSecureFrameAndEnvironment: true

Text:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Parameter	Type	Datatype	Description
Frame:SetPoint(...)
...	parameter	...	This function's parameters are complicated. Read the above summary for details.

noSecureFrameAndEnvironment: true

Text:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Parameter	Type	Datatype	Description
Frame:SetSecureMode(secure)
secure	parameter	string	The new secure mode. Valid inputs are "normal" and "restricted".

Text:SetStrata

Sets the strata for this frame.

Usage:

Parameter	Type	Datatype	Description
Frame:SetStrata(strata)
strata	parameter	string	The item's new strata. Must be one of the elements returned by :GetStrataList().

noSecureFrameAndEnvironment: true

Text:SetText

Sets the current text for this element.

Usage:

Parameter	Type	Datatype	Description
Text:SetText(text)
Text:SetText(text, html)
html	parameter	boolean	Enables HTML mode. In HTML mode, a limited number of formatting tags are available: <u>, <font color="#rrggbb">, and <a lua="print('This is a lua script.')">.
text	parameter	string	The new text for the element.

Text:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Parameter	Type	Datatype	Description
Element:SetVisible(visible)
visible	parameter	boolean	The new visibility flag.

noSecureFrameAndEnvironment: true

Text:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Parameter	Type	Datatype	Description
Frame:SetWidth(width)
width	parameter	number	The new width of this frame.

noSecureFrameAndEnvironment: true

Text:SetWordwrap

Sets the wordwrap flag for this element.

Usage:

Parameter	Type	Datatype	Description
Text:SetWordwrap(wordwrap)
wordwrap	parameter	boolean	The new wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.