git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxDisplay}}\label{wxdisplay}
	2
	3	Determines the sizes and locations of displays connected to the system.
	4
	5	\wxheading{Derived from}
	6
	7	None
	8
	9	\wxheading{Include files}
	10
	11	<wx/display.h>
	12
	13	\wxheading{Library}
	14
	15	\helpref{wxCore}{librarieslist}
	16
	17	\wxheading{See also}
	18
	19	\helpref{wxClientDisplayRect}{wxclientdisplayrect}, \helpref{wxDisplaySize}{wxdisplaysize}, \helpref{wxDisplaySizeMM}{wxdisplaysizemm}
	20
	21	\latexignore{\rtfignore{\wxheading{Members}}}
	22
	23
	24	\membersection{wxDisplay::wxDisplay}\label{wxdisplayctor}
	25
	26	\func{}{wxDisplay}{\param{unsigned }{index = 0}}
	27
	28	Constructor, setting up a wxDisplay instance with the specified display.
	29
	30	\wxheading{Parameters}
	31
	32	\docparam{index}{The index of the display to use. This must be non-negative
	33	and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
	34
	35
	36	\membersection{wxDisplay::\destruct{wxDisplay}}\label{wxdisplaydtor}
	37
	38	\func{void}{\destruct{wxDisplay}}{\void}
	39
	40	Destructor.
	41
	42
	43	\membersection{wxDisplay::ChangeMode}\label{wxdisplaychangemode}
	44
	45	\func{bool }{ChangeMode}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
	46
	47	Changes the video mode of this display to the mode specified
	48	in the mode parameter.
	49
	50	If wxDefaultVideoMode is passed in as the mode parameter,
	51	the defined behaviour is that wxDisplay will reset the video
	52	mode to the default mode used by the display. On Windows,
	53	the behavior is normal. However, there are differences on other
	54	platforms. On Unix variations using X11 extensions it should
	55	behave as defined, but some irregularities may occur.
	56
	57	On wxMac passing in wxDefaultVideoMode as the mode
	58	parameter does nothing. This happens because carbon
	59	no longer has access to DMUseScreenPrefs, an undocumented
	60	function that changed the video mode to the system
	61	default by using the system's 'scrn' resource.
	62
	63
	64	\membersection{wxDisplay::GetClientArea}\label{wxdisplaygetclientarea}
	65
	66	\constfunc{wxRect }{GetClientArea}{\void}
	67
	68	Returns the client area of the display. The client area is the part of the
	69	display available for the normal (non full screen) windows, usually it is the
	70	same as \helpref{GetGeometry}{wxdisplaygetgeometry} but it could be less if
	71	there is a taskbar (or equivalent) on this display.
	72
	73	\wxheading{See also:}
	74
	75	\helpref{wxClientDisplayRect}{wxclientdisplayrect}
	76
	77
	78	\membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
	79
	80	\func{static unsigned }{GetCount}{\void}
	81
	82	Returns the number of connected displays.
	83
	84
	85	\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
	86
	87	\constfunc{wxVideoMode }{GetCurrentMode}{\void}
	88
	89	Returns the current video mode that this display is in.
	90
	91
	92	\membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
	93
	94	\constfunc{int }{GetDepth}{\void}
	95
	96	Returns the bit depth of the display whose index was passed to the constructor.
	97
	98
	99	\membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
	100
	101	\func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
	102
	103	Returns the index of the display on which the given point lies. Returns
	104	\texttt{wxNOT\_FOUND} if the point is not on any connected display.
	105
	106	\wxheading{Parameters}
	107
	108	\docparam{pt}{The point to locate.}
	109
	110
	111	\membersection{wxDisplay::GetFromWindow}\label{wxdisplaygetfromwindow}
	112
	113	\func{static int}{GetFromWindow}{\param{const wxWindow* }{win}}
	114
	115	Returns the index of the display on which the given window lies.
	116
	117	If the window is on more than one display it gets the display that overlaps the window the most.
	118
	119	Returns \texttt{wxNOT\_FOUND} if the window is not on any connected display.
	120
	121	\wxheading{Parameters}
	122
	123	\docparam{win}{The window to locate.}
	124
	125
	126	\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
	127
	128	\constfunc{wxRect }{GetGeometry}{\void}
	129
	130	Returns the bounding rectangle of the display whose index was passed to the
	131	constructor.
	132
	133	\wxheading{See also:}
	134
	135	\helpref{GetClientArea}{wxdisplaygetclientarea}, \helpref{wxDisplaySize}{wxdisplaysize}
	136
	137
	138	\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
	139
	140	\constfunc{wxArrayVideoModes }{GetModes}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
	141
	142	Fills and returns an array with all the video modes that
	143	are supported by this display, or video modes that are
	144	supported by this display and match the mode parameter
	145	(if mode is not wxDefaultVideoMode).
	146
	147
	148	\membersection{wxDisplay::GetName}\label{wxdisplaygetname}
	149
	150	\constfunc{wxString }{GetName}{\void}
	151
	152	Returns the display's name. A name is not available on all platforms.
	153
	154
	155	\membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
	156
	157	\func{bool }{IsPrimary}{\void}
	158
	159	Returns true if the display is the primary display. The primary display is the
	160	one whose index is 0.
	161