X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f2e64141685959602737941d25da7fa9c6254bb4..03ee685abfa69862b5d0eeba36e6dc6b41e84531:/wxPython/src/_display.i diff --git a/wxPython/src/_display.i b/wxPython/src/_display.i index 259d1a92cd..9e26f5f69d 100644 --- a/wxPython/src/_display.i +++ b/wxPython/src/_display.i @@ -227,7 +227,22 @@ function is not supported at all on this platform.", ""); DocDeclStr( virtual bool , ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode), - "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", ""); DocDeclStr(