API Docs (pts)

Back to index...

Name	Type	Description
RiftWindowBorder.Event:KeyDown		Signals a key pressed.
RiftWindowBorder.Event:KeyFocusGain		Signals gaining key focus.
RiftWindowBorder.Event:KeyFocusLoss		Signals losing key focus.
RiftWindowBorder.Event:KeyRepeat		Frame.Event:KeyRepeat@summary
RiftWindowBorder.Event:KeyType		Signals text typed.
RiftWindowBorder.Event:KeyUp		Signals a key released.
RiftWindowBorder.Event:LeftClick		Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftWindowBorder.Event:LeftDown		Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftWindowBorder.Event:LeftUp		Signals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftWindowBorder.Event:LeftUpoutside		Signals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftWindowBorder.Event:MiddleClick		Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftWindowBorder.Event:MiddleDown		Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftWindowBorder.Event:MiddleUp		Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftWindowBorder.Event:MiddleUpoutside		Signals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftWindowBorder.Event:Mouse4Click		Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftWindowBorder.Event:Mouse4Down		Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftWindowBorder.Event:Mouse4Up		Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftWindowBorder.Event:Mouse4Upoutside		Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftWindowBorder.Event:Mouse5Click		Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftWindowBorder.Event:Mouse5Down		Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftWindowBorder.Event:Mouse5Up		Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftWindowBorder.Event:Mouse5Upoutside		Signals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftWindowBorder.Event:MouseIn		Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftWindowBorder.Event:MouseMove		Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftWindowBorder.Event:MouseOut		Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftWindowBorder.Event:Move		Signals that the frame's vertices have moved.
RiftWindowBorder.Event:RightClick		Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftWindowBorder.Event:RightDown		Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftWindowBorder.Event:RightUp		Signals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftWindowBorder.Event:RightUpoutside		Signals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftWindowBorder.Event:Size		Signals that the frame's size has changed.
RiftWindowBorder.Event:WheelBack		Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftWindowBorder.Event:WheelForward		Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftWindowBorder:EventAttach	function	Attaches an event handler to an event.
RiftWindowBorder:EventDetach	function	Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftWindowBorder:EventList	function	Lists the current event handlers for an event.
RiftWindowBorder:EventMacroGet	function	Gets the macro that will be triggered when this event occurs.
RiftWindowBorder:EventMacroSet	function	Sets the macro that will be triggered when this event occurs.
RiftWindowBorder:GetAlpha	function	Gets the alpha multiplier of this frame.
RiftWindowBorder:GetBackgroundColor	function	Retrieves the background color of this frame.
RiftWindowBorder:GetBottom	function	Retrieves the Y position of the bottom edge of this element.
RiftWindowBorder:GetBounds	function	Retrieves the complete bounds of this element.
RiftWindowBorder:GetChildren	function	Returns a table containing all of this element's children.
RiftWindowBorder:GetEventTable	function	Retrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftWindowBorder:GetHeight	function	Retrieves the height of this element.
RiftWindowBorder:GetKeyFocus	function	Gets the key focus status.
RiftWindowBorder:GetLeft	function	Retrieves the X position of the left edge of this element.
RiftWindowBorder:GetMouseMasking	function	Get the current mouse masking mode. See SetMouseMasking for details.
RiftWindowBorder:GetName	function	Retrieves the name of this element.
RiftWindowBorder:GetOwner	function	Retrieves the owner of this element.
RiftWindowBorder:GetRight	function	Retrieves the X position of the right edge of this element.
RiftWindowBorder:GetTop	function	Retrieves the Y position of the top edge of this element.
RiftWindowBorder:GetType	function	Retrieves the type of this element.
RiftWindowBorder:GetVisible	function	Gets the visibility flag for this frame.
RiftWindowBorder:GetWidth	function	Retrieves the width of this element.
RiftWindowBorder:ReadAll	function	Read all set points and sizes from this frame.
RiftWindowBorder:ReadHeight	function	Read a set height from this frame.
RiftWindowBorder:ReadPoint	function	Read a set point from this frame. Must be given a single-axis coordinate.
RiftWindowBorder:ReadWidth	function	Read a set width from this frame.
RiftWindowBorder:SetAlpha	function	Sets the alpha transparency multiplier for this frame and its children.
RiftWindowBorder:SetBackgroundColor	function	Sets the background color of this frame.
RiftWindowBorder:SetKeyFocus	function	Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftWindowBorder:SetMouseMasking	function	Sets the frame's mouse masking mode.
RiftWindowBorder:SetVisible	function	Sets the frame's visibility flag. If set to false, then this frame and all its children will not ...

RiftWindowBorder.Event:KeyDown

Signals a key pressed.

Usage:

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

RiftWindowBorder.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

RiftWindowBorder.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

RiftWindowBorder.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

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

RiftWindowBorder.Event:KeyType

Signals text typed.

Usage:

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

RiftWindowBorder.Event:KeyUp

Signals a key released.

Usage:

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

RiftWindowBorder.Event:LeftClick

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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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.

RiftWindowBorder.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()

RiftWindowBorder.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.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()

RiftWindowBorder.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

RiftWindowBorder.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()

RiftWindowBorder.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()

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

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

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

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

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

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

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

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

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

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

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

RiftWindowBorder:GetHeight

Retrieves the height of this element.

Usage:

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

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

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

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

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

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

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

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

RiftWindowBorder:GetType

Retrieves the type of this element.

Usage:

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

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

RiftWindowBorder:GetWidth

Retrieves the width of this element.

Usage:

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

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

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

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

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

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

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

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

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

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