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