wx.Display

Inheritance diagram for wx.Display:

Description

Determines the sizes and locations of displays connected to the system.

See also

wx.ClientDisplayRect, wx.DisplaySize, wx.DisplaySizeMM

Methods Summary

• __init__
• ChangeMode
• GetClientArea
• GetCount
• GetCurrentMode
• GetFromPoint
• GetFromWindow
• GetGeometry
• GetModes
• GetName
• IsOk
• IsPrimary
• ResetMode

Properties Summary

• ClientArea
• CurrentMode
• Geometry
• Modes
• Name

Class API

Methods

__init__(index=0)

Set up a wx.Display instance with the specified display. The displays are numbered from 0 to GetCount() - 1, 0 is always the primary display and the only one which is always supported.

Parameters:

• index (int): The index of the display to use. This must be non-negative and lower than the value returned by GetCount().

Returns:

wx.Display

---

ChangeMode(mode=wx.DefaultVideoMode)

Changes the video mode of this display to the mode specified in the mode parameter.

If wx.DefaultVideoMode is passed in as the mode parameter, the defined behaviour is that wx.Display will reset the video mode to the default mode used by the display. On Windows, the behavior 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.

On wxMac passing in wx.DefaultVideoMode as the mode parameter does nothing. This happens because carbon no longer has access to DMUseScreenPrefs, an undocumented function that changed the video mode to the system default by using the system’s ‘scrn’ resource.

Parameters:

• mode (int)

Returns:

bool

---

GetClientArea()

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.

Returns:

wx.Rect

---

GetCount()

Returns the number of connected displays.

Returns:

int

---

GetCurrentMode()

Returns the current video mode that this display is in.

Returns:

int

---

GetFromPoint(pt)

Returns the index of the display on which the given point lies.

Returns wx.NOT_FOUND if the point is not on any connected display.

Parameters:

• pt (wx.Point): The point to locate.

Returns:

int

---

GetFromWindow(window)

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 wx.NOT_FOUND if the window is not on any connected display.

Parameters:

• window (wx.Window)

Returns:

int

---

GetGeometry()

Returns the bounding rectangle of the display whose index was passed to the constructor.

Returns:

wx.Rect

---

GetModes(mode=wx.DefaultVideoMode)

Enumerate all video modes supported by this display matching the given one (in the sense of VideoMode.Match()).

As any mode matches the default value of the argument and there is always at least one video mode supported by display, the returned array is only empty for the default value of the argument if this function is not supported at all on this platform.

Parameters:

• mode (int)

Returns:

list of integers

---

GetName()

Returns the display’s name. A name is not available on all platforms.

Returns:

string

---

IsOk()

Return True if the object was initialized successfully

Returns:

bool

---

IsPrimary()

Returns True if the display is the primary display. The primary display is the one whose index is 0.

Returns:

bool

---

ResetMode()

Restore the default video mode (just a more readable synonym).

---

Properties

ClientArea

See GetClientArea

CurrentMode

See GetCurrentMode

Geometry

See GetGeometry

Modes

See GetModes

Name

See GetName