Backed out changeset 0a133d5fd155 (bug 1864534) for causing screenshot related failur...
[gecko.git] / testing / docs / eventutils.rst
blob37eaa4bd9150703cccc7a8306efcfb6f91c0c170
1 EventUtils documentation
2 ========================
4 ``EventUtils``' methods are available in all browser mochitests on the ``EventUtils``
5 object.
7 In mochitest-plain and mochitest-chrome, you can load
8 ``"chrome://mochikit/content/tests/SimpleTest/EventUtils.js"`` using a regular
9 HTML script tag to gain access to this set of utilities. In this case, all the
10 documented methods here are **not** on a separate object, but available as global
11 functions.
13 Mouse input
14 -----------
16 .. js:autofunction:: sendMouseEvent
17 .. js:autofunction:: EventUtils.synthesizeMouse
18 .. js:autofunction:: synthesizeMouseAtCenter
19 .. js:autofunction:: synthesizeNativeMouseEvent
20 .. js:autofunction:: synthesizeMouseExpectEvent
22 .. js:autofunction:: synthesizeWheel
23 .. js:autofunction:: EventUtils.synthesizeWheelAtPoint
24 .. js:autofunction:: sendWheelAndPaint
25 .. js:autofunction:: sendWheelAndPaintNoFlush
27 Keyboard input
28 --------------
30 .. js:autofunction:: sendKey
31 .. js:autofunction:: EventUtils.sendChar
32 .. js:autofunction:: sendString
33 .. js:autofunction:: EventUtils.synthesizeKey
34 .. js:autofunction:: synthesizeNativeKey
35 .. js:autofunction:: synthesizeKeyExpectEvent
37 Drag and drop
38 -------------
40 .. js:autofunction:: synthesizeDragOver
41 .. js:autofunction:: synthesizeDrop
42 .. js:autofunction:: synthesizeDropAfterDragOver
43 .. js:autofunction:: synthesizePlainDragAndDrop
44 .. js:autofunction:: synthesizePlainDragAndCancel
45 .. js:autofunction:: sendDragEvent