Patch: [#22524] Update Windows Recent Documents on Open/Save
[blender.git] / intern / ghost / intern / GHOST_DisplayManagerCocoa.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_DisplayManagerCocoa.h
30  * Declaration of GHOST_DisplayManagerCocoa class.
31  */
32
33 #ifndef _GHOST_DISPLAY_MANAGER_COCOA_H_
34 #define _GHOST_DISPLAY_MANAGER_COCOA_H_
35
36 #ifndef __APPLE__
37 #error Apple only!
38 #endif // __APPLE__
39
40 #include "GHOST_DisplayManager.h"
41
42 /**
43  * Manages system displays  (Mac OSX/Cocoa implementation).
44  * @see GHOST_DisplayManager
45  * @author      Maarten Gribnau
46  * @date        September 21, 2001
47  */
48 class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager
49 {
50 public:
51         /**
52          * Constructor.
53          */
54         GHOST_DisplayManagerCocoa(void);
55
56         /**
57          * Returns the number of display devices on this system.
58          * @param numDisplays The number of displays on this system.
59          * @return Indication of success.
60          */
61         virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
62
63         /**
64          * Returns the number of display settings for this display device.
65          * @param display The index of the display to query with 0 <= display < getNumDisplays().
66          * @param setting The number of settings of the display device with this index.
67          * @return Indication of success.
68          */
69         virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
70
71         /**
72          * Returns the current setting for this display device. 
73          * @param display The index of the display to query with 0 <= display < getNumDisplays().
74          * @param index   The setting index to be returned.
75          * @param setting The setting of the display device with this index.
76          * @return Indication of success.
77          */
78         virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
79
80         /**
81          * Returns the current setting for this display device. 
82          * @param display The index of the display to query with 0 <= display < getNumDisplays().
83          * @param setting The current setting of the display device with this index.
84          * @return Indication of success.
85          */
86         virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
87
88         /**
89          * Changes the current setting for this display device. 
90          * @param display The index of the display to query with 0 <= display < getNumDisplays().
91          * @param setting The current setting of the display device with this index.
92          * @return Indication of success.
93          */
94         virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
95
96 protected:      
97         //Do not cache values as OS X supports screen hot plug
98         /** Cached number of displays. */
99         //CGDisplayCount m_numDisplays;
100         /** Cached display id's for each display. */
101         //CGDirectDisplayID* m_displayIDs;
102 };
103
104
105 #endif // _GHOST_DISPLAY_MANAGER_COCOA_H_
106