intern/ghost/intern/GHOST_DisplayManagerWin32.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_WIN32_H_
  41 #define _GHOST_DISPLAY_MANAGER_WIN32_H_
  42
  43 #ifdef HAVE_CONFIG_H
  44 #include <config.h>
  45 #endif
  46
  47 #ifndef WIN32
  48 #error WIN32 only!
  49 #endif // WIN32
  50
  51 #include "GHOST_DisplayManager.h"
  52
  53
  54 /**
  55  * Manages system displays  (WIN32 implementation).
  56  */
  57
  58 class GHOST_DisplayManagerWin32 : public GHOST_DisplayManager
  59 {
  60 public:
  61         /**
  62          * Constructor.
  63          */
  64         GHOST_DisplayManagerWin32(void);
  65
  66         /**
  67          * Returns the number of display devices on this system.
  68          * @param numDisplays The number of displays on this system.
  69          * @return Indication of success.
  70          */
  71         virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
  72
  73         /**
  74          * Returns the number of display settings for this display device.
  75          * @param display The index of the display to query with 0 <= display < getNumDisplays().
  76          * @param setting The number of settings of the display device with this index.
  77          * @return Indication of success.
  78          */
  79         virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
  80
  81         /**
  82          * Returns the current setting for this display device.
  83          * @param display The index of the display to query with 0 <= display < getNumDisplays().
  84          * @param index   The setting index to be returned.
  85          * @param setting The setting of the display device with this index.
  86          * @return Indication of success.
  87          */
  88         virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
  89
  90         /**
  91          * Returns the current setting for this display device.
  92          * @param display The index of the display to query with 0 <= display < getNumDisplays().
  93          * @param setting The current setting of the display device with this index.
  94          * @return Indication of success.
  95          */
  96         virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
  97
  98         /**
  99          * Changes the current setting for this display device.
 100          * @param display The index of the display to query with 0 <= display < getNumDisplays().
 101          * @param setting The current setting of the display device with this index.
 102          * @return Indication of success.
 103          */
 104         virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
 105
 106 protected:
 107 };
 108
 109
 110 #endif // _GHOST_DISPLAY_MANAGER_WIN32_H_
 111