added SetAxisOrientation documentation and improved documentation of logical

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

diff --git a/docs/latex/wx/plotwindow.tex b/docs/latex/wx/plotwindow.tex
index cb37e22179084471eff50d3de528a95cbcde2ac7..8a2e7bc2275264c3dbd386de88060b20c6c55cd4 100644 (file)
--- a/docs/latex/wx/plotwindow.tex
+++ b/docs/latex/wx/plotwindow.tex
@@ -14,6 +14,9 @@ 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.
 
 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
 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


@@ -32,8 +35,8 @@ sections of the displayed curves etc.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_MOVE}}{Display buttons to allao moving individual curves up or down.}
 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ENLARGE}}{Display buttons to allow enlarging individual curves vertically.}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxPLOT\_BUTTON\_MOVE}}{Display buttons to allao 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\_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.}
 \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.}


@@ -153,3 +156,21 @@ Helper function which redraws the X axis.
 
 Helper function which redraws the Y 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.
+