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