Widget handlers

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ Widgets

← Widget API

This is a list of all of the types of handlers allowed, and grouped by frame type as returned by the :GetFrameType() method or used in XML.

Reference

• As of patch 4.0.1, event arguments are no longer set as global variables, and must be passed to the handlers correctly if defined in XML.

Base

Event handlers used by all major Ui elements.

OnLoad(self) - called once at element load time, just after element is created in Lua

OnUpdate(self, elapsed) - called every frame, with elapsed time since last frame

Alpha

from Animation:

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Animation

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

AnimationGroup

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

OnLoop(self, loopState)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Browser

OnButtonUpdate

OnError

OnExternalLink

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Button

OnClick(self, button, down)

OnDoubleClick(self, button)

PostClick(self, button, down)

PreClick(self, button, down)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

CheckButton

OnDisable

from Button:

OnClick(self, button, down)

OnDoubleClick(self, button)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

ColorSelect

OnColorSelect(self, r, g, b)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

DressUpModel

from Model:

OnAnimFinished(self)

OnUpdateModel(self)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

EditBox

OnArrowPressed(self, key)

OnCursorChanged(self, x, y, w, h)

OnEditFocusGained(self)

OnEditFocusLost(self)

OnEnterPressed(self)

OnEscapePressed(self)

OnHyperlinkClick(self, link, text, button)

OnHyperlinkEnter(self, link, text)

OnHyperlinkLeave(self, link, text)

OnInputLanguageChanged(self, language)

OnSpacePressed(self)

OnTabPressed(self)

OnTextChanged(self)

OnTextSet(self)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Frame

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

GameTooltip

OnTooltipAddMoney(self, cost)

OnTooltipCleared(self)

OnTooltipSetAchievement

OnTooltipSetDefaultAnchor

OnTooltipSetItem(self)

OnTooltipSetSpell(self)

OnTooltipSetUnit(self)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

LootButton

from Button:

OnClick(self, button, down)

OnDoubleClick(self, button)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

MessageFrame

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Minimap

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Model

OnAnimFinished(self)

OnUpdateModel(self)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Path

from Animation:

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

PlayerModel

from Model:

OnAnimFinished(self)

OnUpdateModel(self)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

QuestPOIFrame

OnAttributeChanged

OnDisable

OnEnable

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Rotation

from Animation:

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Scale

from Animation:

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

ScrollFrame

OnHorizontalScroll(self, offset)

OnScrollRangeChanged(self, xrange, yrange)

OnVerticalScroll(self, offset)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

ScrollingMessageFrame

OnHyperlinkClick(self, link, text, button)

OnHyperlinkEnter(self, link, text)

OnHyperlinkLeave(self, link, text)

OnMessageScrollChanged

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

SimpleHTML

OnHyperlinkClick(self, link, text, button)

OnHyperlinkEnter(self, link, text)

OnHyperlinkLeave(self, link, text)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Slider

OnValueChanged(self, value)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

StatusBar

OnValueChanged(self, value)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

TabardModel

OnAnimFinished(self)

OnUpdateModel(self)

from Frame:

OnChar(self, text)

OnDragStart(self, button)

OnDragStop(self)

OnEnter(self, motion)

OnEvent(self, event, ...)

OnHide(self)

OnKeyDown(self, key)

OnKeyUp(self, key)

OnLeave(self, motion)

OnLoad(self)

OnMouseDown(self, button)

OnMouseUp(self, button)

OnMouseWheel(self, delta)

OnReceiveDrag(self)

OnShow(self)

OnSizeChanged(self, w, h)

OnUpdate(self, elapsed)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)

Translation

from Animation:

OnPlay(self)

OnPause(self)

OnStop(self)

OnFinished(self)

from Base:

OnLoad(self)

OnUpdate(self, elapsed)