1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Display:
==========================================================================================================================================
|phoenix_title| **wx.Display**
==========================================================================================================================================
Determines the sizes and locations of displays connected to the system.
.. seealso:: :ref:`wx.ClientDisplayRect`, :ref:`wx.DisplaySize`, :ref:`wx.DisplaySizeMM`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Display</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.Display_inheritance.png" alt="Inheritance diagram of Display" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Display.html" title="wx.Display" alt="" coords="5,5,93,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Display.__init__` Constructor, setting up a :ref:`wx.Display` instance with the specified display.
:meth:`~wx.Display.ChangeMode` Changes the video mode of this display to the mode specified in the mode parameter.
:meth:`~wx.Display.GetClientArea` Returns the client area of the display.
:meth:`~wx.Display.GetCount` Returns the number of connected displays.
:meth:`~wx.Display.GetCurrentMode` Returns the current video mode that this display is in.
:meth:`~wx.Display.GetFromPoint` Returns the index of the display on which the given point lies, or ``NOT_FOUND`` if the point is not on any connected display.
:meth:`~wx.Display.GetFromWindow` Returns the index of the display on which the given window lies.
:meth:`~wx.Display.GetGeometry` Returns the bounding rectangle of the display whose index was passed to the constructor.
:meth:`~wx.Display.GetModes` 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 DefaultVideoMode).
:meth:`~wx.Display.GetName` Returns the display's name.
:meth:`~wx.Display.IsPrimary` Returns ``True`` if the display is the primary display.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Display.ClientArea` See :meth:`~wx.Display.GetClientArea`
:attr:`~wx.Display.CurrentMode` See :meth:`~wx.Display.GetCurrentMode`
:attr:`~wx.Display.Geometry` See :meth:`~wx.Display.GetGeometry`
:attr:`~wx.Display.Name` See :meth:`~wx.Display.GetName`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Display(object)
**Possible constructors**::
Display(index=0)
Determines the sizes and locations of displays connected to the
system.
.. method:: __init__(self, index=0)
Constructor, setting up a :ref:`wx.Display` instance with the specified display.
:param `index`: The index of the display to use. This must be non-negative and lower than the value returned by :meth:`GetCount` .
:type `index`: int
.. method:: ChangeMode(self, mode=DefaultVideoMode)
Changes the video mode of this display to the mode specified in the mode parameter.
If DefaultVideoMode is passed in as the mode parameter, the defined behaviour is that :ref:`wx.Display` 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.
:param `mode`:
:type `mode`: wx.VideoMode
:rtype: `bool`
.. method:: GetClientArea(self)
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 :meth:`GetGeometry` but it could be less if there is a taskbar (or equivalent) on this display.
:rtype: :ref:`wx.Rect`
.. staticmethod:: GetCount()
Returns the number of connected displays.
:rtype: `int`
.. method:: GetCurrentMode(self)
Returns the current video mode that this display is in.
:rtype: :ref:`wx.VideoMode`
.. staticmethod:: GetFromPoint(pt)
Returns the index of the display on which the given point lies, or ``NOT_FOUND`` if the point is not on any connected display.
:param `pt`: The point to locate.
:type `pt`: wx.Point
:rtype: `int`
.. staticmethod:: GetFromWindow(win)
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 ``NOT_FOUND`` if the window is not on any connected display.
:param `win`: The window to locate.
:type `win`: wx.Window
:rtype: `int`
.. method:: GetGeometry(self)
Returns the bounding rectangle of the display whose index was passed to the constructor.
:rtype: :ref:`wx.Rect`
.. seealso:: :meth:`GetClientArea` , :ref:`wx.DisplaySize`
.. method:: GetModes(self, mode=DefaultVideoMode)
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 DefaultVideoMode).
:param `mode`:
:type `mode`: wx.VideoMode
:rtype: :ref:`ArrayVideoModes`
.. method:: GetName(self)
Returns the display's name.
A name is not available on all platforms.
:rtype: `string`
.. method:: IsPrimary(self)
Returns ``True`` if the display is the primary display.
The primary display is the one whose index is 0.
:rtype: `bool`
.. attribute:: ClientArea
See :meth:`~wx.Display.GetClientArea`
.. attribute:: CurrentMode
See :meth:`~wx.Display.GetCurrentMode`
.. attribute:: Geometry
See :meth:`~wx.Display.GetGeometry`
.. attribute:: Name
See :meth:`~wx.Display.GetName`
|
