WoW:API Frame StartMoving - Revision history

Move page script: Move page script moved page API Frame StartMoving to WoW:API Frame StartMoving without leaving a redirect

2023-08-15T04:45:36Z

Move page script moved page API Frame StartMoving to API Frame StartMoving without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

Bear at 05:12, 15 February 2015

2015-02-15T05:12:41Z

← Older revision		Revision as of 05:12, 15 February 2015
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}
	Moves the frame-based object in relation to where the mouse is being moved.		Moves the frame-based object in relation to where the mouse is being moved.
	frame:StartMoving();		frame:StartMoving()

	== Details ==		== Details ==
	* Use this with the ~~[[API~~ RegisterForDrag\|~~RegisterForDrag~~()]] function and the <OnDragStart>...</OnDragStart> event to allow your frame-based object to be moved by the user.		* Use this with the {{api\|Frame:RegisterForDrag\|t=w}}() function and the <OnDragStart>...</OnDragStart> event to allow your frame-based object to be moved by the user.
	* Use the ~~[[API~~ StopMovingOrSizing\|~~StopMovingOrSizing~~()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.		* Use the {{api\|Frame:StopMovingOrSizing\|t=w}}() function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.
	* Moving a frame using this function sets the user placed flag for the frame, making the client save its position and reposition the frame on reload. To avoid this behavior, you can call frame:[[API Frame SetUserPlaced\|SetUserPlaced]](false) immediately after StopMovingOrSizing().		* Moving a frame using this function sets the user placed flag for the frame, making the client save its position and reposition the frame on reload. To avoid this behavior, you can call frame:[[API Frame SetUserPlaced\|SetUserPlaced]](false) immediately after StopMovingOrSizing().
	*For pixel-precise movements, you should instead use [[API EnableMouse\|EnableMouse()]] and the <OnMouseDown>...</OnMouseDown> and <OnMouseUp>...</OnMouseUp> events (and probably also the <OnHide>...</OnHide> event).		*For pixel-precise movements, you should instead use [[API EnableMouse\|EnableMouse()]] and the <OnMouseDown>...</OnMouseDown> and <OnMouseUp>...</OnMouseUp> events (and probably also the <OnHide>...</OnHide> event).

WoWWiki>SinusPi at 19:22, 18 September 2011

2011-09-18T19:22:13Z

← Older revision		Revision as of 19:22, 18 September 2011
Line 9:		Line 9:
	*For pixel-precise movements, you should instead use [[API EnableMouse\|EnableMouse()]] and the <OnMouseDown>...</OnMouseDown> and <OnMouseUp>...</OnMouseUp> events (and probably also the <OnHide>...</OnHide> event).		*For pixel-precise movements, you should instead use [[API EnableMouse\|EnableMouse()]] and the <OnMouseDown>...</OnMouseDown> and <OnMouseUp>...</OnMouseUp> events (and probably also the <OnHide>...</OnHide> event).
	*If the frame becomes stuck by any cause (see [[API SetClampedToScreen\|SetClampedToScreen()]]), the mouse and the frame will go out-of-sync.		*If the frame becomes stuck by any cause (see [[API SetClampedToScreen\|SetClampedToScreen()]]), the mouse and the frame will go out-of-sync.
			*If you use the StartDrag/StopDrag events to initiate the dragging, be sure not to :Hide() the dragged frames during the process. A hidden frame will NOT receive its StopDrag event.
	*This function together with [[API StopMovingOrSizing\|StopMovingOrSizing()]] exhibit some "special" behavior that can cause problems when used with frames that are not anchored to UIParent (or some other full-screen frame).		*This function together with [[API StopMovingOrSizing\|StopMovingOrSizing()]] exhibit some "special" behavior that can cause problems when used with frames that are not anchored to UIParent (or some other full-screen frame).
	**Immediately upon calling StartMoving(), the frame will be de-anchored from any other frame it was previously anchored to, and instead anchored to the screen. For example, if MyFrame's TOPLEFT is anchored to MyParent's TOPLEFT at (5,-5), and MyParent's TOPLEFT is anchored to UIParent's TOPLEFT at (100,-100), then MyFrame:StartMoving() immediately re-anchors MyFrame's TOPLEFT to the screen's (nil anchor) TOPLEFT at (105,-105). The original anchor frame (MyParent) and offset will not be restored by [[API StopMovingOrSizing\|StopMovingOrSizing()]].		**Immediately upon calling StartMoving(), the frame will be de-anchored from any other frame it was previously anchored to, and instead anchored to the screen. For example, if MyFrame's TOPLEFT is anchored to MyParent's TOPLEFT at (5,-5), and MyParent's TOPLEFT is anchored to UIParent's TOPLEFT at (100,-100), then MyFrame:StartMoving() immediately re-anchors MyFrame's TOPLEFT to the screen's (nil anchor) TOPLEFT at (105,-105). The original anchor frame (MyParent) and offset will not be restored by [[API StopMovingOrSizing\|StopMovingOrSizing()]].

WoWWiki>Starlightblunder: marginally closer to bp, setuserplaced note

2010-06-27T11:53:19Z

marginally closer to bp, setuserplaced note

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
 Moves the frame-based object in relation to where the mouse is being moved.
- obj:StartMoving();
+== Details ==
 * Use this with the [[API RegisterForDrag|RegisterForDrag()]] function and the <OnDragStart>...</OnDragStart> event to allow your frame-based object to be moved by the user.
-----
+* Use the [[API StopMovingOrSizing|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.
-;''Arguments''
+* Moving a frame using this function sets the user placed flag for the frame, making the client save its position and reposition the frame on reload. To avoid this behavior, you can call frame:[[API Frame SetUserPlaced|SetUserPlaced]](false) immediately after StopMovingOrSizing().
 *For pixel-precise movements, you should instead use [[API EnableMouse|EnableMouse()]] and the <OnMouseDown>...</OnMouseDown> and <OnMouseUp>...</OnMouseUp> events (and probably also the <OnHide>...</OnHide> event).
 *If the frame becomes stuck by any cause (see [[API SetClampedToScreen|SetClampedToScreen()]]), the mouse and the frame will go out-of-sync.
 *This function together with [[API StopMovingOrSizing|StopMovingOrSizing()]] exhibit some "special" behavior that can cause problems when used with frames that are not anchored to UIParent (or some other full-screen frame).

WoWWiki>Taleden: Updated with new information (behavior of StartMoving(),StopMovingOrSizing() on frames with a non-UIParent anchor frame)

2008-12-12T01:50:32Z

Updated with new information (behavior of StartMoving(),StopMovingOrSizing() on frames with a non-UIParent anchor frame)

← Older revision		Revision as of 01:50, 12 December 2008
Line 25:		Line 25:
	;''Description''		;''Description''

	: Moves the frame-based object in relation to where the mouse is being moved.		*Moves the frame-based object in relation to where the mouse is being moved.
	: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.		*Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function and the <OnDragStart>...</OnDragStart> event to allow your frame-based object to be moved by the user.
	: Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.		*Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.
			*For pixel-precise movements, you should instead use [[API EnableMouse\|EnableMouse()]] and the <OnMouseDown>...</OnMouseDown> and <OnMouseUp>...</OnMouseUp> events (and probably also the <OnHide>...</OnHide> event).

	;''Notes''		;''Notes''
	:If the frame becomes stuck by any cause (see [[API SetClampedToScreen\|SetClampedToScreen()]]), the mouse and the frame will go ~~off~~-sync.		*If the frame becomes stuck by any cause (see [[API SetClampedToScreen\|SetClampedToScreen()]]), the mouse and the frame will go out-of-sync.
	~~:As for Patch 2~~.3, ~~at the end of the movement~~ the frame will ~~automatically change anchors~~ to the ~~closest point of the parent~~, ~~on a same~~-to-~~same basis~~ (TOPLEFT to TOPLEFT, ~~BOTTOM to BOTTOM~~...) and, ~~apparently~~, ~~there isn't a~~ way to ~~prevent this behaviour~~. ~~This might be a problem if~~ you ~~intend~~ to ~~automatically resize~~ the frame after ~~a user drag~~ - ~~you might find it undesirably aligning itself~~ to the ~~new~~ anchor ~~point~~, ~~resulting in surprising~~ "~~jumping around~~" after a [[API ~~SetWidth~~\|~~SetWidth~~()]] or [[API ~~SetHeight~~\|~~SetHeight~~()]].		*This function together with [[API StopMovingOrSizing\|StopMovingOrSizing()]] exhibit some "special" behavior that can cause problems when used with frames that are not anchored to UIParent (or some other full-screen frame).
			**Immediately upon calling StartMoving(), the frame will be de-anchored from any other frame it was previously anchored to, and instead anchored to the screen. For example, if MyFrame's TOPLEFT is anchored to MyParent's TOPLEFT at (5,-5), and MyParent's TOPLEFT is anchored to UIParent's TOPLEFT at (100,-100), then MyFrame:StartMoving() immediately re-anchors MyFrame's TOPLEFT to the screen's (nil anchor) TOPLEFT at (105,-105). The original anchor frame (MyParent) and offset will not be restored by [[API StopMovingOrSizing\|StopMovingOrSizing()]].
			**Furthermore, [[API StopMovingOrSizing\|StopMovingOrSizing()]] will identify the closest anchor point on the screen and re-anchor the frame once again to that closest point. For example, if MyFrame is dragged to (50,-600) (still relative to the screen), and has a height of 25, then MyFrame:[[API StopMovingOrSizing\|StopMovingOrSizing()]] immediately re-anchors MyFrame's BOTTOMLEFT to the screen's BOTTOMLEFT at (50,143) (recall that the WoW UI always has height 768 regardless of resolution).
			**There does not appear to be any way to disable either of these behaviors. If you want your frame to end up anchored to the same frame it was anchored to initially, one way to work around this issue is to store the result of GetPoint() three times:
			*** immediately before StartMoving(), to get the initial offset relative-to-frame
			*** immediately after StartMoving(), to get the initial offset relative-to-screen
			*** immediately before [[API StopMovingOrSizing\|StopMovingOrSizing()]], to get the final offset relative-to-screen, but before the anchor points are (potentially) changed
			**This way, you can subtract the second measurement from the third to get a "delta" (x,y) for the total movement, and then add that to the first measurement to get the appropriate final offset relative-to-frame. You can then manually re-anchor your frame to its appropriate parent, at its new offset -- but you must do so after calling [[API StopMovingOrSizing\|StopMovingOrSizing()]] (and [[API ClearAllPoints\|ClearAllPoints()]]).

WoWWiki>SinusPi: notes

2008-04-17T23:44:49Z

notes

← Older revision		Revision as of 23:44, 17 April 2008
Line 28:		Line 28:
	: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.		: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.
	: Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.		: Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.

			;''Notes''
			:If the frame becomes stuck by any cause (see [[API SetClampedToScreen\|SetClampedToScreen()]]), the mouse and the frame will go off-sync.
			:As for Patch 2.3, at the end of the movement the frame will automatically change anchors to the closest point of the parent, on a same-to-same basis (TOPLEFT to TOPLEFT, BOTTOM to BOTTOM...) and, apparently, there isn't a way to prevent this behaviour. This might be a problem if you intend to automatically resize the frame after a user drag - you might find it undesirably aligning itself to the new anchor point, resulting in surprising "jumping around" after a [[API SetWidth\|SetWidth()]] or [[API SetHeight\|SetHeight()]].

WoWWiki>Pcj at 04:23, 2 December 2007

2007-12-02T04:23:19Z

← Older revision		Revision as of 04:23, 2 December 2007
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	~~<center>'''StartMoving''' ''-Documentation by [[User:AeroBrain\|AeroBrain]]-''</center>~~

	Moves the frame-based object in relation to where the mouse is being moved.		Moves the frame-based object in relation to where the mouse is being moved.

WoWWiki>JoshBorke: fixed a typo for StopMovingOrSizing link

2006-06-17T03:23:49Z

fixed a typo for StopMovingOrSizing link

← Older revision		Revision as of 03:23, 17 June 2006
Line 29:		Line 29:
	: Moves the frame-based object in relation to where the mouse is being moved.		: Moves the frame-based object in relation to where the mouse is being moved.
	: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.		: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.
	: Use the [[API ~~StopMovingOrResizing~~\|~~StopMovingOrResizing~~()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.		: Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.

WoWWiki>Mikk: {{widgetmethod}}

2006-06-10T12:00:38Z

← Older revision		Revision as of 12:00, 10 June 2006
Line 1:		Line 1:
			{{widgetmethod}}

	<center>'''StartMoving''' ''-Documentation by [[User:AeroBrain\|AeroBrain]]-''</center>		<center>'''StartMoving''' ''-Documentation by [[User:AeroBrain\|AeroBrain]]-''</center>

Line 28:		Line 30:
	: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.		: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.
	: Use the [[API StopMovingOrResizing\|StopMovingOrResizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.		: Use the [[API StopMovingOrResizing\|StopMovingOrResizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.

	~~----~~
	~~{{WoW API}}~~

WoWWiki>Muert at 05:14, 4 January 2006

2006-01-04T05:14:55Z

← Older revision		Revision as of 05:14, 4 January 2006
Line 30:		Line 30:

	----		----
	{{~~Template:~~WoW API}}		{{WoW API}}
	~~[[Category:API Functions\|Frame StartMoving]]~~
	~~[[Category:API Frame Functions\|Frame StartMoving]]~~

← Older revision		Revision as of 23:44, 17 April 2008
Line 28:		Line 28:
	: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.		: Use this with the [[API RegisterForDrag\|RegisterForDrag()]] function to allow your frame-based object to be moved by the user.
	: Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.		: Use the [[API StopMovingOrSizing\|StopMovingOrSizing()]] function inside the <OnDragStop>...</OnDragStop> XML section to stop the moving process.

			;''Notes''
			:If the frame becomes stuck by any cause (see [[API SetClampedToScreen\|SetClampedToScreen()]]), the mouse and the frame will go off-sync.
			:As for Patch 2.3, at the end of the movement the frame will automatically change anchors to the closest point of the parent, on a same-to-same basis (TOPLEFT to TOPLEFT, BOTTOM to BOTTOM...) and, apparently, there isn't a way to prevent this behaviour. This might be a problem if you intend to automatically resize the frame after a user drag - you might find it undesirably aligning itself to the new anchor point, resulting in surprising "jumping around" after a [[API SetWidth\|SetWidth()]] or [[API SetHeight\|SetHeight()]].