Merge branch 'blender2.7'
[blender.git] / intern / ghost / intern / GHOST_WindowManager.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_WindowManager.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_WindowManager class.
31  */
32
33 #ifndef __GHOST_WINDOWMANAGER_H__
34 #define __GHOST_WINDOWMANAGER_H__
35
36 #include <vector>
37
38 #include "GHOST_Rect.h"
39 #include "GHOST_IWindow.h"
40
41
42 /**
43  * Manages system windows (platform independent implementation).
44  * \author      Maarten Gribnau
45  * \date        May 11, 2001
46  */
47 class GHOST_WindowManager
48 {
49 public:
50         /**
51          * Constructor.
52          */
53         GHOST_WindowManager();
54
55         /**
56          * Destructor.
57          */
58         ~GHOST_WindowManager();
59
60         /**
61          * Add a window to our list.
62          * It is only added if it is not already in the list.
63          * \param       window Pointer to the window to be added.
64          * \return      Indication of success.
65          */
66         GHOST_TSuccess addWindow(GHOST_IWindow *window);
67
68         /**
69          * Remove a window from our list.
70          * \param       window Pointer to the window to be removed.
71          * \return      Indication of success.
72          */
73         GHOST_TSuccess removeWindow(const GHOST_IWindow *window);
74
75         /**
76          * Returns whether the window is in our list.
77          * \param       window Pointer to the window to query.
78          * \return      A boolean indicator.
79          */
80         bool getWindowFound(const GHOST_IWindow *window) const;
81
82         /**
83          * Returns whether one of the windows is fullscreen.
84          * \return      A boolean indicator.
85          */
86         bool getFullScreen(void) const;
87
88         /**
89          * Returns pointer to the full-screen window.
90          * \return      The full-screen window (NULL if not in full-screen).
91          */
92         GHOST_IWindow *getFullScreenWindow(void) const;
93
94         /**
95          * Activates fullscreen mode for a window.
96          * \param window The window displayed fullscreen.
97          * \return      Indication of success.
98          */
99         GHOST_TSuccess beginFullScreen(GHOST_IWindow *window, const bool stereoVisual);
100
101         /**
102          * Closes fullscreen mode down.
103          * \return      Indication of success.
104          */
105         GHOST_TSuccess endFullScreen(void);
106
107         /**
108          * Sets new window as active window (the window receiving events).
109          * There can be only one window active which should be in the current window list.
110          * \param window The new active window.
111          */
112         GHOST_TSuccess setActiveWindow(GHOST_IWindow *window);
113
114         /**
115          * Returns the active window (the window receiving events).
116          * There can be only one window active which should be in the current window list.
117          * \return window The active window (or NULL if there is none).
118          */
119         GHOST_IWindow *getActiveWindow(void) const;
120
121
122         /**
123          * Set this window to be inactive (not receiving events).
124          * \param window The window to deactivate.
125          */
126         void setWindowInactive(const GHOST_IWindow *window);
127
128
129         /**
130          * Return a vector of the windows currently managed by this
131          * class.
132          * \warning It is very dangerous to mess with the contents of
133          * this vector. Please do not destroy or add windows use the
134          * interface above for this,
135          */
136         std::vector<GHOST_IWindow *> & getWindows();
137
138         /**
139          * Finds the window associated with an OS window object/handle
140          * \param osWindow The OS window object/handle
141          * \return The associated window, null if none corresponds
142          */
143         GHOST_IWindow *getWindowAssociatedWithOSWindow(void *osWindow);
144
145         /**
146          * Return true if any windows has a modified status
147          * \return True if any window has unsaved changes
148          */
149         bool getAnyModifiedState();
150
151 protected:
152         /** The list of windows managed */
153         std::vector<GHOST_IWindow *> m_windows;
154
155         /** Window in fullscreen state. There can be only one of this which is not in or window list. */
156         GHOST_IWindow *m_fullScreenWindow;
157
158         /** The active window. */
159         GHOST_IWindow *m_activeWindow;
160
161         /** Window that was active before entering fullscreen state. */
162         GHOST_IWindow *m_activeWindowBeforeFullScreen;
163
164 #ifdef WITH_CXX_GUARDEDALLOC
165         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_WindowManager")
166 #endif
167
168 };
169
170 #endif // __GHOST_WINDOWMANAGER_H__