add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_DisplayManagerX11.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_DisplayManagerX11.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_DisplayManagerX11 class.
32  */
33
34 #ifndef _GHOST_DISPLAY_MANAGER_X11_H_
35 #define _GHOST_DISPLAY_MANAGER_X11_H_
36
37 #include "GHOST_DisplayManager.h"
38
39
40 class GHOST_SystemX11;
41
42 /**
43  * Manages system displays  (X11 implementation).
44  * @author      Laurence Bourn
45  * @date        October 26, 2001
46  */
47 class GHOST_DisplayManagerX11 : public GHOST_DisplayManager
48 {
49 public:
50         /**
51          * Constructor.
52          */
53         GHOST_DisplayManagerX11(
54                 GHOST_SystemX11 *system
55         );
56
57         /**
58          * Returns the number of display devices on this system.
59          * @param numDisplays The number of displays on this system.
60          * @return Indication of success.
61          */
62                 GHOST_TSuccess 
63         getNumDisplays(
64                 GHOST_TUns8& numDisplays
65         ) const;
66
67         /**
68          * Returns the number of display settings for this display device.
69          * @param display The index of the display to query with 0 <= display < getNumDisplays().
70          * @param setting The number of settings of the display device with this index.
71          * @return Indication of success.
72          */
73                 GHOST_TSuccess 
74         getNumDisplaySettings(
75                 GHOST_TUns8 display,
76                 GHOST_TInt32& numSettings
77         ) const;
78
79         /**
80          * Returns the current setting for this display device. 
81          * @param display The index of the display to query with 0 <= display < getNumDisplays().
82          * @param index   The setting index to be returned.
83          * @param setting The setting of the display device with this index.
84          * @return Indication of success.
85          */
86                 GHOST_TSuccess 
87         getDisplaySetting(
88                 GHOST_TUns8 display,
89                 GHOST_TInt32 index,
90                 GHOST_DisplaySetting& setting
91         ) const;
92
93         /**
94          * Returns the current setting for this display device. 
95          * @param display The index of the display to query with 0 <= display < getNumDisplays().
96          * @param setting The current setting of the display device with this index.
97          * @return Indication of success.
98          */
99                 GHOST_TSuccess 
100         getCurrentDisplaySetting(
101                 GHOST_TUns8 display,
102                 GHOST_DisplaySetting& setting
103         ) const;
104
105         /**
106          * Changes the current setting for this display device. 
107          * @param display The index of the display to query with 0 <= display < getNumDisplays().
108          * @param setting The current setting of the display device with this index.
109          * @return Indication of success.
110          */
111                 GHOST_TSuccess 
112         setCurrentDisplaySetting(
113                 GHOST_TUns8 display,
114                 const GHOST_DisplaySetting& setting
115         );
116
117 private :
118
119         GHOST_SystemX11 * m_system;
120 };
121
122
123 #endif // 
124