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{wxdisplayctor}
	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}}\label{wxdisplaydtor}
	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::GetClientArea}\label{wxdisplaygetclientarea}
	61
	62	\constfunc{wxRect }{GetClientArea}{\void}
	63
	64	Returns the client area of the display. The client area is the part of the
	65	display available for the normal (non full screen) windows, usually it is the
	66	same as \helpref{GetGeometry}{wxdisplaygetgeometry} but it could be less if
	67	there is a taskbar (or equivalent) on this display.
	68
	69	\wxheading{See also:}
	70
	71	\helpref{wxClientDisplayRect}{wxclientdisplayrect}
	72
	73
	74	\membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
	75
	76	\func{static size\_t}{GetCount}{\void}
	77
	78	Returns the number of connected displays.
	79
	80
	81	\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
	82
	83	\constfunc{wxVideoMode }{GetCurrentMode}{\void}
	84
	85	Returns the current video mode that this display is in.
	86
	87
	88	\membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
	89
	90	\constfunc{int }{GetDepth}{\void}
	91
	92	Returns the bit depth of the display whose index was passed to the constructor.
	93
	94
	95	\membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
	96
	97	\func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
	98
	99	Returns the index of the display on which the given point lies. Returns
	100	\texttt{wxNOT\_FOUND} if the point is not on any connected display.
	101
	102	\wxheading{Parameters}
	103
	104	\docparam{pt}{The point to locate.}
	105
	106
	107	\membersection{wxDisplay::GetFromWindow}\label{wxdisplaygetfromwindow}
	108
	109	\func{static int}{GetFromWindow}{\param{wxWindow* }{win}}
	110
	111	Returns the index of the display on which the given window lies.
	112
	113	If the window is on more than one display it gets the display that overlaps the window the most.
	114
	115	Returns \texttt{wxNOT\_FOUND} if the window is not on any connected display.
	116
	117	\wxheading{Parameters}
	118
	119	\docparam{win}{The window to locate.}
	120
	121
	122	\membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
	123
	124	\constfunc{wxRect }{GetGeometry}{\void}
	125
	126	Returns the bounding rectangle of the display whose index was passed to the
	127	constructor.
	128
	129	\wxheading{See also:}
	130
	131	\helpref{GetClientArea}{wxdisplaygetclientarea}, \helpref{wxDisplaySize}{wxdisplaysize}
	132
	133
	134	\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
	135
	136	\constfunc{wxArrayVideoModes }{GetModes}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
	137
	138	Fills and returns an array with all the video modes that
	139	are supported by this display, or video modes that are
	140	supported by this display and match the mode parameter
	141	(if mode is not wxDefaultVideoMode).
	142
	143
	144	\membersection{wxDisplay::GetName}\label{wxdisplaygetname}
	145
	146	\constfunc{wxString }{GetName}{\void}
	147
	148	Returns the display's name. A name is not available on all platforms.
	149
	150
	151	\membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
	152
	153	\func{bool }{IsPrimary}{\void}
	154
	155	Returns true if the display is the primary display. The primary display is the
	156	one whose index is 0.
	157