annotate src/mouse.h @ 49:a8c7db56ccb0

core: backed out changeset 55869b5e4761 We don't need properties because we will generate them in the map.
author David Demelier <markand@malikania.fr>
date Fri, 17 Jan 2020 12:09:30 +0100
parents bc1fdff76775
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * mouse.h -- mouse definitions
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_MOUSE_H
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_MOUSE_H
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file mouse.h
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Mouse definitions.
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 /**
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 * \brief Buttons from mouse.
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 *
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * This enumeration is used as both flags or constants. For example when the
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 * user press one button on the mouse it generates one constant event. On the
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * other hand, while moving the mouse the user may have one or more buttons
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * pressed, thus the OR'ed combination.
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 enum mouse_button {
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 MOUSE_BUTTON_UNKNOWN = 0, /*!< No buttons pressed */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 MOUSE_BUTTON_LEFT = (1 << 0), /*!< Left button pressed */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 MOUSE_BUTTON_MIDDLE = (1 << 1), /*!< Middle button pressed */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 MOUSE_BUTTON_RIGHT = (1 << 2) /*!< Right button pressed */
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 };
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
bc1fdff76775 core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 #endif /* !MOLKO_MOUSE_H */