Charibot@legacy41530750 (talk | contribs) m (catfix, Replaced: {{widgethandler}} → {{widgethandler}}<br>) |
Mundocani39694@legacy41559615 (talk | contribs) (Updating with 2.0 (required in 3.0) variable names) |
||
Line 9: | Line 9: | ||
== Arguments == |
== Arguments == |
||
+ | self - the frame being entered |
||
− | No known arguments |
||
+ | |||
+ | motion - unknown |
||
== Example == |
== Example == |
Revision as of 23:06, 13 August 2008
The API is no longer being updated here until further notice. |
Description
The OnEnter handler is called when the user mouse pointer enters the frame.
A typical use for this event is to pop up a help tooltip, or a menu with option choices (for instance on a minimap button). The opposite of OnEnter is OnLeave. If you decide to show something in OnEnter you should hide it again in the OnLeave event handler.
Arguments
self - the frame being entered
motion - unknown
Example
This example illustrates how to use OnEnter and OnLeave to display a mouseover help text in the GameTooltip.
Declare the event handlers in the "Scripts" section of your frame:
<Frame name="MyFrame"> <Scripts> <OnEnter> MyFrame_OnEnter() </OnEnter> <OnLeave> MyFrame_OnLeave() </OnLeave> </Scripts> </Frame>
Place the actual functions in one of your LUA files:
function MyFrame_OnEnter() GameTooltip_SetDefaultAnchor( GameTooltip, UIParent ) GameTooltip:SetText( "This text shows up when you mouse over\nthe MyFrame frame" ) GameTooltip:Show() end function MyFrame_OnLeave() GameTooltip:Hide() end