From d6108c664af9b48a9fbeb8bb53c757c19c74da72 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 25 Jul 2004 11:01:23 +0000
Subject: [PATCH] docs for Change/GetMode(s) (patch 966312)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28451 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/display.tex | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/docs/latex/wx/display.tex b/docs/latex/wx/display.tex
index 628cee6b98..baf8889cbd 100644
--- a/docs/latex/wx/display.tex
+++ b/docs/latex/wx/display.tex
@@ -36,6 +36,27 @@ and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
 Destructor.
 
 
+\membersection{wxDisplay::ChangeMode}\label{wxdisplaychangemode}
+
+\func{bool }{ChangeMode}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
+
+Changes the video mode of this display to the mode specified
+in the mode parameter.
+
+If wxDefaultVideoMode is passed in as the mode parameter,
+the defined behaviour is that wxDisplay 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 wxDefaultVideoMode 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.
+
+
 \membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
 
 \func{static size\_t}{GetCount}{\void}
@@ -43,6 +64,13 @@ Destructor.
 Returns the number of connected displays.
 
 
+\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
+
+\constfunc{wxVideoMode }{GetCurrentMode}{\void}
+
+Returns the current video mode that this display is in. 
+
+
 \membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
 
 \constfunc{int }{GetDepth}{\void}
@@ -70,6 +98,16 @@ Returns the bounding rectangle of the display whose index was passed to the
 constructor.
 
 
+\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
+
+\constfunc{wxArrayVideoModes }{GetModes}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
+
+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 wxDefaultVideoMode).
+
+
 \membersection{wxDisplay::GetName}\label{wxdisplaygetname}
 
 \constfunc{wxString }{GetName}{\void}
-- 
2.47.2