Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_Buttons.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup GHOST
21  * Declaration of GHOST_Buttons struct.
22  */
23
24 #ifndef __GHOST_BUTTONS_H__
25 #define __GHOST_BUTTONS_H__
26
27 #include "GHOST_Types.h"
28
29
30 /**
31  * This struct stores the state of the mouse buttons.
32  * Buttons can be set using button masks.
33  */
34 struct GHOST_Buttons {
35         /**
36          * Constructor.
37          */
38         GHOST_Buttons();
39
40         ~GHOST_Buttons();
41
42         /**
43          * Returns the state of a single button.
44          * \param mask Key button to return.
45          * \return The state of the button (pressed == true).
46          */
47         bool get(GHOST_TButtonMask mask) const;
48
49         /**
50          * Updates the state of a single button.
51          * \param mask Button state to update.
52          * \param down The new state of the button.
53          */
54         void set(GHOST_TButtonMask mask, bool down);
55
56         /**
57          * Sets the state of all buttons to up.
58          */
59         void clear();
60
61         GHOST_TUns8 m_ButtonLeft        : 1;
62         GHOST_TUns8 m_ButtonMiddle      : 1;
63         GHOST_TUns8 m_ButtonRight       : 1;
64 };
65
66 #endif // __GHOST_BUTTONS_H__