API Doc: vmouse changes

AliciaLippert · AliciaLippert · commit 38a85754e04e · 2012-10-16T14:48:54.000-04:00
Quick fix in vmousedown xml, changes in example and xml for vmousemove.
diff --git a/entries/vmousedown.xml b/entries/vmousedown.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <entry name="vmousedown" type="event" return="jQuery">
 	<title>vmousedown</title>
-	<desc>Virtualized mouseover event handler.</desc>
+	<desc>Virtualized mousedown event handler.</desc>
 	<longdesc>
 		<p>The jQuery Mobile <code>vmousedown</code> event handler simulates the "onmousedown" event handler on mobile devices. This event is fired on the initial touch of the screen on the device.</p>
 		<p>The idea behind virtualized mouse events is to translate touch events into mouse events. Developers should be aware that these virtualized mouse events will not prevent any synthetic mouse events from being triggered inside the browser after a touch event. If a mouse-type device is used on the system, the virtualized mouse events are dispatched at the same time as the normal mouse events.</p>
@@ -15,6 +15,9 @@
 		    });
 		]]></code>
 	</pre>
+		<p>
+			<iframe src="/resources/vmousedown/example1.html" style="width:100%;height:90px;border:0px"></iframe>
+		</p>
 	</longdesc>
 	<added>1.0</added>
 	<signature>
@@ -23,12 +26,5 @@
 		</argument>
 
 	</signature>
-	<pre>
-		<code>
-			<p>
-				<iframe src="/resources/vmousedown/example1.html" style="width:100%;height:90px;border:0px"></iframe>
-			</p>
-		</code>
-	</pre>
 	<category slug="events"/>
 </entry>
diff --git a/entries/vmousemove.xml b/entries/vmousemove.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<entry name="vmousedown" type="event" return="jQuery">
+	<title>vmousemove</title>
+	<desc>Virtualized mouseover event handler.</desc>
+	<longdesc>
+		<p>The jQuery Mobile <code>vmousemove</code> event handler simulates the "onmousemove" event handler on mobile devices.</p>
+		<p><i>The idea behind virtualized mouse events is to translate touch events into mouse events. Developers should be aware that these virtualized mouse events will not prevent any synthetic mouse events from being triggered inside the browser after a touch event. If a mouse-type device is used on the system, the virtualized mouse events are dispatched at the same time as the normal mouse events.</i></p>
+
+		<xi:include href="../includes/core-extension-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+		<pre>
+		<code><![CDATA[
+			$("#target").mousemove(function(event) {
+			  var msg = "Handler for .mousemove() called at ";
+			  msg += event.pageX + ", " + event.pageY;
+			  $("#log").append("<div>" + msg + "</div>");
+			});
+		]]></code>
+	</pre>
+		<p>
+			<iframe src="/resources/vmousemove/example1.html" style="width:100%;height:90px;border:0px"></iframe>
+		</p>
+	</longdesc>
+	<added>1.0</added>
+	<methods>
+		<method name="preventDefault" optional="true">
+			<desc>A function to invoke in the event binding to prevent the synthetic click event by the browser.</desc>
+		</method>
+
+	</methods>
+	<category slug="events"/>
+</entry>
diff --git a/resources/vmousemove/example1.html b/resources/vmousemove/example1.html
@@ -0,0 +1,27 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>vmousedown demo</title>
+    <link rel="stylesheet" href="http://code.jquery.com/mobile/1.1.1/jquery.mobile-1.1.1.min.css">
+    <script src="http://code.jquery.com/jquery-1.7.2.min.js"></script>
+    <script src="http://code.jquery.com/mobile/1.1.1/jquery.mobile-1.1.1.min.js"></script>
+</head>
+<body>
+    <div id="target">
+      Move here
+    </div>
+    <div id="other">
+      Trigger the handler
+    </div>
+    <div id="log"></div>
+    <script>
+        $("#target").mousemove(function(event) {
+          var msg = "Handler for .mousemove() called at ";
+          msg += event.pageX + ", " + event.pageY;
+          $("#log").append("<div>" + msg + "</div>");
+        });
+    </script>
+</body>
+</html>
