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