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