docs/latex/wx/plotwindow.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % plot.h at 11/Feb/00 18:00:57
   4 %
   5
   6 \section{\class{wxPlotWindow}}\label{wxplotwindow}
   7
   8 wxPlotWindow is a specialized window designed to display data that typically has
   9 been measured by machines, i.e. that may have thousands of values. One example of
  10 such data would be the well known ECG measuring the electrical activity of your
  11 heart: the measuring device will produce thousands of values per minute, several
  12 measurements are done simultanously and you might want to have a look at parts
  13 of the curves, enlarging them or scrolling from one position to another. Note
  14 that this window is not useful for real-time measuring or for displaying charts
  15 with error bars etc.
  16
  17 The wxPlotWindow interacts with program using events, for example when clicking
  18 or double clicking on a curve or when selecting one by clicking on it (which
  19 can be vetoed). Future versions will hopefully feature selecting values or
  20 sections of the displayed curves etc.
  21
  22 \wxheading{Derived from}
  23
  24 \helpref{wxScrolledWindow}{wxscrolledwindow}\\
  25 \helpref{wxPanel}{wxpanel}\\
  26 \helpref{wxWindow}{wxwindow}\\
  27 \helpref{wxEvtHandler}{wxevthandler}\\
  28 \helpref{wxObject}{wxobject}
  29
  30 \wxheading{Window styles}
  31
  32 \begin{twocollist}\itemsep=0pt
  33 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_MOVE}}{Display buttons to allao moving individual curves up or down.}
  34 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ENLARGE}}{Display buttons to allow enlarging individual curves vertically.}
  35 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ZOOM}}{Display all buttons.}
  36 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ZOOM}}{Display buttons to allow zooming all curves horizontally.}
  37 \twocolitem{\windowstyle{wxPLOT\_Y\_AXIS}}{Display an Y axis to the left of the drawing area.}
  38 \twocolitem{\windowstyle{wxPLOT\_X\_AXIS}}{Display a X axis at the bottom of the drawing area.}
  39 \twocolitem{\windowstyle{wxPLOT\_DEFAULT}}{All of the above options.}
  40 \end{twocollist}
  41
  42 \latexignore{\rtfignore{\wxheading{Members}}}
  43
  44 \membersection{wxPlotWindow::wxPlotWindow}\label{wxplotwindowwxplotwindow}
  45
  46 \func{}{wxPlotWindow}{\void}
  47
  48 \func{}{wxPlotWindow}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size}, \param{int }{flags = wxPLOT\_DEFAULT}}
  49
  50 Constructor.
  51
  52 \membersection{wxPlotWindow::\destruct{wxPlotWindow}}\label{wxplotwindowdtor}
  53
  54 \func{}{\destruct{wxPlotWindow}}{\void}
  55
  56 The destructor will not delete the curves associated to the window.
  57
  58 \membersection{wxPlotWindow::Add}\label{wxplotwindowadd}
  59
  60 \func{void}{Add}{\param{wxPlotCurve* }{curve}}
  61
  62 Add a curve to the window.
  63
  64 \membersection{wxPlotWindow::GetCount}\label{wxplotwindowgetcount}
  65
  66 \func{size\_t}{GetCount}{\void}
  67
  68 Returns number of curves.
  69
  70 \membersection{wxPlotWindow::GetAt}\label{wxplotwindowgetat}
  71
  72 \func{wxPlotCurve*}{GetAt}{\param{size\_t }{n}}
  73
  74 Get the nth curve.
  75
  76 \membersection{wxPlotWindow::SetCurrent}\label{wxplotwindowsetcurrent}
  77
  78 \func{void}{SetCurrent}{\param{wxPlotCurve* }{current}}
  79
  80 Make one curve the current curve. This will emit a wxPlotEvent.
  81
  82 \membersection{wxPlotWindow::GetCurrent}\label{wxplotwindowgetcurrent}
  83
  84 \func{wxPlotCurve*}{GetCurrent}{\void}
  85
  86 Returns a pointer to the current curve, or NULL.
  87
  88 \membersection{wxPlotWindow::Delete}\label{wxplotwindowdelete}
  89
  90 \func{void}{Delete}{\param{wxPlotCurve* }{curve}}
  91
  92 Removes a curve from the window and delete is on screen. This does not
  93 delete the actual curve. If the curve removed was the current curve,
  94 the current curve will be set to NULL.
  95
  96 \membersection{wxPlotWindow::Move}\label{wxplotwindowmove}
  97
  98 \func{void}{Move}{\param{wxPlotCurve* }{curve}, \param{int }{pixels\_up}}
  99
 100 Move the curve {\tt curve} up by {\tt pixels\_up} pixels. Down if the
 101 value is negative.
 102
 103 \membersection{wxPlotWindow::Enlarge}\label{wxplotwindowenlarge}
 104
 105 \func{void}{Enlarge}{\param{wxPlotCurve* }{curve}, \param{double }{factor}}
 106
 107 Changes the representation of the given curve. A {\tt factor} of more than
 108 one will stretch the curve vertically. The Y axis will change accordingly.
 109
 110 \membersection{wxPlotWindow::SetUnitsPerValue}\label{wxplotwindowsetunitspervalue}
 111
 112 \func{void}{SetUnitsPerValue}{\param{double }{upv}}
 113
 114 This sets the virtual untis per value. Normally, you will not be interested in
 115 what measured value you see, but what it stands for. If you want to display seconds
 116 on the X axis and the measuring device produced 50 values per second, set this
 117 value to 50. This will affect all curves being displayed.
 118
 119 \membersection{wxPlotWindow::GetUnitsPerValue}\label{wxplotwindowgetunitspervalue}
 120
 121 \func{double}{GetUnitsPerValue}{\void}
 122
 123 See \helpref{SetUnitsPerValue}{wxplotwindowsetunitspervalue}.
 124
 125 \membersection{wxPlotWindow::SetZoom}\label{wxplotwindowsetzoom}
 126
 127 \func{void}{SetZoom}{\param{double }{zoom}}
 128
 129 This functions zooms all curves in their horizontal dimension. The X axis will
 130 be changed accordingly.
 131
 132 \membersection{wxPlotWindow::GetZoom}\label{wxplotwindowgetzoom}
 133
 134 \func{double}{GetZoom}{\void}
 135
 136 See \helpref{SetZoom}{wxplotwindowsetzoom}.
 137
 138 \membersection{wxPlotWindow::RedrawEverything}\label{wxplotwindowredraweverything}
 139
 140 \func{void}{RedrawEverything}{\void}
 141
 142 Helper function which redraws both axes and the central area.
 143
 144 \membersection{wxPlotWindow::RedrawXAxis}\label{wxplotwindowredrawxaxis}
 145
 146 \func{void}{RedrawXAxis}{\void}
 147
 148 Helper function which redraws the X axis.
 149
 150 \membersection{wxPlotWindow::RedrawYAxis}\label{wxplotwindowredrawyaxis}
 151
 152 \func{void}{RedrawYAxis}{\void}
 153
 154 Helper function which redraws the Y axis.
 155