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 \membersection{wxDisplay::wxDisplay}\label{wxdisplayconstr}
  20
  21 \func{}{wxDisplay}{\param{size\_t }{index = 0}}
  22
  23 Constructor, setting up a wxDisplay instance with the specified display.
  24
  25 \wxheading{Parameters}
  26
  27 \docparam{index}{The index of the display to use.  This must be non-negative
  28 and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount},
  29 inclusive.}
  30
  31 \membersection{wxDisplay::\destruct{wxDisplay}}
  32
  33 \func{void}{\destruct{wxDisplay}}{\void}
  34
  35 Destructor.
  36
  37 \membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
  38
  39 \func{static size\_t}{GetCount}{\void}
  40
  41 Returns the number of connected displays.
  42
  43 \membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
  44
  45 \constfunc{int }{GetDepth}{\void}
  46
  47 Returns the bit depth of the display whose index was passed to the constructor.
  48
  49 \membersection{wxDisplay::GetFromPoint}\label{wxdisplaygetfrompoint}
  50
  51 \func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
  52
  53 Returns the index of the display on which the given point lies.  Returns -1 if
  54 the point is not on any connected display.
  55
  56 \wxheading{Parameters}
  57
  58 \docparam{pt}{The point to locate.}
  59
  60 \membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
  61
  62 \constfunc{wxRect }{GetGeometry}{\void}
  63
  64 Returns the bounding rectangle of the display whose index was passed to the
  65 constructor.
  66
  67 \membersection{wxDisplay::GetName}\label{wxdisplaygetname}
  68
  69 \constfunc{wxString }{GetName}{\void}
  70
  71 Returns the display's name.  A name is not available on all platforms.
  72
  73 \membersection{wxDisplay::IsColour}\label{wxdisplayiscolour}
  74
  75 \constfunc{bool }{IsColour}{\void}
  76
  77 Returns true if the display is color (has a depth greater than 1).
  78
  79 \membersection{wxDisplay::IsColor}\label{wxdisplayiscolor}
  80
  81 \constfunc{bool }{IsColor}{\void}
  82
  83 Same as \helpref{IsColour()}{wxdisplayiscolour}.
  84
  85 \membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
  86
  87 \func{bool }{IsPrimary}{\void}
  88
  89 Returns true if the display is the primary display.  The primary display is the
  90 one whose index is 0.
  91