docs/latex/wx/display.tex

   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::GetCount}\label{wxdisplaygetcount}
  40
  41 \func{static size\_t}{GetCount}{\void}
  42
  43 Returns the number of connected displays.
  44
  45
  46 \membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
  47
  48 \constfunc{int }{GetDepth}{\void}
  49
  50 Returns the bit depth of the display whose index was passed to the constructor.
  51
  52
  53 \membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
  54
  55 \func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
  56
  57 Returns the index of the display on which the given point lies.  Returns -1 if
  58 the point is not on any connected display.
  59
  60 \wxheading{Parameters}
  61
  62 \docparam{pt}{The point to locate.}
  63
  64
  65 \membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
  66
  67 \constfunc{wxRect }{GetGeometry}{\void}
  68
  69 Returns the bounding rectangle of the display whose index was passed to the
  70 constructor.
  71
  72
  73 \membersection{wxDisplay::GetName}\label{wxdisplaygetname}
  74
  75 \constfunc{wxString }{GetName}{\void}
  76
  77 Returns the display's name.  A name is not available on all platforms.
  78
  79
  80 \membersection{wxDisplay::IsColour}\label{wxdisplayiscolour}
  81
  82 \constfunc{bool }{IsColour}{\void}
  83
  84 Returns true if the display is color (has a depth greater than 1).
  85
  86
  87 \membersection{wxDisplay::IsColor}\label{wxdisplayiscolor}
  88
  89 \constfunc{bool }{IsColor}{\void}
  90
  91 Same as \helpref{IsColour()}{wxdisplayiscolour}.
  92
  93
  94 \membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
  95
  96 \func{bool }{IsPrimary}{\void}
  97
  98 Returns true if the display is the primary display.  The primary display is the
  99 one whose index is 0.
 100