X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/93255dade69278a97b83e36b0263146f3e1e30ad..43f06cfda107a4a74776b58dca3353a4414ecfb1:/docs/latex/wx/display.tex?ds=inline diff --git a/docs/latex/wx/display.tex b/docs/latex/wx/display.tex index 628cee6b98..b2c80bd300 100644 --- a/docs/latex/wx/display.tex +++ b/docs/latex/wx/display.tex @@ -17,7 +17,7 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxDisplay::wxDisplay}\label{wxdisplayconstr} +\membersection{wxDisplay::wxDisplay}\label{wxdisplayctor} \func{}{wxDisplay}{\param{size\_t }{index = 0}} @@ -29,13 +29,34 @@ Constructor, setting up a wxDisplay instance with the specified display. and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.} -\membersection{wxDisplay::\destruct{wxDisplay}} +\membersection{wxDisplay::\destruct{wxDisplay}}\label{wxdisplaydtor} \func{void}{\destruct{wxDisplay}}{\void} 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} @@ -54,41 +82,52 @@ Returns the bit depth of the display whose index was passed to the constructor. \func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}} -Returns the index of the display on which the given point lies. Returns -1 if -the point is not on any connected display. +Returns the index of the display on which the given point lies. Returns +\texttt{wxNOT\_FOUND} if the point is not on any connected display. \wxheading{Parameters} \docparam{pt}{The point to locate.} -\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry} +\membersection{wxDisplay::GetFromWindow}\label{wxdisplaygetfromwindow} -\constfunc{wxRect }{GetGeometry}{\void} +\func{static int}{GetFromWindow}{\param{wxWindow* }{win}} -Returns the bounding rectangle of the display whose index was passed to the -constructor. +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. -\membersection{wxDisplay::GetName}\label{wxdisplaygetname} +Returns \texttt{wxNOT\_FOUND} if the window is not on any connected display. -\constfunc{wxString }{GetName}{\void} +\wxheading{Parameters} -Returns the display's name. A name is not available on all platforms. +\docparam{win}{The window to locate.} + + +\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry} + +\constfunc{wxRect }{GetGeometry}{\void} +Returns the bounding rectangle of the display whose index was passed to the +constructor. -\membersection{wxDisplay::IsColour}\label{wxdisplayiscolour} -\constfunc{bool }{IsColour}{\void} +\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes} -Returns true if the display is color (has a depth greater than 1). +\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::IsColor}\label{wxdisplayiscolor} -\constfunc{bool }{IsColor}{\void} +\membersection{wxDisplay::GetName}\label{wxdisplaygetname} -Same as \helpref{IsColour()}{wxdisplayiscolour}. +\constfunc{wxString }{GetName}{\void} + +Returns the display's name. A name is not available on all platforms. \membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}