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