add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_DisplayManagerCarbon.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_DisplayManagerCarbon.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_DisplayManagerCarbon class.
32  */
33
34 #ifndef _GHOST_DISPLAY_MANAGER_CARBON_H_
35 #define _GHOST_DISPLAY_MANAGER_CARBON_H_
36
37 #ifndef __APPLE__
38 #error Apple only!
39 #endif // __APPLE__
40
41 #include "GHOST_DisplayManager.h"
42
43 #define __CARBONSOUND__
44 #include <Carbon/Carbon.h>
45
46 /**
47  * Manages system displays  (Mac OSX/Carbon implementation).
48  * @see GHOST_DisplayManager
49  * @author      Maarten Gribnau
50  * @date        September 21, 2001
51  */
52 class GHOST_DisplayManagerCarbon : public GHOST_DisplayManager
53 {
54 public:
55         /**
56          * Constructor.
57          */
58         GHOST_DisplayManagerCarbon(void);
59
60         /**
61          * Returns the number of display devices on this system.
62          * @param numDisplays The number of displays on this system.
63          * @return Indication of success.
64          */
65         virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) 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         virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
74
75         /**
76          * Returns the current setting for this display device. 
77          * @param display The index of the display to query with 0 <= display < getNumDisplays().
78          * @param index   The setting index to be returned.
79          * @param setting The setting of the display device with this index.
80          * @return Indication of success.
81          */
82         virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
83
84         /**
85          * Returns the current setting for this display device. 
86          * @param display The index of the display to query with 0 <= display < getNumDisplays().
87          * @param setting The current setting of the display device with this index.
88          * @return Indication of success.
89          */
90         virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
91
92         /**
93          * Changes 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         virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
99
100 protected:
101         /**
102          * Returns a value from a dictionary.
103          * @param       values  Dictionary to return value from.
104          * @param       key     Key to return value for.
105          * @return The value for this key.
106          */
107         long getValue(CFDictionaryRef values, CFStringRef key) const;
108         
109         /** Cached number of displays. */
110         CGDisplayCount m_numDisplays;
111         /** Cached display id's for each display. */
112         CGDirectDisplayID* m_displayIDs;
113 };
114
115
116 #endif // _GHOST_DISPLAY_MANAGER_CARBON_H_
117