// Name: display.h
// Purpose: interface of wxDisplay
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Determines the sizes and locations of displays connected to the system.
@library{wxcore}
- @category{misc}
+ @category{cfg}
@see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
*/
The index of the display to use. This must be non-negative and
lower than the value returned by GetCount().
*/
- wxDisplay(unsigned index = 0);
+ wxDisplay(unsigned int index = 0);
/**
Destructor.
If wxDefaultVideoMode is passed in as the mode parameter, the defined
behaviour is that wxDisplay will reset the video mode to the default
- mode used by the display. On Windows, the behavior is normal. However,
+ mode used by the display. On Windows, the behaviour is normal. However,
there are differences on other platforms. On Unix variations using X11
extensions it should behave as defined, but some irregularities may
occur.
-
- On wxMac passing in wxDefaultVideoMode as the mode parameter does
- nothing. This happens because carbon no longer has access to
- @c DMUseScreenPrefs(), an undocumented function that changed the video
- mode to the system default by using the system's "scrn" resource.
*/
bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode);
/**
Returns the number of connected displays.
*/
- static unsigned GetCount();
+ static unsigned int GetCount();
/**
Returns the current video mode that this display is in.
*/
wxVideoMode GetCurrentMode() const;
- /**
- Returns the bit depth of the display whose index was passed to the
- constructor.
- */
- int GetDepth() const;
-
/**
Returns the index of the display on which the given point lies, or
@c wxNOT_FOUND if the point is not on any connected display.
Returns @true if the display is the primary display. The primary
display is the one whose index is 0.
*/
- bool IsPrimary();
+ bool IsPrimary() const;
};