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