Back to index...

NameTypeDeprecatedSecureDescription
Command.UI.ErrorfunctionDisplay the addon error dialog.
Event.UI.Button.Left.PressSignals that a button has been pressed with the left mouse button.
Event.UI.Checkbox.ChangeSignals that a checkbox's state has changed.
Event.UI.Input.Key.DownSignals that a keyboard key has been pressed. Requires key focus.
Event.UI.Input.Key.Down.BubbleEvent.UI.Input.Key.Down.Bubble@summary
Event.UI.Input.Key.Down.DiveEvent.UI.Input.Key.Down.Dive@summary
Event.UI.Input.Key.Focus.GainSignals that a frame has gained the key focus.
Event.UI.Input.Key.Focus.Gain.BubbleEvent.UI.Input.Key.Focus.Gain.Bubble@summary
Event.UI.Input.Key.Focus.Gain.DiveEvent.UI.Input.Key.Focus.Gain.Dive@summary
Event.UI.Input.Key.Focus.LossSignals that a frame has lost the key focus.
Event.UI.Input.Key.Focus.Loss.BubbleEvent.UI.Input.Key.Focus.Loss.Bubble@summary
Event.UI.Input.Key.Focus.Loss.DiveEvent.UI.Input.Key.Focus.Loss.Dive@summary
Event.UI.Input.Key.RepeatSignals that a keyboard key is repeating. Requires key focus.
Event.UI.Input.Key.Repeat.BubbleEvent.UI.Input.Key.Repeat.Bubble@summary
Event.UI.Input.Key.Repeat.DiveEvent.UI.Input.Key.Repeat.Dive@summary
Event.UI.Input.Key.TypeSignals that text has been typed. Requires key focus.
Event.UI.Input.Key.Type.BubbleEvent.UI.Input.Key.Type.Bubble@summary
Event.UI.Input.Key.Type.DiveEvent.UI.Input.Key.Type.Dive@summary
Event.UI.Input.Key.UpSignals that a keyboard key has been released. Requires key focus.
Event.UI.Input.Key.Up.BubbleEvent.UI.Input.Key.Up.Bubble@summary
Event.UI.Input.Key.Up.DiveEvent.UI.Input.Key.Up.Dive@summary
Event.UI.Input.Mouse.Cursor.InSignals that the cursor has moved into a frame.
Event.UI.Input.Mouse.Cursor.In.BubbleEvent.UI.Input.Mouse.Cursor.In.Bubble@summary
Event.UI.Input.Mouse.Cursor.In.DiveEvent.UI.Input.Mouse.Cursor.In.Dive@summary
Event.UI.Input.Mouse.Cursor.MoveSignals that the cursor has moved within a frame.
Event.UI.Input.Mouse.Cursor.Move.BubbleEvent.UI.Input.Mouse.Cursor.Move.Bubble@summary
Event.UI.Input.Mouse.Cursor.Move.DiveEvent.UI.Input.Mouse.Cursor.Move.Dive@summary
Event.UI.Input.Mouse.Cursor.OutSignals that the cursor has moved out of a frame.
Event.UI.Input.Mouse.Cursor.Out.BubbleEvent.UI.Input.Mouse.Cursor.Out.Bubble@summary
Event.UI.Input.Mouse.Cursor.Out.DiveEvent.UI.Input.Mouse.Cursor.Out.Dive@summary
Event.UI.Input.Mouse.Left.ClickSignals that the user has clicked the left mouse button.
Event.UI.Input.Mouse.Left.Click.BubbleEvent.UI.Input.Mouse.Left.Click.Bubble@summary
Event.UI.Input.Mouse.Left.Click.DiveEvent.UI.Input.Mouse.Left.Click.Dive@summary
Event.UI.Input.Mouse.Left.DownSignals that the user has pressed the left mouse button.
Event.UI.Input.Mouse.Left.Down.BubbleEvent.UI.Input.Mouse.Left.Down.Bubble@summary
Event.UI.Input.Mouse.Left.Down.DiveEvent.UI.Input.Mouse.Left.Down.Dive@summary
Event.UI.Input.Mouse.Left.UpSignals that the user has released the left mouse button.
Event.UI.Input.Mouse.Left.Up.BubbleEvent.UI.Input.Mouse.Left.Up.Bubble@summary
Event.UI.Input.Mouse.Left.Up.DiveEvent.UI.Input.Mouse.Left.Up.Dive@summary
Event.UI.Input.Mouse.Left.UpoutsideSignals that the user has released the left mouse button off this frame after pressing it on this...
Event.UI.Input.Mouse.Left.Upoutside.BubbleEvent.UI.Input.Mouse.Left.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Left.Upoutside.DiveEvent.UI.Input.Mouse.Left.Upoutside.Dive@summary
Event.UI.Input.Mouse.Middle.ClickSignals that the user has clicked the middle mouse button.
Event.UI.Input.Mouse.Middle.Click.BubbleEvent.UI.Input.Mouse.Middle.Click.Bubble@summary
Event.UI.Input.Mouse.Middle.Click.DiveEvent.UI.Input.Mouse.Middle.Click.Dive@summary
Event.UI.Input.Mouse.Middle.DownSignals that the user has pressed the middle mouse button.
Event.UI.Input.Mouse.Middle.Down.BubbleEvent.UI.Input.Mouse.Middle.Down.Bubble@summary
Event.UI.Input.Mouse.Middle.Down.DiveEvent.UI.Input.Mouse.Middle.Down.Dive@summary
Event.UI.Input.Mouse.Middle.UpSignals that the user has released the middle mouse button.
Event.UI.Input.Mouse.Middle.Up.BubbleEvent.UI.Input.Mouse.Middle.Up.Bubble@summary
Event.UI.Input.Mouse.Middle.Up.DiveEvent.UI.Input.Mouse.Middle.Up.Dive@summary
Event.UI.Input.Mouse.Middle.UpoutsideSignals that the user has released the middle mouse button off this frame after pressing it on th...
Event.UI.Input.Mouse.Middle.Upoutside.BubbleEvent.UI.Input.Mouse.Middle.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Middle.Upoutside.DiveEvent.UI.Input.Mouse.Middle.Upoutside.Dive@summary
Event.UI.Input.Mouse.Mouse4.ClickSignals that the user has clicked the fourth mouse button.
Event.UI.Input.Mouse.Mouse4.Click.BubbleEvent.UI.Input.Mouse.Mouse4.Click.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Click.DiveEvent.UI.Input.Mouse.Mouse4.Click.Dive@summary
Event.UI.Input.Mouse.Mouse4.DownSignals that the user has pressed the fourth mouse button.
Event.UI.Input.Mouse.Mouse4.Down.BubbleEvent.UI.Input.Mouse.Mouse4.Down.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Down.DiveEvent.UI.Input.Mouse.Mouse4.Down.Dive@summary
Event.UI.Input.Mouse.Mouse4.UpSignals that the user has released the fourth mouse button.
Event.UI.Input.Mouse.Mouse4.Up.BubbleEvent.UI.Input.Mouse.Mouse4.Up.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Up.DiveEvent.UI.Input.Mouse.Mouse4.Up.Dive@summary
Event.UI.Input.Mouse.Mouse4.UpoutsideSignals that the user has released the fourth mouse button off this frame after pressing it on th...
Event.UI.Input.Mouse.Mouse4.Upoutside.BubbleEvent.UI.Input.Mouse.Mouse4.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Upoutside.DiveEvent.UI.Input.Mouse.Mouse4.Upoutside.Dive@summary
Event.UI.Input.Mouse.Mouse5.ClickSignals that the user has clicked the fifth mouse button.
Event.UI.Input.Mouse.Mouse5.Click.BubbleEvent.UI.Input.Mouse.Mouse5.Click.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Click.DiveEvent.UI.Input.Mouse.Mouse5.Click.Dive@summary
Event.UI.Input.Mouse.Mouse5.DownSignals that the user has pressed the fifth mouse button.
Event.UI.Input.Mouse.Mouse5.Down.BubbleEvent.UI.Input.Mouse.Mouse5.Down.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Down.DiveEvent.UI.Input.Mouse.Mouse5.Down.Dive@summary
Event.UI.Input.Mouse.Mouse5.UpSignals that the user has released the fifth mouse button.
Event.UI.Input.Mouse.Mouse5.Up.BubbleEvent.UI.Input.Mouse.Mouse5.Up.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Up.DiveEvent.UI.Input.Mouse.Mouse5.Up.Dive@summary
Event.UI.Input.Mouse.Mouse5.UpoutsideSignals that the user has released the fifth mouse button off this frame after pressing it on thi...
Event.UI.Input.Mouse.Mouse5.Upoutside.BubbleEvent.UI.Input.Mouse.Mouse5.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Upoutside.DiveEvent.UI.Input.Mouse.Mouse5.Upoutside.Dive@summary
Event.UI.Input.Mouse.Right.ClickSignals that the user has clicked the right mouse button.
Event.UI.Input.Mouse.Right.Click.BubbleEvent.UI.Input.Mouse.Right.Click.Bubble@summary
Event.UI.Input.Mouse.Right.Click.DiveEvent.UI.Input.Mouse.Right.Click.Dive@summary
Event.UI.Input.Mouse.Right.DownSignals that the user has pressed the right mouse button.
Event.UI.Input.Mouse.Right.Down.BubbleEvent.UI.Input.Mouse.Right.Down.Bubble@summary
Event.UI.Input.Mouse.Right.Down.DiveEvent.UI.Input.Mouse.Right.Down.Dive@summary
Event.UI.Input.Mouse.Right.UpSignals that the user has released the right mouse button.
Event.UI.Input.Mouse.Right.Up.BubbleEvent.UI.Input.Mouse.Right.Up.Bubble@summary
Event.UI.Input.Mouse.Right.Up.DiveEvent.UI.Input.Mouse.Right.Up.Dive@summary
Event.UI.Input.Mouse.Right.UpoutsideSignals that the user has released the right mouse button off this frame after pressing it on thi...
Event.UI.Input.Mouse.Right.Upoutside.BubbleEvent.UI.Input.Mouse.Right.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Right.Upoutside.DiveEvent.UI.Input.Mouse.Right.Upoutside.Dive@summary
Event.UI.Input.Mouse.Wheel.BackSignals that the user has moved the mousewheel back.
Event.UI.Input.Mouse.Wheel.Back.BubbleEvent.UI.Input.Mouse.Wheel.Back.Bubble@summary
Event.UI.Input.Mouse.Wheel.Back.DiveEvent.UI.Input.Mouse.Wheel.Back.Dive@summary
Event.UI.Input.Mouse.Wheel.ForwardSignals that the user has moved the mousewheel forwards.
Event.UI.Input.Mouse.Wheel.Forward.BubbleEvent.UI.Input.Mouse.Wheel.Forward.Bubble@summary
Event.UI.Input.Mouse.Wheel.Forward.DiveEvent.UI.Input.Mouse.Wheel.Forward.Dive@summary
Event.UI.Layout.LayerSignals a change in layer.
Event.UI.Layout.MoveSignals a change in the top-left corner's position. May be delayed after the actual movement.
Event.UI.Layout.SizeSignals a change in size. May be delayed after the actual change.
Event.UI.Layout.StrataSignals a change in strata.
Event.UI.Native.LoadedSignals a change in this native frame's loaded state.
Event.UI.Scrollbar.ChangeSignals a change in scrollbar position.
Event.UI.Scrollbar.GrabSignals that a scrollbar has been grabbed.
Event.UI.Scrollbar.ReleaseSignals that a scrollbar has been released.
Event.UI.Slider.ChangeSignals a change in slider position.
Event.UI.Slider.GrabSignals that a slider has been grabbed.
Event.UI.Slider.ReleaseSignals that a slider has been released.
Event.UI.Textfield.ChangeSignals a change in textfield contents.
Event.UI.Textfield.SelectSignals a change in textfield selection.
UI.ContextLists all contexts that have been created. Organizes them under [addonIdentifier][contextIdentifi...
UI.CreateContextfunctionCreates a new UI context. A UI context must be created in order to create any frames.
UI.CreateFramefunctionCreates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames m...
UI.FrameLists all frames that have been created. Organizes them under [addonIdentifier][contextIdentifier...

Command.UI.Error

Display the addon error dialog.

Usage:

Command.UI.Error(id)
ParameterTypeDatatypeDescription
idparametererrorThe ID of the error to be displayed.

Event.UI.Button.Left.Press

Signals that a button has been pressed with the left mouse button.

Usage:

Event.UI.Button.Left.Press(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Checkbox.Change

Signals that a checkbox's state has changed.

Usage:

Event.UI.Checkbox.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Down

Signals that a keyboard key has been pressed. Requires key focus.

Usage:

Event.UI.Input.Key.Down(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Down.Bubble

Event.UI.Input.Key.Down.Bubble@summary

Usage:

Event.UI.Input.Key.Down.Bubble(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Down.Dive

Event.UI.Input.Key.Down.Dive@summary

Usage:

Event.UI.Input.Key.Down.Dive(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Focus.Gain

Signals that a frame has gained the key focus.

Usage:

Event.UI.Input.Key.Focus.Gain(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Gain.Bubble

Event.UI.Input.Key.Focus.Gain.Bubble@summary

Usage:

Event.UI.Input.Key.Focus.Gain.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Gain.Dive

Event.UI.Input.Key.Focus.Gain.Dive@summary

Usage:

Event.UI.Input.Key.Focus.Gain.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Loss

Signals that a frame has lost the key focus.

Usage:

Event.UI.Input.Key.Focus.Loss(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Loss.Bubble

Event.UI.Input.Key.Focus.Loss.Bubble@summary

Usage:

Event.UI.Input.Key.Focus.Loss.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Loss.Dive

Event.UI.Input.Key.Focus.Loss.Dive@summary

Usage:

Event.UI.Input.Key.Focus.Loss.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Repeat

Signals that a keyboard key is repeating. Requires key focus.

Usage:

Event.UI.Input.Key.Repeat(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Repeat.Bubble

Event.UI.Input.Key.Repeat.Bubble@summary

Usage:

Event.UI.Input.Key.Repeat.Bubble(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Repeat.Dive

Event.UI.Input.Key.Repeat.Dive@summary

Usage:

Event.UI.Input.Key.Repeat.Dive(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Type

Signals that text has been typed. Requires key focus.

Usage:

Event.UI.Input.Key.Type(handle, text)
ParameterTypeDatatypeDescription
handle???variant
textparameter<nope>The text that has been entered.

Event.UI.Input.Key.Type.Bubble

Event.UI.Input.Key.Type.Bubble@summary

Usage:

Event.UI.Input.Key.Type.Bubble(handle, text)
ParameterTypeDatatypeDescription
handle???variant
textparameter<nope>The text that has been entered.

Event.UI.Input.Key.Type.Dive

Event.UI.Input.Key.Type.Dive@summary

Usage:

Event.UI.Input.Key.Type.Dive(handle, text)
ParameterTypeDatatypeDescription
handle???variant
textparameter<nope>The text that has been entered.

Event.UI.Input.Key.Up

Signals that a keyboard key has been released. Requires key focus.

Usage:

Event.UI.Input.Key.Up(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Up.Bubble

Event.UI.Input.Key.Up.Bubble@summary

Usage:

Event.UI.Input.Key.Up.Bubble(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Up.Dive

Event.UI.Input.Key.Up.Dive@summary

Usage:

Event.UI.Input.Key.Up.Dive(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Mouse.Cursor.In

Signals that the cursor has moved into a frame.

Usage:

Event.UI.Input.Mouse.Cursor.In(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.In.Bubble

Event.UI.Input.Mouse.Cursor.In.Bubble@summary

Usage:

Event.UI.Input.Mouse.Cursor.In.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.In.Dive

Event.UI.Input.Mouse.Cursor.In.Dive@summary

Usage:

Event.UI.Input.Mouse.Cursor.In.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Move

Signals that the cursor has moved within a frame.

Usage:

Event.UI.Input.Mouse.Cursor.Move(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Move.Bubble

Event.UI.Input.Mouse.Cursor.Move.Bubble@summary

Usage:

Event.UI.Input.Mouse.Cursor.Move.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Move.Dive

Event.UI.Input.Mouse.Cursor.Move.Dive@summary

Usage:

Event.UI.Input.Mouse.Cursor.Move.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Out

Signals that the cursor has moved out of a frame.

Usage:

Event.UI.Input.Mouse.Cursor.Out(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Out.Bubble

Event.UI.Input.Mouse.Cursor.Out.Bubble@summary

Usage:

Event.UI.Input.Mouse.Cursor.Out.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Out.Dive

Event.UI.Input.Mouse.Cursor.Out.Dive@summary

Usage:

Event.UI.Input.Mouse.Cursor.Out.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Click

Signals that the user has clicked the left mouse button.

Usage:

Event.UI.Input.Mouse.Left.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Click.Bubble

Event.UI.Input.Mouse.Left.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Click.Dive

Event.UI.Input.Mouse.Left.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Down

Signals that the user has pressed the left mouse button.

Usage:

Event.UI.Input.Mouse.Left.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Down.Bubble

Event.UI.Input.Mouse.Left.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Down.Dive

Event.UI.Input.Mouse.Left.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Up

Signals that the user has released the left mouse button.

Usage:

Event.UI.Input.Mouse.Left.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Up.Bubble

Event.UI.Input.Mouse.Left.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Up.Dive

Event.UI.Input.Mouse.Left.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Upoutside

Signals that the user has released the left mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Left.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Upoutside.Bubble

Event.UI.Input.Mouse.Left.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Upoutside.Dive

Event.UI.Input.Mouse.Left.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Click

Signals that the user has clicked the middle mouse button.

Usage:

Event.UI.Input.Mouse.Middle.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Click.Bubble

Event.UI.Input.Mouse.Middle.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Click.Dive

Event.UI.Input.Mouse.Middle.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Down

Signals that the user has pressed the middle mouse button.

Usage:

Event.UI.Input.Mouse.Middle.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Down.Bubble

Event.UI.Input.Mouse.Middle.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Down.Dive

Event.UI.Input.Mouse.Middle.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Up

Signals that the user has released the middle mouse button.

Usage:

Event.UI.Input.Mouse.Middle.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Up.Bubble

Event.UI.Input.Mouse.Middle.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Up.Dive

Event.UI.Input.Mouse.Middle.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Upoutside

Signals that the user has released the middle mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Middle.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Upoutside.Bubble

Event.UI.Input.Mouse.Middle.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Upoutside.Dive

Event.UI.Input.Mouse.Middle.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Click

Signals that the user has clicked the fourth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse4.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Click.Bubble

Event.UI.Input.Mouse.Mouse4.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Click.Dive

Event.UI.Input.Mouse.Mouse4.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Down

Signals that the user has pressed the fourth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse4.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Down.Bubble

Event.UI.Input.Mouse.Mouse4.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Down.Dive

Event.UI.Input.Mouse.Mouse4.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Up

Signals that the user has released the fourth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse4.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Up.Bubble

Event.UI.Input.Mouse.Mouse4.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Up.Dive

Event.UI.Input.Mouse.Mouse4.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Upoutside

Signals that the user has released the fourth mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Mouse4.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble

Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Upoutside.Dive

Event.UI.Input.Mouse.Mouse4.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Click

Signals that the user has clicked the fifth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse5.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Click.Bubble

Event.UI.Input.Mouse.Mouse5.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Click.Dive

Event.UI.Input.Mouse.Mouse5.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Down

Signals that the user has pressed the fifth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse5.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Down.Bubble

Event.UI.Input.Mouse.Mouse5.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Down.Dive

Event.UI.Input.Mouse.Mouse5.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Up

Signals that the user has released the fifth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse5.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Up.Bubble

Event.UI.Input.Mouse.Mouse5.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Up.Dive

Event.UI.Input.Mouse.Mouse5.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Upoutside

Signals that the user has released the fifth mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Mouse5.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble

Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Upoutside.Dive

Event.UI.Input.Mouse.Mouse5.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Click

Signals that the user has clicked the right mouse button.

Usage:

Event.UI.Input.Mouse.Right.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Click.Bubble

Event.UI.Input.Mouse.Right.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Click.Dive

Event.UI.Input.Mouse.Right.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Down

Signals that the user has pressed the right mouse button.

Usage:

Event.UI.Input.Mouse.Right.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Down.Bubble

Event.UI.Input.Mouse.Right.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Down.Dive

Event.UI.Input.Mouse.Right.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Up

Signals that the user has released the right mouse button.

Usage:

Event.UI.Input.Mouse.Right.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Up.Bubble

Event.UI.Input.Mouse.Right.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Up.Dive

Event.UI.Input.Mouse.Right.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Upoutside

Signals that the user has released the right mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Right.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Upoutside.Bubble

Event.UI.Input.Mouse.Right.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Upoutside.Dive

Event.UI.Input.Mouse.Right.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Back

Signals that the user has moved the mousewheel back.

Usage:

Event.UI.Input.Mouse.Wheel.Back(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Back.Bubble

Event.UI.Input.Mouse.Wheel.Back.Bubble@summary

Usage:

Event.UI.Input.Mouse.Wheel.Back.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Back.Dive

Event.UI.Input.Mouse.Wheel.Back.Dive@summary

Usage:

Event.UI.Input.Mouse.Wheel.Back.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Forward

Signals that the user has moved the mousewheel forwards.

Usage:

Event.UI.Input.Mouse.Wheel.Forward(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Forward.Bubble

Event.UI.Input.Mouse.Wheel.Forward.Bubble@summary

Usage:

Event.UI.Input.Mouse.Wheel.Forward.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Forward.Dive

Event.UI.Input.Mouse.Wheel.Forward.Dive@summary

Usage:

Event.UI.Input.Mouse.Wheel.Forward.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Layer

Signals a change in layer.

Usage:

Event.UI.Layout.Layer(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Move

Signals a change in the top-left corner's position. May be delayed after the actual movement.

Usage:

Event.UI.Layout.Move(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Size

Signals a change in size. May be delayed after the actual change.

Usage:

Event.UI.Layout.Size(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Strata

Signals a change in strata.

Usage:

Event.UI.Layout.Strata(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Native.Loaded

Signals a change in this native frame's loaded state.

Usage:

Event.UI.Native.Loaded(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Scrollbar.Change

Signals a change in scrollbar position.

Usage:

Event.UI.Scrollbar.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Scrollbar.Grab

Signals that a scrollbar has been grabbed.

Usage:

Event.UI.Scrollbar.Grab(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Scrollbar.Release

Signals that a scrollbar has been released.

Usage:

Event.UI.Scrollbar.Release(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Slider.Change

Signals a change in slider position.

Usage:

Event.UI.Slider.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Slider.Grab

Signals that a slider has been grabbed.

Usage:

Event.UI.Slider.Grab(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Slider.Release

Signals that a slider has been released.

Usage:

Event.UI.Slider.Release(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Textfield.Change

Signals a change in textfield contents.

Usage:

Event.UI.Textfield.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Textfield.Select

Signals a change in textfield selection.

Usage:

Event.UI.Textfield.Select(handle)
ParameterTypeDatatypeDescription
handle???variant

UI.Context

Lists all contexts that have been created. Organizes them under [addonIdentifier][contextIdentifier][constructionOrder]. As an example, if TestAddon created four contexts named UIElement, the second would be UI.Context.TestAddon.UIElement[2].

UI.CreateContext

Creates a new UI context. A UI context must be created in order to create any frames.

Usage:

context = UI.CreateContext(name)
ParameterTypeDatatypeDescription
nameparameterstringA descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
contextresultContextA new context. Contexts are guaranteed to have at least the capabilities of a Frame.

UI.CreateFrame

Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames must have a parent, you'll need to create a Context before any frames. See UI.CreateContext.
List of valid frame types:
Frame: The base type. No special capabilities. Useful for spacing, organization, input handling, and solid color squares.
Mask: Obscures the contents of child frames that do not fall within the mask boundaries.
Text: Displays text.
Texture: Displays a static texture image.
RiftButton: A standard Rift button widget.
RiftCheckbox: A standard Rift checkbox widget.
RiftScrollbar: A standard Rift scrollbar widget.
RiftSlider: A standard Rift slider widget.
RiftTextfield: A standard Rift textfield widget.
RiftWindow: A standard Rift window widget.

Usage:

frame = UI.CreateFrame(type, name, parent)
ParameterTypeDatatypeDescription
nameparameterstringA descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
parentparameterElementThe new parent for this frame.
typeparameterstringThe type of your new frame. Current supported types: Frame, Text, Texture.
frameresultFrameYour new frame.

UI.Frame

Lists all frames that have been created. Organizes them under [addonIdentifier][contextIdentifier][constructionOrder]. As an example, if TestAddon created four frames named UIElement, the second would be UI.Frame.TestAddon.UIElement[2].

Back to index...