Welcome to mirror list, hosted at ThFree Co, Russian Federation.

GHOST_WindowManager.h « intern « ghost « intern - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 8297e4d24d23b38c9f4160f7dcca97e284acfb56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file ghost/intern/GHOST_WindowManager.h
 *  \ingroup GHOST
 * Declaration of GHOST_WindowManager class.
 */

#ifndef __GHOST_WINDOWMANAGER_H__
#define __GHOST_WINDOWMANAGER_H__

#include <vector>

#include "GHOST_Rect.h"
#include "GHOST_IWindow.h"


/**
 * Manages system windows (platform independent implementation).
 * \author	Maarten Gribnau
 * \date	May 11, 2001
 */
class GHOST_WindowManager
{
public:
	/**
	 * Constructor.
	 */
	GHOST_WindowManager();

	/**
	 * Destructor.
	 */
	virtual ~GHOST_WindowManager();

	/**
	 * Add a window to our list.
	 * It is only added if it is not already in the list.
	 * \param	window Pointer to the window to be added.
	 * \return	Indication of success.
	 */
	virtual GHOST_TSuccess addWindow(GHOST_IWindow *window);

	/**
	 * Remove a window from our list.
	 * \param	window Pointer to the window to be removed.
	 * \return	Indication of success.
	 */
	virtual GHOST_TSuccess removeWindow(const GHOST_IWindow *window);

	/**
	 * Returns whether the window is in our list.
	 * \param	window Pointer to the window to query.
	 * \return	A boolean indicator.
	 */
	virtual bool getWindowFound(const GHOST_IWindow *window) const;

	/**
	 * Returns whether one of the windows is fullscreen.
	 * \return	A boolean indicator.
	 */
	virtual bool getFullScreen(void) const;

	/**
	 * Returns pointer to the full-screen window.
	 * \return	The full-screen window (NULL if not in full-screen).
	 */
	virtual GHOST_IWindow *getFullScreenWindow(void) const;

	/**
	 * Activates fullscreen mode for a window.
	 * \param window The window displayed fullscreen.
	 * \return	Indication of success.
	 */
	virtual GHOST_TSuccess beginFullScreen(GHOST_IWindow *window, const bool stereoVisual);

	/**
	 * Closes fullscreen mode down.
	 * \return	Indication of success.
	 */
	virtual GHOST_TSuccess endFullScreen(void);

	/**
	 * Sets new window as active window (the window receiving events).
	 * There can be only one window active which should be in the current window list.
	 * \param window The new active window.
	 */
	virtual GHOST_TSuccess setActiveWindow(GHOST_IWindow *window);
	
	/**
	 * Returns the active window (the window receiving events).
	 * There can be only one window active which should be in the current window list.
	 * \return window The active window (or NULL if there is none).
	 */
	virtual GHOST_IWindow *getActiveWindow(void) const;
	

	/**
	 * Set this window to be inactive (not receiving events).
	 * \param window The window to deactivate.
	 */
	virtual void setWindowInactive(const GHOST_IWindow *window);
	

	/**
	 * Return a vector of the windows currently managed by this 
	 * class. 
	 * \warning It is very dangerous to mess with the contents of
	 * this vector. Please do not destroy or add windows use the 
	 * interface above for this,
	 */
	std::vector<GHOST_IWindow *> & getWindows();
	
	/**
	 * Finds the window associated with an OS window object/handle
	 * \param osWindow The OS window object/handle
	 * \return The associated window, null if none corresponds
	 */
	virtual GHOST_IWindow *getWindowAssociatedWithOSWindow(void *osWindow);
	
	/**
	 * Return true if any windows has a modified status
	 * \return True if any window has unsaved changes
	 */
	bool getAnyModifiedState();

protected:
	/** The list of windows managed */
	std::vector<GHOST_IWindow *> m_windows;

	/** Window in fullscreen state. There can be only one of this which is not in or window list. */
	GHOST_IWindow *m_fullScreenWindow;

	/** The active window. */
	GHOST_IWindow *m_activeWindow;

	/** Window that was active before entering fullscreen state. */
	GHOST_IWindow *m_activeWindowBeforeFullScreen;

#ifdef WITH_CXX_GUARDEDALLOC
	MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_WindowManager")
#endif
	
};

#endif // __GHOST_WINDOWMANAGER_H__