add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_DisplayManager.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_DisplayManager.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_DisplayManager class.
32  */
33
34 #ifndef _GHOST_DISPLAY_MANAGER_H_
35 #define _GHOST_DISPLAY_MANAGER_H_
36
37 #include "GHOST_Types.h"
38
39 #include <vector>
40
41 /**
42  * Manages system displays  (platform independent implementation).
43  * @author      Maarten Gribnau
44  * @date        September 21, 2001
45  */
46 class GHOST_DisplayManager
47 {
48 public:
49         enum { kMainDisplay = 0 };
50         /**
51          * Constructor.
52          */
53         GHOST_DisplayManager(void);
54         
55         /**
56          * Destructor.
57          */
58         virtual ~GHOST_DisplayManager(void);
59
60         /**
61          * Initializes the list with devices and settings.
62          * @return Indication of success.
63          */
64         virtual GHOST_TSuccess initialize(void);
65
66         /**
67          * Returns the number of display devices on this system.
68          * @param numDisplays The number of displays on this system.
69          * @return Indication of success.
70          */
71         virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
72
73         /**
74          * Returns the number of display settings for this display device.
75          * @param display The index of the display to query with 0 <= display < getNumDisplays().
76          * @param setting The number of settings of the display device with this index.
77          * @return Indication of success.
78          */
79         virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
80
81         /**
82          * Returns the current setting for this display device. 
83          * @param display The index of the display to query with 0 <= display < getNumDisplays().
84          * @param index   The setting index to be returned.
85          * @param setting The setting of the display device with this index.
86          * @return Indication of success.
87          */
88         virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
89
90         /**
91          * Returns the current setting for this display device. 
92          * @param display The index of the display to query with 0 <= display < getNumDisplays().
93          * @param setting The current setting of the display device with this index.
94          * @return Indication of success.
95          */
96         virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
97
98         /**
99          * Changes the current setting for this display device.
100          * The setting given to this method is matched againts the available diplay settings.
101          * The best match is activated (@see findMatch()).
102          * @param display The index of the display to query with 0 <= display < getNumDisplays().
103          * @param setting The setting of the display device to be matched and activated.
104          * @return Indication of success.
105          */
106         virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
107
108 protected:
109         typedef std::vector<GHOST_DisplaySetting> GHOST_DisplaySettings;
110
111         /**
112          * Finds the best display settings match.
113          * @param display       The index of the display device.
114          * @param setting       The setting to match.
115          * @param match         The optimal display setting.
116          * @return Indication of success.
117          */
118         GHOST_TSuccess findMatch(GHOST_TUns8 display, const GHOST_DisplaySetting& setting, GHOST_DisplaySetting& match) const;
119
120         /**
121          * Retrieves settings for each display device and stores them.
122          * @return Indication of success.
123          */
124         GHOST_TSuccess initializeSettings(void);
125         
126         /** Tells whether the list of display modes has been stored already. */
127         bool m_settingsInitialized;
128         /** The list with display settings for the main display. */
129         std::vector<GHOST_DisplaySettings> m_settings;
130 };
131
132
133 #endif // _GHOST_DISPLAY_MANAGER_H_
134