]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/display.tex
Always use wxFULL_REPAINT_ON_RESIZE for generic status bar.
[wxWidgets.git] / docs / latex / wx / display.tex
CommitLineData
a7fee33e
JS
1\section{\class{wxDisplay}}\label{wxdisplay}
2
3Determines the sizes and locations of displays connected to the system.
4
5\wxheading{Derived from}
6
7None
8
9\wxheading{Include files}
10
11<wx/display.h>
12
13\wxheading{See also}
14
15\helpref{wxClientDisplayRect}{wxclientdisplayrect}, \helpref{wxDisplaySize}{wxdisplaysize}, \helpref{wxDisplaySizeMM}{wxdisplaysizemm}
16
17\latexignore{\rtfignore{\wxheading{Members}}}
18
93255dad 19
b236c10f 20\membersection{wxDisplay::wxDisplay}\label{wxdisplayctor}
a7fee33e
JS
21
22\func{}{wxDisplay}{\param{size\_t }{index = 0}}
23
24Constructor, setting up a wxDisplay instance with the specified display.
25
26\wxheading{Parameters}
27
28\docparam{index}{The index of the display to use. This must be non-negative
93255dad
VZ
29and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
30
a7fee33e 31
b236c10f 32\membersection{wxDisplay::\destruct{wxDisplay}}\label{wxdisplaydtor}
a7fee33e
JS
33
34\func{void}{\destruct{wxDisplay}}{\void}
35
36Destructor.
37
93255dad 38
d6108c66
VZ
39\membersection{wxDisplay::ChangeMode}\label{wxdisplaychangemode}
40
41\func{bool }{ChangeMode}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
42
43Changes the video mode of this display to the mode specified
44in the mode parameter.
45
46If wxDefaultVideoMode is passed in as the mode parameter,
47the defined behaviour is that wxDisplay will reset the video
48mode to the default mode used by the display. On Windows,
49the behavior is normal. However, there are differences on other
50platforms. On Unix variations using X11 extensions it should
51behave as defined, but some irregularities may occur.
52
53On wxMac passing in wxDefaultVideoMode as the mode
54parameter does nothing. This happens because carbon
55no longer has access to DMUseScreenPrefs, an undocumented
56function that changed the video mode to the system
57default by using the system's 'scrn' resource.
58
59
6c5d6291
VZ
60\membersection{wxDisplay::GetClientArea}\label{wxdisplaygetclientarea}
61
62\constfunc{wxRect }{GetClientArea}{\void}
63
64Returns the client area of the display. The client area is the part of the
65display available for the normal (non full screen) windows, usually it is the
66same as \helpref{GetGeometry}{wxdisplaygetgeometry} but it could be less if
67there is a taskbar (or equivalent) on this display.
68
69\wxheading{See also:}
70
71\helpref{wxClientDisplayRect}{wxclientdisplayrect}
72
73
a7fee33e
JS
74\membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
75
76\func{static size\_t}{GetCount}{\void}
77
78Returns the number of connected displays.
79
93255dad 80
d6108c66
VZ
81\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
82
83\constfunc{wxVideoMode }{GetCurrentMode}{\void}
84
85Returns the current video mode that this display is in.
86
87
a7fee33e
JS
88\membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
89
90\constfunc{int }{GetDepth}{\void}
91
92Returns the bit depth of the display whose index was passed to the constructor.
93
93255dad 94
a7fee33e
JS
95\membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
96
97\func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
98
9d4e821b
VZ
99Returns the index of the display on which the given point lies. Returns
100\texttt{wxNOT\_FOUND} if the point is not on any connected display.
a7fee33e
JS
101
102\wxheading{Parameters}
103
104\docparam{pt}{The point to locate.}
105
93255dad 106
940bbac1
RN
107\membersection{wxDisplay::GetFromWindow}\label{wxdisplaygetfromwindow}
108
109\func{static int}{GetFromWindow}{\param{wxWindow* }{win}}
110
111Returns the index of the display on which the given window lies.
112
113If the window is on more than one display it gets the display that overlaps the window the most.
114
9d4e821b 115Returns \texttt{wxNOT\_FOUND} if the window is not on any connected display.
af7e4f87 116
940bbac1
RN
117\wxheading{Parameters}
118
119\docparam{win}{The window to locate.}
120
121
a7fee33e
JS
122\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
123
124\constfunc{wxRect }{GetGeometry}{\void}
125
126Returns the bounding rectangle of the display whose index was passed to the
127constructor.
128
6c5d6291
VZ
129\wxheading{See also:}
130
131\helpref{GetClientArea}{wxdisplaygetclientarea}, \helpref{wxDisplaySize}{wxdisplaysize}
132
93255dad 133
d6108c66
VZ
134\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
135
136\constfunc{wxArrayVideoModes }{GetModes}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
137
138Fills and returns an array with all the video modes that
139are supported by this display, or video modes that are
140supported by this display and match the mode parameter
141(if mode is not wxDefaultVideoMode).
142
143
a7fee33e
JS
144\membersection{wxDisplay::GetName}\label{wxdisplaygetname}
145
146\constfunc{wxString }{GetName}{\void}
147
148Returns the display's name. A name is not available on all platforms.
149
93255dad 150
a7fee33e
JS
151\membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
152
153\func{bool }{IsPrimary}{\void}
154
155Returns true if the display is the primary display. The primary display is the
156one whose index is 0.
157