Skip to content

Commit 62b01e0

Browse files
committed
API Doc: Revision to vmousedown
1 parent 260a6df commit 62b01e0

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

entries/vmousedown.xml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
<desc>Virtualized mouseover event handler.</desc>
55
<longdesc>
66
<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>
7+
<p><i>Warning: Requires a mouse-type device to work.</i></p>
8+
<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>
9+
710
<xi:include href="../includes/core-extension-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
811
<pre>
912
<code><![CDATA[
@@ -16,9 +19,10 @@
1619
</longdesc>
1720
<added>1.0</added>
1821
<signature>
19-
<argument name="callback" type="Function" optional="true">
20-
<desc>A function to invoke after the vmousedown event is fired.</desc>
22+
<argument name="preventDefault" type="Function" optional="true">
23+
<desc>A function to invoke in the event binding to prevent the synthetic click event by the browser.</desc>
2124
</argument>
25+
2226
</signature>
2327
<pre>
2428
<code>

0 commit comments

Comments
 (0)