WoW:API GameTooltip SetOwner: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 7: Line 7:


:(owner, "Anchor"[, +x, +y])
:(owner, "Anchor"[, +x, +y])
:;owner : Frame - Owner frame, which defines the element where the tooltip is centered on. A pointer to the frame is required, not the frame name itself (use getglobal() to get the pointer from the frame name).
:;owner : Frame - Owner frame, which defines the element where the tooltip is centered on. A pointer to the frame is required, not the frame name itself (use _G['MyFrame'] to get the pointer from the frame name).
:;anchor : String - a string that describes the anchor point as it would be set via the SetPoint() function.  Anchoring methods as follows:
:;anchor : String - a string that describes the anchor point as it would be set via the SetPoint() function.  Anchoring methods as follows:
::ANCHOR_TOPRIGHT    -------    SetPoint("BOTTOMRIGHT",object,"TOPRIGHT")
::ANCHOR_TOPRIGHT    -------    SetPoint("BOTTOMRIGHT",object,"TOPRIGHT")

Revision as of 17:25, 19 December 2010

Widget API ← GameTooltip < SetOwner

Moves the game tooltip to a location based on the "owner" frame.

GameTooltip:SetOwner(owner, "anchor"[, +x, +y]);

Arguments
(owner, "Anchor"[, +x, +y])
owner
Frame - Owner frame, which defines the element where the tooltip is centered on. A pointer to the frame is required, not the frame name itself (use _G['MyFrame'] to get the pointer from the frame name).
anchor
String - a string that describes the anchor point as it would be set via the SetPoint() function. Anchoring methods as follows:
ANCHOR_TOPRIGHT ------- SetPoint("BOTTOMRIGHT",object,"TOPRIGHT")
ANCHOR_RIGHT ------- SetPoint("BOTTOMLEFT",object,"TOPRIGHT")
ANCHOR_BOTTOMRIGHT ------- SetPoint("TOPLEFT",object,"BOTTOMRIGHT")
ANCHOR_TOPLEFT ------- SetPoint("BOTTOMLEFT",object,"TOPLEFT")
ANCHOR_LEFT ------- SetPoint("BOTTOMRIGHT",object,"TOPLEFT")
ANCHOR_BOTTOMLEFT ------- SetPoint("TOPRIGHT",object,"BOTTOMLEFT")
ANCHOR_CURSOR
ANCHOR_PRESERVE
ANCHOR_NONE

You can also move the tooltip by x or y, where positive x is to the right and positive y is up. Thus, negative x is to the left and negative y is down. Doesn't work if anchor is ANCHOR_CURSOR.


Returns
Nothing.

Details
This will set the owner for tooltip:IsOwned(frame). For instance, first call GameTooltip:SetOwner(UIParent). Then GameTooltip:IsOwned(UIParent) will return 1.