Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_DisplayManagerX11.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup GHOST
21  * Declaration of GHOST_DisplayManagerX11 class.
22  */
23
24 #ifndef __GHOST_DISPLAYMANAGERX11_H__
25 #define __GHOST_DISPLAYMANAGERX11_H__
26
27 #include "GHOST_DisplayManager.h"
28
29
30 class GHOST_SystemX11;
31
32 /**
33  * Manages system displays  (X11 implementation).
34  */
35 class GHOST_DisplayManagerX11 : public GHOST_DisplayManager
36 {
37 public:
38         /**
39          * Constructor.
40          */
41         GHOST_DisplayManagerX11(
42             GHOST_SystemX11 *system
43             );
44
45         /**
46          * Returns the number of display devices on this system.
47          * \param numDisplays The number of displays on this system.
48          * \return Indication of success.
49          */
50         GHOST_TSuccess
51         getNumDisplays(
52             GHOST_TUns8& numDisplays
53             ) const;
54
55         /**
56          * Returns the number of display settings for this display device.
57          * \param display The index of the display to query with 0 <= display < getNumDisplays().
58          * \param numSetting: The number of settings of the display device with this index.
59          * \return Indication of success.
60          */
61         GHOST_TSuccess
62         getNumDisplaySettings(
63             GHOST_TUns8 display,
64             GHOST_TInt32& numSettings
65             ) const;
66
67         /**
68          * Returns the current setting for this display device.
69          * \param display The index of the display to query with 0 <= display < getNumDisplays().
70          * \param index   The setting index to be returned.
71          * \param setting The setting of the display device with this index.
72          * \return Indication of success.
73          */
74         GHOST_TSuccess
75         getDisplaySetting(
76             GHOST_TUns8 display,
77             GHOST_TInt32 index,
78             GHOST_DisplaySetting& setting
79             ) 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 setting The current setting of the display device with this index.
85          * \return Indication of success.
86          */
87         GHOST_TSuccess
88         getCurrentDisplaySetting(
89             GHOST_TUns8 display,
90             GHOST_DisplaySetting& setting
91             ) const;
92
93         /**
94          * Changes 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         setCurrentDisplaySetting(
101             GHOST_TUns8 display,
102             const GHOST_DisplaySetting& setting
103             );
104
105 private:
106
107         GHOST_SystemX11 *m_system;
108 };
109
110
111 #endif //