X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3d3428c4e6c415cb31824f9d6087d8de8e51cabc..5b5035ce5b432a4535a830debcb8ed26b7e1ec7b:/docs/latex/wx/plotwindow.tex diff --git a/docs/latex/wx/plotwindow.tex b/docs/latex/wx/plotwindow.tex index 9b49449087..c17b876bdb 100644 --- a/docs/latex/wx/plotwindow.tex +++ b/docs/latex/wx/plotwindow.tex @@ -9,12 +9,12 @@ 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} +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 @@ -33,7 +33,7 @@ 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 buttons to allow zooming all curves horizontally.} \twocolitem{\windowstyle{wxPLOT\_BUTTON\_ALL}}{Display all buttons.} @@ -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. @@ -158,7 +158,7 @@ Helper function which redraws the Y axis. \membersection{wxPlotWindow::SetScrollOnThumbRelease}\label{wxplotwindowsetscrollonthumbrelease} -\func{void}{SetScrollOnThumbRelease}{\param{bool}{ onrelease = TRUE}} +\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 @@ -167,7 +167,7 @@ scrolling and then this function should be called. \membersection{wxPlotWindow::SetEnlargeAroundWindowCentre}\label{wxplotwindowsetenlargearoundwindowcentre} -\func{void}{SetEnlargeAroundWindowCentre}{\param{bool}{ aroundwindow = TRUE}} +\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