Back to index...

NameTypeDeprecatedSecureDescription
RiftCheckboxA UI element of type RiftCheckbox or derived from RiftCheckbox.
RiftCheckbox.Event:CheckboxChangeSignals that the checkbox's checked state has changed.
RiftCheckbox.Event:KeyDownSignals a key pressed.
RiftCheckbox.Event:KeyFocusGainSignals gaining key focus.
RiftCheckbox.Event:KeyFocusLossSignals losing key focus.
RiftCheckbox.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftCheckbox.Event:KeyTypeSignals text typed.
RiftCheckbox.Event:KeyUpSignals a key released.
RiftCheckbox.Event:LayerSignals a change in the item's layer.
RiftCheckbox.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftCheckbox.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftCheckbox.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftCheckbox.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftCheckbox.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftCheckbox.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftCheckbox.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftCheckbox.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftCheckbox.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftCheckbox.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftCheckbox.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftCheckbox.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftCheckbox.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftCheckbox.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftCheckbox.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftCheckbox.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftCheckbox.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftCheckbox.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftCheckbox.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftCheckbox.Event:MoveSignals that the frame's vertices have moved.
RiftCheckbox.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftCheckbox.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftCheckbox.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftCheckbox.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftCheckbox.Event:SizeSignals that the frame's size has changed.
RiftCheckbox.Event:StrataSignals a change in the item's strata.
RiftCheckbox.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftCheckbox.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftCheckbox:ClearAllfunctionClear all set points and sizes from this frame.
RiftCheckbox:ClearHeightfunctionClear a set height from this frame.
RiftCheckbox:ClearPointfunctionClear a set point from this frame.
RiftCheckbox:ClearWidthfunctionClear a set width from this frame.
RiftCheckbox:EventAttachfunctionAttaches an event handler to an event.
RiftCheckbox:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftCheckbox:EventListfunctionLists the current event handlers for an event.
RiftCheckbox:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftCheckbox:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftCheckbox:GetAlphafunctionGets the alpha multiplier of this frame.
RiftCheckbox:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftCheckbox:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftCheckbox:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftCheckbox:GetCheckedfunctionGets whether the button is checked or not.
RiftCheckbox:GetChildrenfunctionReturns a table containing all of this element's children.
RiftCheckbox:GetDefaultHeightfunctiondeprecatedReturns the default height of Rift checkboxes.
RiftCheckbox:GetDefaultWidthfunctiondeprecatedReturns the default width of Rift checkboxes.
RiftCheckbox:GetEnabledfunctionGets whether the checkbox is enabled or grayed out.
RiftCheckbox:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftCheckbox:GetHeightfunctionRetrieves the height of this element.
RiftCheckbox:GetKeyFocusfunctionGets the key focus status.
RiftCheckbox:GetLayerfunctionGets the frame's layer order.
RiftCheckbox:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftCheckbox:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftCheckbox:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftCheckbox:GetNamefunctionRetrieves the name of this element.
RiftCheckbox:GetOwnerfunctionRetrieves the owner of this element.
RiftCheckbox:GetParentfunctionGets the parent of this frame.
RiftCheckbox:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftCheckbox:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftCheckbox:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftCheckbox:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftCheckbox:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftCheckbox:GetTypefunctionRetrieves the type of this element.
RiftCheckbox:GetVisiblefunctionGets the visibility flag for this frame.
RiftCheckbox:GetWidthfunctionRetrieves the width of this element.
RiftCheckbox:ReadAllfunctionRead all set points and sizes from this frame.
RiftCheckbox:ReadHeightfunctionRead a set height from this frame.
RiftCheckbox:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftCheckbox:ReadWidthfunctionRead a set width from this frame.
RiftCheckbox:ResizeToDefaultfunctiondeprecatedResizes this checkbox to its default width and height.
RiftCheckbox:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftCheckbox:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftCheckbox:SetBackgroundColorfunctionSets the background color of this frame.
RiftCheckbox:SetCheckedfunctionSets whether the checkbox is checked or not.
RiftCheckbox:SetEnabledfunctionSets whether the checkbox is enabled or grayed out.
RiftCheckbox:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftCheckbox:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftCheckbox:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftCheckbox:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftCheckbox:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftCheckbox:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftCheckbox:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftCheckbox:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftCheckbox:SetStratafunctionSets the strata for this frame.
RiftCheckbox:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftCheckbox:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

RiftCheckbox

A UI element of type RiftCheckbox or derived from RiftCheckbox.

RiftCheckbox.Event:CheckboxChange

Signals that the checkbox's checked state has changed.

Usage:

RiftCheckbox.Event:CheckboxChange()

RiftCheckbox.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftCheckbox.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

RiftCheckbox.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

RiftCheckbox.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftCheckbox.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

RiftCheckbox.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftCheckbox.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

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

RiftCheckbox.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

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

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

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

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

RiftCheckbox.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

RiftCheckbox.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

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

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

RiftCheckbox:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

RiftCheckbox:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

RiftCheckbox:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

RiftCheckbox:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

RiftCheckbox:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA 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.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

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

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

RiftCheckbox:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA 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.

RiftCheckbox:EventMacroGet

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

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

RiftCheckbox:EventMacroSet

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

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

RiftCheckbox:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe 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.

RiftCheckbox:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

RiftCheckbox:GetBottom

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

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

RiftCheckbox:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

RiftCheckbox:GetChecked

Gets whether the button is checked or not.

Usage:

checked = RiftCheckbox:GetChecked()
ParameterTypeDatatypeDescription
checkedresultbooleanThe current checked state of this item.

RiftCheckbox:GetChildren

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

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

RiftCheckbox:GetDefaultHeight

Returns the default height of Rift checkboxes.

Usage:

height = RiftCheckbox:GetDefaultHeight()
ParameterTypeDatatypeDescription
heightresultnumberDefault button height.
deprecated
hard
disabled
true

RiftCheckbox:GetDefaultWidth

Returns the default width of Rift checkboxes.

Usage:

width = RiftCheckbox:GetDefaultWidth()
ParameterTypeDatatypeDescription
widthresultnumberDefault button width.
deprecated
hard
disabled
true

RiftCheckbox:GetEnabled

Gets whether the checkbox is enabled or grayed out.

Usage:

enabled = RiftCheckbox:GetEnabled()
ParameterTypeDatatypeDescription
enabledresultbooleanThe current enable state of this item.

RiftCheckbox:GetEventTable

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

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

RiftCheckbox:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

RiftCheckbox:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

RiftCheckbox:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

RiftCheckbox:GetLeft

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

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

RiftCheckbox:GetMouseMasking

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

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

RiftCheckbox:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

RiftCheckbox:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

RiftCheckbox:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

RiftCheckbox:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

RiftCheckbox:GetRight

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

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

RiftCheckbox:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

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

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

RiftCheckbox:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

RiftCheckbox:GetTop

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

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

RiftCheckbox:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

RiftCheckbox:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

RiftCheckbox:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

RiftCheckbox:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

RiftCheckbox:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

RiftCheckbox:ReadPoint

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

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

RiftCheckbox:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

RiftCheckbox:ResizeToDefault

Resizes this checkbox to its default width and height.

Usage:

RiftCheckbox:ResizeToDefault()
deprecated
hard
noSecureFrameAndEnvironment
true
disabled
true

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

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetAlpha

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

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

RiftCheckbox:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

RiftCheckbox:SetChecked

Sets whether the checkbox is checked or not.

Usage:

RiftCheckbox:SetChecked(checked)
ParameterTypeDatatypeDescription
checkedparameterbooleanThe new checked state of this item.

RiftCheckbox:SetEnabled

Sets whether the checkbox is enabled or grayed out.

Usage:

RiftCheckbox:SetEnabled(enabled)
ParameterTypeDatatypeDescription
enabledparameterbooleanThe new enable state of this item.

RiftCheckbox:SetHeight

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

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

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

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

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

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe 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

RiftCheckbox:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

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

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

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

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

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

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

RiftCheckbox:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

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

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetWidth

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

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

Back to index...