2003-09-11 03:24:38 -04:00
|
|
|
\section{\class{wxDisplay}}\label{wxdisplay}
|
|
|
|
|
|
|
|
Determines the sizes and locations of displays connected to the system.
|
|
|
|
|
|
|
|
\wxheading{Derived from}
|
|
|
|
|
|
|
|
None
|
|
|
|
|
|
|
|
\wxheading{Include files}
|
|
|
|
|
|
|
|
<wx/display.h>
|
|
|
|
|
2007-07-28 08:21:03 -04:00
|
|
|
\wxheading{Library}
|
|
|
|
|
|
|
|
\helpref{wxCore}{librarieslist}
|
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxClientDisplayRect}{wxclientdisplayrect}, \helpref{wxDisplaySize}{wxdisplaysize}, \helpref{wxDisplaySizeMM}{wxdisplaysizemm}
|
|
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2004-09-30 07:15:59 -04:00
|
|
|
\membersection{wxDisplay::wxDisplay}\label{wxdisplayctor}
|
2003-09-11 03:24:38 -04:00
|
|
|
|
2006-10-02 01:38:05 -04:00
|
|
|
\func{}{wxDisplay}{\param{unsigned }{index = 0}}
|
2003-09-11 03:24:38 -04:00
|
|
|
|
|
|
|
Constructor, setting up a wxDisplay instance with the specified display.
|
|
|
|
|
|
|
|
\wxheading{Parameters}
|
|
|
|
|
|
|
|
\docparam{index}{The index of the display to use. This must be non-negative
|
2003-09-27 09:49:01 -04:00
|
|
|
and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
|
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
|
2004-09-30 07:15:59 -04:00
|
|
|
\membersection{wxDisplay::\destruct{wxDisplay}}\label{wxdisplaydtor}
|
2003-09-11 03:24:38 -04:00
|
|
|
|
|
|
|
\func{void}{\destruct{wxDisplay}}{\void}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2004-07-25 07:01:23 -04:00
|
|
|
\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.
|
|
|
|
|
|
|
|
|
2006-03-16 11:07:24 -05:00
|
|
|
\membersection{wxDisplay::GetClientArea}\label{wxdisplaygetclientarea}
|
|
|
|
|
|
|
|
\constfunc{wxRect }{GetClientArea}{\void}
|
|
|
|
|
|
|
|
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 \helpref{GetGeometry}{wxdisplaygetgeometry} but it could be less if
|
|
|
|
there is a taskbar (or equivalent) on this display.
|
|
|
|
|
|
|
|
\wxheading{See also:}
|
|
|
|
|
|
|
|
\helpref{wxClientDisplayRect}{wxclientdisplayrect}
|
|
|
|
|
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
|
|
|
|
|
2006-10-02 01:38:05 -04:00
|
|
|
\func{static unsigned }{GetCount}{\void}
|
2003-09-11 03:24:38 -04:00
|
|
|
|
|
|
|
Returns the number of connected displays.
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2004-07-25 07:01:23 -04:00
|
|
|
\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
|
|
|
|
|
|
|
|
\constfunc{wxVideoMode }{GetCurrentMode}{\void}
|
|
|
|
|
|
|
|
Returns the current video mode that this display is in.
|
|
|
|
|
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
|
|
|
|
|
|
|
|
\constfunc{int }{GetDepth}{\void}
|
|
|
|
|
|
|
|
Returns the bit depth of the display whose index was passed to the constructor.
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
|
|
|
|
|
|
|
|
\func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
|
|
|
|
|
2006-02-09 21:30:38 -05:00
|
|
|
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.
|
2003-09-11 03:24:38 -04:00
|
|
|
|
|
|
|
\wxheading{Parameters}
|
|
|
|
|
|
|
|
\docparam{pt}{The point to locate.}
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2005-03-01 20:08:35 -05:00
|
|
|
\membersection{wxDisplay::GetFromWindow}\label{wxdisplaygetfromwindow}
|
|
|
|
|
2007-02-10 19:13:22 -05:00
|
|
|
\func{static int}{GetFromWindow}{\param{const wxWindow* }{win}}
|
2005-03-01 20:08:35 -05:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2006-02-09 21:30:38 -05:00
|
|
|
Returns \texttt{wxNOT\_FOUND} if the window is not on any connected display.
|
2005-03-01 21:47:47 -05:00
|
|
|
|
2005-03-01 20:08:35 -05:00
|
|
|
\wxheading{Parameters}
|
|
|
|
|
|
|
|
\docparam{win}{The window to locate.}
|
|
|
|
|
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
|
|
|
|
|
|
|
|
\constfunc{wxRect }{GetGeometry}{\void}
|
|
|
|
|
|
|
|
Returns the bounding rectangle of the display whose index was passed to the
|
|
|
|
constructor.
|
|
|
|
|
2006-03-16 11:07:24 -05:00
|
|
|
\wxheading{See also:}
|
|
|
|
|
|
|
|
\helpref{GetClientArea}{wxdisplaygetclientarea}, \helpref{wxDisplaySize}{wxdisplaysize}
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2004-07-25 07:01:23 -04:00
|
|
|
\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).
|
|
|
|
|
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\membersection{wxDisplay::GetName}\label{wxdisplaygetname}
|
|
|
|
|
|
|
|
\constfunc{wxString }{GetName}{\void}
|
|
|
|
|
|
|
|
Returns the display's name. A name is not available on all platforms.
|
|
|
|
|
2003-09-27 09:49:01 -04:00
|
|
|
|
2003-09-11 03:24:38 -04:00
|
|
|
\membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
|
|
|
|
|
|
|
|
\func{bool }{IsPrimary}{\void}
|
|
|
|
|
|
|
|
Returns true if the display is the primary display. The primary display is the
|
|
|
|
one whose index is 0.
|
|
|
|
|