clarified the parameters of MB2WC and WC2MB a little in the docs/headers

[wxWidgets.git] / docs / latex / wx / plotwindow.tex

diff --git a/docs/latex/wx/plotwindow.tex b/docs/latex/wx/plotwindow.tex
index cc5fb807847c469db619f413d0b0564bd933a392..c17b876bdb32ead356bbcbc7f3cb90335f572788 100644 (file)
--- a/docs/latex/wx/plotwindow.tex
+++ b/docs/latex/wx/plotwindow.tex
@@ -9,11 +9,14 @@ wxPlotWindow is a specialized window designed to display data that typically has
 been measured by machines, i.e. that may have thousands of values. One example of
 such data would be the well known ECG measuring the electrical activity of your
 heart: the measuring device will produce thousands of values per minute, several
-measurements are done simultanously and you might want to have a look at parts
+measurements are done simultaneously and you might want to have a look at parts
 of the curves, enlarging them or scrolling from one position to another. Note
 that this window is not useful for real-time measuring or for displaying charts
 with error bars etc.
 
+A single curve in the plot window is represented by the \helpref{wxPlotCurve}{wxplotcurve} 
+class.
+
 The wxPlotWindow interacts with program using events, for example when clicking
 or double clicking on a curve or when selecting one by clicking on it (which
 can be vetoed). Future versions will hopefully feature selecting values or
@@ -30,10 +33,10 @@ sections of the displayed curves etc.
 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxPLOT\_BUTTON\_MOVE}}{Display buttons to allao moving individual curves up or down.}
+\twocolitem{\windowstyle{wxPLOT\_BUTTON\_MOVE}}{Display buttons to allow moving individual curves up or down.}
 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ENLARGE}}{Display buttons to allow enlarging individual curves vertically.}
-\twocolitem{\windowstyle{wxPLOT\_BUTTON\_ZOOM}}{Display all buttons.}
 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ZOOM}}{Display buttons to allow zooming all curves horizontally.}
+\twocolitem{\windowstyle{wxPLOT\_BUTTON\_ALL}}{Display all buttons.}
 \twocolitem{\windowstyle{wxPLOT\_Y\_AXIS}}{Display an Y axis to the left of the drawing area.}
 \twocolitem{\windowstyle{wxPLOT\_X\_AXIS}}{Display a X axis at the bottom of the drawing area.}
 \twocolitem{\windowstyle{wxPLOT\_DEFAULT}}{All of the above options.}
@@ -45,9 +48,6 @@ sections of the displayed curves etc.
 
 \func{}{wxPlotWindow}{\void}
 
-
-\membersection{wxPlotWindow::wxPlotWindow}\label{wxplotwindowwxplotwindow}
-
 \func{}{wxPlotWindow}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size}, \param{int }{flags = wxPLOT\_DEFAULT}}
 
 Constructor.
@@ -76,15 +76,15 @@ Returns number of curves.
 
 Get the nth curve.
 
-\membersection{wxPlotWindow::SetCurrent}\label{wxplotwindowsetcurrent}
+\membersection{wxPlotWindow::SetCurrentCurve}\label{wxplotwindowsetcurrentcurve}
 
-\func{void}{SetCurrent}{\param{wxPlotCurve* }{current}}
+\func{void}{SetCurrentCurve}{\param{wxPlotCurve* }{current}}
 
 Make one curve the current curve. This will emit a wxPlotEvent.
 
-\membersection{wxPlotWindow::GetCurrent}\label{wxplotwindowgetcurrent}
+\membersection{wxPlotWindow::GetCurrentCurve}\label{wxplotwindowgetcurrentcurve}
 
-\func{wxPlotCurve*}{GetCurrent}{\void}
+\func{wxPlotCurve*}{GetCurrentCurve}{\void}
 
 Returns a pointer to the current curve, or NULL.
 
@@ -114,7 +114,7 @@ one will stretch the curve vertically. The Y axis will change accordingly.
 
 \func{void}{SetUnitsPerValue}{\param{double }{upv}}
 
-This sets the virtual untis per value. Normally, you will not be interested in
+This sets the virtual units per value. Normally, you will not be interested in
 what measured value you see, but what it stands for. If you want to display seconds
 on the X axis and the measuring device produced 50 values per second, set this
 value to 50. This will affect all curves being displayed.
@@ -156,3 +156,21 @@ Helper function which redraws the X axis.
 
 Helper function which redraws the Y axis.
 
+\membersection{wxPlotWindow::SetScrollOnThumbRelease}\label{wxplotwindowsetscrollonthumbrelease}
+
+\func{void}{SetScrollOnThumbRelease}{\param{bool}{ onrelease = true}}
+
+This function controls if the plot area will get scrolled only if the scrollbar thumb
+has been release or also if the thumb is being dragged. When displaying large amounts
+of data, it might become impossible to display the data fast enough to produce smooth
+scrolling and then this function should be called.
+
+\membersection{wxPlotWindow::SetEnlargeAroundWindowCentre}\label{wxplotwindowsetenlargearoundwindowcentre}
+
+\func{void}{SetEnlargeAroundWindowCentre}{\param{bool}{ aroundwindow = true}}
+
+Depending on the kind of data you display, enlarging the individual curves might
+have different desired effects. Sometimes, the data will be supposed to get enlarged
+with the fixed point being the origin, sometimes the fixed point should be the centre
+of the current drawing area. This function controls this behaviour.
+