interface/display.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        display.h
   3 // Purpose:     interface of wxDisplay
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxDisplay
  11     @wxheader{display.h}
  12
  13     Determines the sizes and locations of displays connected to the system.
  14
  15     @library{wxcore}
  16     @category{misc}
  17
  18     @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
  19 */
  20 class wxDisplay
  21 {
  22 public:
  23     /**
  24         Constructor, setting up a wxDisplay instance with the specified
  25         display.
  26
  27         @param index
  28             The index of the display to use. This must be non-negative and
  29             lower than the value returned by GetCount().
  30     */
  31     wxDisplay(unsigned index = 0);
  32
  33     /**
  34         Destructor.
  35     */
  36     ~wxDisplay();
  37
  38     /**
  39         Changes the video mode of this display to the mode specified in the
  40         mode parameter.
  41
  42         If wxDefaultVideoMode is passed in as the mode parameter, the defined
  43         behaviour is that wxDisplay will reset the video mode to the default
  44         mode used by the display. On Windows, the behavior is normal. However,
  45         there are differences on other platforms. On Unix variations using X11
  46         extensions it should behave as defined, but some irregularities may
  47         occur.
  48
  49         On wxMac passing in wxDefaultVideoMode as the mode parameter does
  50         nothing. This happens because carbon no longer has access to
  51         @c DMUseScreenPrefs(), an undocumented function that changed the video
  52         mode to the system default by using the system's "scrn" resource.
  53     */
  54     bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode);
  55
  56     /**
  57         Returns the client area of the display. The client area is the part of
  58         the display available for the normal (non full screen) windows, usually
  59         it is the same as GetGeometry() but it could be less if there is a
  60         taskbar (or equivalent) on this display.
  61     */
  62     wxRect GetClientArea() const;
  63
  64     /**
  65         Returns the number of connected displays.
  66     */
  67     static unsigned GetCount();
  68
  69     /**
  70         Returns the current video mode that this display is in.
  71     */
  72     wxVideoMode GetCurrentMode() const;
  73
  74     /**
  75         Returns the bit depth of the display whose index was passed to the
  76         constructor.
  77     */
  78     int GetDepth() const;
  79
  80     /**
  81         Returns the index of the display on which the given point lies, or
  82         @c wxNOT_FOUND if the point is not on any connected display.
  83
  84         @param pt
  85             The point to locate.
  86     */
  87     static int GetFromPoint(const wxPoint& pt);
  88
  89     /**
  90         Returns the index of the display on which the given window lies.
  91
  92         If the window is on more than one display it gets the display that
  93         overlaps the window the most.
  94
  95         Returns @c wxNOT_FOUND if the window is not on any connected display.
  96
  97         @param win
  98             The window to locate.
  99     */
 100     static int GetFromWindow(const wxWindow* win);
 101
 102     /**
 103         Returns the bounding rectangle of the display whose index was passed to
 104         the constructor.
 105
 106         @see GetClientArea(), wxDisplaySize()
 107     */
 108     wxRect GetGeometry() const;
 109
 110     /**
 111         Fills and returns an array with all the video modes that are supported
 112         by this display, or video modes that are supported by this display and
 113         match the mode parameter (if mode is not wxDefaultVideoMode).
 114     */
 115     wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const;
 116
 117     /**
 118         Returns the display's name. A name is not available on all platforms.
 119     */
 120     wxString GetName() const;
 121
 122     /**
 123         Returns @true if the display is the primary display. The primary
 124         display is the one whose index is 0.
 125     */
 126     bool IsPrimary();
 127 };
 128