Mercurial > molko

annotate doc/api-molko-event.rst @ 191:633a25df450e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
molko-js: miscellaneous fixes While here, import sphinx as experimental documentation.
author David Demelier <markand@malikania.fr>
date Sat, 07 Nov 2020 15:40:34 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
191
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .. toctree::
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .. _api-molko-event:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 Molko.Event
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ===========
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 Poll user and kernel events from the main loop.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .. caution::
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 Not polling events in the main loop may end in an unresponsive application on
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 some platforms.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 Constants
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 ---------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .. js:data:: Molko.Event
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 The following values are available into the object itself:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 ``CLICK_DOWN``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 Mouse click down.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 ``CLICK_UP``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 Mouse click release.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 ``KEY_DOWN``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 Keyboard key down.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ``KEY_UP``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 Keyboard key release.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 ``MOUSE``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 Mouse motion.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 ``QUIT``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 User quit event.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 Functions
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 ---------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 .. js:function:: Molko.Event.poll()
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 :returns: An object or undefined if there are no more events.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 Get the next pending event in the queue. It is recommended to use this function
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 in a loop to unqueue the whole list of events at once for performance reasons.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 The returned object has different properties depending on the event.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 For both ``CLICK_DOWN`` and ``CLICK_UP`` events:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 ``x (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 ``y (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 ``button (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 Button number (1 through 5 are standards).
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 For both ``KEY_DOWN`` and ``KEY_UP`` events:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 ``key (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 Key number.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 For ``MOUSE`` event:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 ``x (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 ``y (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 ``buttons (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 Bitmask of buttons currently pressed.