#include <wx/display.h>
Determines the sizes and locations of displays connected to the system.
<>< =''>:</>&;&;< =''>\ </></>
Public Member Functions | |
wxDisplay () | |
Default constructor creating wxDisplay object representing the primary display. More... | |
wxDisplay (unsigned int index) | |
Constructor, setting up a wxDisplay instance with the specified display. More... | |
wxDisplay (const wxWindow *window) | |
Constructor creating the display object associated with the given window. More... | |
~wxDisplay () | |
Destructor. More... | |
bool | ChangeMode (const wxVideoMode &mode=wxDefaultVideoMode) |
Changes the video mode of this display to the mode specified in the mode parameter. More... | |
wxRect | GetClientArea () const |
Returns the client area of the display. More... | |
wxVideoMode | GetCurrentMode () const |
Returns the current video mode that this display is in. More... | |
wxRect | GetGeometry () const |
Returns the bounding rectangle of the display whose index was passed to the constructor. More... | |
wxArrayVideoModes | GetModes (const wxVideoMode &mode=wxDefaultVideoMode) const |
Fills and returns an array with all the video modes that are supported by this display, or video modes that are supported by this display and match the mode parameter (if mode is not wxDefaultVideoMode). More... | |
wxString | GetName () const |
Returns the display's name. More... | |
wxSize | GetPPI () const |
Returns display resolution in pixels per inch. More... | |
bool | IsPrimary () const |
Returns true if the display is the primary display. More... | |
Static Public Member Functions | |
static unsigned int | GetCount () |
Returns the number of connected displays. More... | |
static int | GetFromPoint (const wxPoint &pt) |
Returns the index of the display on which the given point lies, or wxNOT_FOUND if the point is not on any connected display. More... | |
static int | GetFromWindow (const wxWindow *win) |
Returns the index of the display on which the given window lies. More... | |
wxDisplay::wxDisplay | ( | ) |
Default constructor creating wxDisplay object representing the primary display.
|
explicit |
Constructor, setting up a wxDisplay instance with the specified display.
index | The index of the display to use. This must be non-negative and lower than the value returned by GetCount(). |
|
explicit |
Constructor creating the display object associated with the given window.
This is the most convenient way of finding the display on which the given window is shown while falling back to the default display if it is not shown at all or positioned outside of any display.
window | A valid, i.e. non-null, window. |
wxDisplay::~wxDisplay | ( | ) |
Destructor.
bool wxDisplay::ChangeMode | ( | const wxVideoMode & | mode = wxDefaultVideoMode | ) |
Changes the video mode of this display to the mode specified in the mode parameter.
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 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.
wxRect wxDisplay::GetClientArea | ( | ) | const |
Returns the client area of the display.
The client area is the part of the display available for the normal (non full screen) windows, usually it is the same as GetGeometry() but it could be less if there is a taskbar (or equivalent) on this display.
|
static |
Returns the number of connected displays.
wxVideoMode wxDisplay::GetCurrentMode | ( | ) | const |
Returns the current video mode that this display is in.
|
static |
Returns the index of the display on which the given point lies, or wxNOT_FOUND
if the point is not on any connected display.
pt | The point to locate. |
|
static |
Returns the index of the display on which the given window lies.
If the window is on more than one display it gets the display that overlaps the window the most.
Returns wxNOT_FOUND
if the window is not on any connected display.
win | The window to locate. |
wxRect wxDisplay::GetGeometry | ( | ) | const |
Returns the bounding rectangle of the display whose index was passed to the constructor.
wxArrayVideoModes wxDisplay::GetModes | ( | const wxVideoMode & | mode = wxDefaultVideoMode | ) | const |
Fills and returns an array with all the video modes that are supported by this display, or video modes that are supported by this display and match the mode parameter (if mode is not wxDefaultVideoMode).
wxString wxDisplay::GetName | ( | ) | const |
Returns the display's name.
The returned value is currently an empty string under all platforms except MSW.
wxSize wxDisplay::GetPPI | ( | ) | const |
bool wxDisplay::IsPrimary | ( | ) | const |
Returns true if the display is the primary display.
The primary display is the one whose index is 0.