reSWIGged

[wxWidgets.git] / wxPython / src / gtk / _misc.py

diff --git a/wxPython/src/gtk/_misc.py b/wxPython/src/gtk/_misc.py
index 423219abae4b87e314cbca68d063e90973c602f3..5a39f375263a2ea3dde949d0ba8ccc0ff6a74d62 100644 (file)
--- a/wxPython/src/gtk/_misc.py
+++ b/wxPython/src/gtk/_misc.py
@@ -5631,7 +5631,22 @@ class Display(object):
         """
         ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool
 
-        Change current mode, return true if succeeded, false otherwise
+        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.
+
+        Returns True if succeeded, False otherwise
         """
         return _misc_.Display_ChangeMode(*args, **kwargs)