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{See also}
	14
	15	\helpref{wxClientDisplayRect}{wxclientdisplayrect}, \helpref{wxDisplaySize}{wxdisplaysize}, \helpref{wxDisplaySizeMM}{wxdisplaysizemm}
	16
	17	\latexignore{\rtfignore{\wxheading{Members}}}
	18
	19
	20	\membersection{wxDisplay::wxDisplay}\label{wxdisplayconstr}
	21
	22	\func{}{wxDisplay}{\param{size\_t }{index = 0}}
	23
	24	Constructor, setting up a wxDisplay instance with the specified display.
	25
	26	\wxheading{Parameters}
	27
	28	\docparam{index}{The index of the display to use. This must be non-negative
	29	and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
	30
	31
	32	\membersection{wxDisplay::\destruct{wxDisplay}}
	33
	34	\func{void}{\destruct{wxDisplay}}{\void}
	35
	36	Destructor.
	37
	38
	39	\membersection{wxDisplay::ChangeMode}\label{wxdisplaychangemode}
	40
	41	\func{bool }{ChangeMode}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
	42
	43	Changes the video mode of this display to the mode specified
	44	in the mode parameter.
	45
	46	If wxDefaultVideoMode is passed in as the mode parameter,
	47	the defined behaviour is that wxDisplay will reset the video
	48	mode to the default mode used by the display. On Windows,
	49	the behavior is normal. However, there are differences on other
	50	platforms. On Unix variations using X11 extensions it should
	51	behave as defined, but some irregularities may occur.
	52
	53	On wxMac passing in wxDefaultVideoMode as the mode
	54	parameter does nothing. This happens because carbon
	55	no longer has access to DMUseScreenPrefs, an undocumented
	56	function that changed the video mode to the system
	57	default by using the system's 'scrn' resource.
	58
	59
	60	\membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
	61
	62	\func{static size\_t}{GetCount}{\void}
	63
	64	Returns the number of connected displays.
	65
	66
	67	\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
	68
	69	\constfunc{wxVideoMode }{GetCurrentMode}{\void}
	70
	71	Returns the current video mode that this display is in.
	72
	73
	74	\membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
	75
	76	\constfunc{int }{GetDepth}{\void}
	77
	78	Returns the bit depth of the display whose index was passed to the constructor.
	79
	80
	81	\membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
	82
	83	\func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
	84
	85	Returns the index of the display on which the given point lies. Returns -1 if
	86	the point is not on any connected display.
	87
	88	\wxheading{Parameters}
	89
	90	\docparam{pt}{The point to locate.}
	91
	92
	93	\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
	94
	95	\constfunc{wxRect }{GetGeometry}{\void}
	96
	97	Returns the bounding rectangle of the display whose index was passed to the
	98	constructor.
	99
	100
	101	\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
	102
	103	\constfunc{wxArrayVideoModes }{GetModes}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
	104
	105	Fills and returns an array with all the video modes that
	106	are supported by this display, or video modes that are
	107	supported by this display and match the mode parameter
	108	(if mode is not wxDefaultVideoMode).
	109
	110
	111	\membersection{wxDisplay::GetName}\label{wxdisplaygetname}
	112
	113	\constfunc{wxString }{GetName}{\void}
	114
	115	Returns the display's name. A name is not available on all platforms.
	116
	117
	118	\membersection{wxDisplay::IsColour}\label{wxdisplayiscolour}
	119
	120	\constfunc{bool }{IsColour}{\void}
	121
	122	Returns true if the display is color (has a depth greater than 1).
	123
	124
	125	\membersection{wxDisplay::IsColor}\label{wxdisplayiscolor}
	126
	127	\constfunc{bool }{IsColor}{\void}
	128
	129	Same as \helpref{IsColour()}{wxdisplayiscolour}.
	130
	131
	132	\membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
	133
	134	\func{bool }{IsPrimary}{\void}
	135
	136	Returns true if the display is the primary display. The primary display is the
	137	one whose index is 0.
	138