Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_DisplayManagerCocoa.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_DisplayManagerCocoa class.
22  */
23
24 #ifndef __GHOST_DISPLAYMANAGERCOCOA_H__
25 #define __GHOST_DISPLAYMANAGERCOCOA_H__
26
27 #ifndef __APPLE__
28 #error Apple only!
29 #endif // __APPLE__
30
31 #include "GHOST_DisplayManager.h"
32
33 /**
34  * Manages system displays  (Mac OSX/Cocoa implementation).
35  * \see GHOST_DisplayManager
36  */
37 class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager
38 {
39 public:
40         /**
41          * Constructor.
42          */
43         GHOST_DisplayManagerCocoa(void);
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 getNumDisplays(GHOST_TUns8& numDisplays) const;
51
52         /**
53          * Returns the number of display settings for this display device.
54          * \param display The index of the display to query with 0 <= display < getNumDisplays().
55          * \param numSetting: The number of settings of the display device with this index.
56          * \return Indication of success.
57          */
58         GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
59
60         /**
61          * Returns the current setting for this display device.
62          * \param display The index of the display to query with 0 <= display < getNumDisplays().
63          * \param index   The setting index to be returned.
64          * \param setting The setting of the display device with this index.
65          * \return Indication of success.
66          */
67         GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
68
69         /**
70          * Returns the current setting for this display device.
71          * \param display The index of the display to query with 0 <= display < getNumDisplays().
72          * \param setting The current setting of the display device with this index.
73          * \return Indication of success.
74          */
75         GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
76
77         /**
78          * Changes the current setting for this display device.
79          * \param display The index of the display to query with 0 <= display < getNumDisplays().
80          * \param setting The current setting of the display device with this index.
81          * \return Indication of success.
82          */
83         GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
84
85 protected:
86         //Do not cache values as OS X supports screen hot plug
87         /** Cached number of displays. */
88         //CGDisplayCount m_numDisplays;
89         /** Cached display id's for each display. */
90         //CGDirectDisplayID* m_displayIDs;
91 };
92
93
94 #endif // __GHOST_DISPLAYMANAGERCOCOA_H__