Merge pull request jquery#53 from AliciaLippert/master

agcolom · agcolom · commit d69d396aaf08 · 2012-10-16T10:38:51.000-07:00
API Doc: Revised vMouseDown
diff --git a/entries/vmousedown.xml b/entries/vmousedown.xml
@@ -1,24 +1,27 @@
 <?xml version="1.0"?>
 <entry name="vmousedown" type="event" return="jQuery">
-	<title>.vmousedown()</title>
+	<title>vmousedown</title>
 	<desc>Virtualized mouseover 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 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>
+
 		<xi:include href="../includes/core-extension-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 		<pre>
 		<code><![CDATA[
 			$(function(){
-			    $("p").vmousedown(function(){
+			    $(document).on("vmousedown", "p", function(){
 		      $(this).append('<span style="color:#00F;">Mouse down.</span>');
 		    });
 		]]></code>
 	</pre>
 	</longdesc>
 	<added>1.0</added>
 	<signature>
-		<argument name="callback" type="Function" optional="true">
-			<desc>A function to invoke after the vmousedown event is fired.</desc>
+		<argument name="preventDefault" type="Function" optional="true">
+			<desc>A function to invoke in the event binding to prevent the synthetic click event by the browser.</desc>
 		</argument>
+
 	</signature>
 	<pre>
 		<code>
diff --git a/resources/vmousedown/example1.html b/resources/vmousedown/example1.html
@@ -11,9 +11,10 @@
 <body>
     <p>Touch here, move up and down to see what happens.</p>
     <script>
-        $("p").mousedown(function(){
-          $(this).append('<span style="color:#00F;">Mouse down.</span>');
-        });
+            $(function(){
+                $(document).on("vmousedown", "p", function(){
+              $(this).append('<span style="color:#00F;">Mouse down.</span>');
+            });
     </script>
 </body>
 </html>
