fixed spacing in the headers to get rid of some warnings and some other
[blender.git] / intern / ghost / intern / GHOST_DisplayManagerCarbon.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        September 21, 2001
38  */
39
40 #ifndef _GHOST_DISPLAY_MANAGER_CARBON_H_
41 #define _GHOST_DISPLAY_MANAGER_CARBON_H_
42
43 #ifndef __APPLE__
44 #error Apple only!
45 #endif // __APPLE__
46
47 #include "GHOST_DisplayManager.h"
48
49 #include <Carbon/Carbon.h>
50
51 /**
52  * Manages system displays  (Mac OSX/Carbon implementation).
53  */
54
55 class GHOST_DisplayManagerCarbon : public GHOST_DisplayManager
56 {
57 public:
58         /**
59          * Constructor.
60          */
61         GHOST_DisplayManagerCarbon(void);
62
63         /**
64          * Returns the number of display devices on this system.
65          * @param numDisplays The number of displays on this system.
66          * @return Indication of success.
67          */
68         virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
69
70         /**
71          * Returns the number of display settings for this display device.
72          * @param display The index of the display to query with 0 <= display < getNumDisplays().
73          * @param setting The number of settings of the display device with this index.
74          * @return Indication of success.
75          */
76         virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) 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         virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
86
87         /**
88          * Returns the current setting for this display device. 
89          * @param display The index of the display to query with 0 <= display < getNumDisplays().
90          * @param setting The current setting of the display device with this index.
91          * @return Indication of success.
92          */
93         virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
94
95         /**
96          * Changes the current setting for this display device. 
97          * @param display The index of the display to query with 0 <= display < getNumDisplays().
98          * @param setting The current setting of the display device with this index.
99          * @return Indication of success.
100          */
101         virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
102
103 protected:
104         /**
105          * Returns a value from a dictionary.
106          * @param       values  Dictionary to return value from.
107          * @param       key     Key to return value for.
108          * @return The value for this key.
109          */
110         long getValue(CFDictionaryRef values, CFStringRef key) const;
111         
112         /** Cached number of displays. */
113         CGDisplayCount m_numDisplays;
114         /** Cached display id's for each display. */
115         CGDirectDisplayID* m_displayIDs;
116 };
117
118
119 #endif // _GHOST_DISPLAY_MANAGER_CARBON_H_
120