7af86a1113c1b2f664ff374beac6d1a4ddf6c9c8
[blender.git] / intern / ghost / intern / GHOST_WindowManager.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 11, 2001
38  */
39
40 #ifndef _GHOST_WINDOW_MANAGER_H_
41 #define _GHOST_WINDOW_MANAGER_H_
42
43
44 #ifdef WIN32
45 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
46 #endif // WIN32
47
48 #include <vector>
49
50 #include "GHOST_Rect.h"
51 #include "GHOST_IWindow.h"
52
53 //class GHOST_Window;
54
55 /**
56  * Manages system windows (platform independent implementation).
57  */
58
59 class GHOST_WindowManager
60 {
61 public:
62         /**
63          * Constructor.
64          */
65         GHOST_WindowManager();
66
67         /**
68          * Destructor.
69          */
70         virtual ~GHOST_WindowManager();
71
72         /**
73          * Add a window to our list.
74          * It is only added if it is not already in the list.
75          * @param       window Pointer to the window to be added.
76          * @return      Indication of success.
77          */
78         virtual GHOST_TSuccess addWindow(GHOST_IWindow* window);
79
80         /**
81          * Remove a window from our list.
82          * @param       window Pointer to the window to be removed.
83          * @return      Indication of success.
84          */
85         virtual GHOST_TSuccess removeWindow(const GHOST_IWindow* window);
86
87         /**
88          * Returns whether the window is in our list.
89          * @param       window Pointer to the window to query.
90          * @return      A boolean indicator.
91          */
92         virtual bool getWindowFound(const GHOST_IWindow* window) const;
93
94         /**
95          * Returns whether one of the windows is fullscreen.
96          * @return      A boolean indicator.
97          */
98         virtual bool getFullScreen(void) const;
99
100         /**
101          * Returns pointer to the full-screen window.
102          * @return      The fll-screen window (0 if not in full-screen).
103          */
104         virtual GHOST_IWindow* getFullScreenWindow(void) const;
105
106         /**
107          * Activates fullscreen mode for a window.
108          * @param window The window displayed fullscreen.
109          * @return      Indication of success.
110          */
111         virtual GHOST_TSuccess beginFullScreen(GHOST_IWindow* window, const bool stereoVisual);
112
113         /**
114          * Closes fullscreen mode down.
115          * @return      Indication of success.
116          */
117         virtual GHOST_TSuccess endFullScreen(void);
118
119         /**
120          * Sets new window as active window (the window receiving events).
121          * There can be only one window active which should be in the current window list.
122          * @param window The new active window.
123          */
124         virtual GHOST_TSuccess setActiveWindow(GHOST_IWindow* window);
125         
126         /**
127          * Returns the active window (the window receiving events).
128          * There can be only one window active which should be in the current window list.
129          * @return window The active window (or NULL if there is none).
130          */
131         virtual GHOST_IWindow* getActiveWindow(void) const;
132         
133
134         /**
135          * Set this window to be inactive (not receiving events).
136          * @param window The window to decativate.
137          */
138         virtual void setWindowInactive(const GHOST_IWindow* window);
139         
140
141         /**
142          * Return a vector of the windows currently managed by this 
143          * class. 
144          * @warning It is very dangerous to mess with the contents of 
145          * this vector. Please do not destroy or add windows use the 
146          * interface above for this,
147          */
148
149                 std::vector<GHOST_IWindow *> &
150         getWindows(
151         );
152
153
154 protected:
155         /** The list of windows managed */
156         std::vector<GHOST_IWindow*> m_windows;
157
158         /** Window in fullscreen state. There can be only one of this which is not in or window list. */
159         GHOST_IWindow* m_fullScreenWindow;
160
161         /** The active window. */
162         GHOST_IWindow* m_activeWindow;
163 };
164
165 #endif // _GHOST_WINDOW_MANAGER_H_