WoW:API Region GetPoint: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{widgetmethod}} __NOTOC__ | {{widgetmethod}} __NOTOC__ | ||
= | Returns information about the anchor points for a region. | ||
point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n) | |||
point | == Arguments == | ||
; n | |||
: integer - number of point about which you want to retrieve info. Should be in range <tt>1 .. MyRegion:GetNumPoints()</tt> | |||
== Returns == | == Returns == | ||
; point | |||
: [[UITYPE FramePoint|FramePoint]] -- attachment point of frame <tt>MyFrame</tt> | |||
relativeTo: The frame | ; relativeTo | ||
relativePoint: attachment point | : Region -- The frame <tt>MyFrame</tt> is attached to (NOTE: this returns the actual widget object, if you want to get that object's name, use <tt>relativeTo:GetName()</tt>) | ||
xOfs: | ; relativePoint | ||
yOfs: | : [[UITYPE FramePoint|FramePoint]] -- attachment point of the <tt>relativeTo</tt> frame | ||
; xOfs | |||
: number -- horizontal offset; not necessarily integer (positive <tt>xOfs</tt> means shift to the right) | |||
; yOfs | |||
: number -- vertical offset; not necessarily integer (positive <tt>yOfs</tt> means shift upwards) | |||
== Example == | == Example == | ||
point,relativeTo,relativePoint,xOfs,yOfs = MyAddon_Frame1:GetPoint() | point, relativeTo, relativePoint, xOfs, yOfs = MyAddon_Frame1:GetPoint() | ||
DEFAULT_CHAT_FRAME:AddMessage(point) | DEFAULT_CHAT_FRAME:AddMessage(point) | ||
DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName()) | DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName()) | ||
DEFAULT_CHAT_FRAME:AddMessage(relativePoint) | DEFAULT_CHAT_FRAME:AddMessage(relativePoint) | ||
DEFAULT_CHAT_FRAME:AddMessage(xOfs) | DEFAULT_CHAT_FRAME:AddMessage(xOfs) | ||
DEFAULT_CHAT_FRAME:AddMessage(yOfs) | DEFAULT_CHAT_FRAME:AddMessage(yOfs) | ||
Result: | |||
TOP | TOP | ||
MyAddon_Frame0 | MyAddon_Frame0 | ||
BOTTOM | BOTTOM | ||
0 | 0 | ||
-10 | -10 | ||
Revision as of 01:41, 27 September 2007
← Widget API ← Region < GetPoint
Returns information about the anchor points for a region.
point, relativeTo, relativePoint, xOfs, yOfs = MyRegion:GetPoint(n)
Arguments
- n
- integer - number of point about which you want to retrieve info. Should be in range 1 .. MyRegion:GetNumPoints()
Returns
- point
- FramePoint -- attachment point of frame MyFrame
- relativeTo
- Region -- The frame MyFrame is attached to (NOTE: this returns the actual widget object, if you want to get that object's name, use relativeTo:GetName())
- relativePoint
- FramePoint -- attachment point of the relativeTo frame
- xOfs
- number -- horizontal offset; not necessarily integer (positive xOfs means shift to the right)
- yOfs
- number -- vertical offset; not necessarily integer (positive yOfs means shift upwards)
Example
point, relativeTo, relativePoint, xOfs, yOfs = MyAddon_Frame1:GetPoint() DEFAULT_CHAT_FRAME:AddMessage(point) DEFAULT_CHAT_FRAME:AddMessage(relativeTo:GetName()) DEFAULT_CHAT_FRAME:AddMessage(relativePoint) DEFAULT_CHAT_FRAME:AddMessage(xOfs) DEFAULT_CHAT_FRAME:AddMessage(yOfs)
Result:
TOP MyAddon_Frame0 BOTTOM 0 -10