3. PyQwt Module Reference

The reference should be used in conjunction with the Qwt manual on your hard disk or Qwt on the web. Only the differences specific to the Python bindings are documented here.

In this chapter, is not yet implemented implies that the feature can be easily implemented if needed, is not implemented implies that the feature is not easily implemented, and is not Pythonic implies that the feature will not be implemented because it violates the Python philosophy (e.g. may use dangling pointers).

If a class is described as being fully implemented then all non-private member functions and all public class variables have been implemented.

Undocumented classes have not yet been implemented or are still experimental.

The classes in the Qwt library have quite a few protected attributes. They are not yet available in Python (as far as I know, sip wraps protected member function, but not protected attributes). I may try to implement protected attributes on demand.

class Qwt( *args): is fully implemented.

class QwtAnalogClock( *args): is fully implemented.

class QwtArrowButton( *args): is fully implemented.

class QwtAutoScale( *args)

adjust. C++ declaration:

void adjust(double minVal, double maxVal, int reset = 0);
void adjust(double* x, int size, int reset = 0);

Python usage:

autoScale.adjust(minVal, maxVal, reset = 0)
autoScale.adjust(x, reset = 0)

The first form takes two floats and a boolean. The second form takes a list, tuple or NumPy array of floats and a boolean.

class QwtCompass( *args): is fully implemented.

class QwtCompassMagnetNeedle( *args): is fully implemented.

class QwtCompassRose( *args): is fully implemented.

class QwtCompassWindArrow( *args): is fully implemented.

class QwtCounter( *args): is fully implemented.

class QwtCurve( *args)

setData. C++ declaration:
```
void setData(double* x, double* y, int size)
```
Python usage:
```
curve.setData(x, y)
```
x and y can be any combination of lists, tuples and Numeric arrays of floats. All sequences are internally truncated to the length of the shortest sequence.

setRawData. C++ declaration:

      void setRawData(double* x, double* y, int size)

setRawData is not Pythonic.

verifyRange. C++ declaration:

      int verifyRange(int& i1, int& i2);

Python usage:

      length, first, last = curve.verifyRange(i1, i2)

class QwtCurveDict( *args): FIXME.

class QwtData( *args): is not implemented, because of the virtual copy destructor.

class QwtDblRange( *args): is fully implemented.

class QwtDiMap( *args): is fully implemented.

class QwtDial( *args): is fully implemented.

class QwtDialNeedle( *args): is fully implemented.

class QwtDialScaleDraw( *args): is fully implemented.

class QwtDialSimpleNeedle( *args): is fully implemented.

class QwtDoublePoint( *args): is fully implemented.

class QwtDoublePointData( *args): is fully implemented.

class QwtDoubleRect( *args): is fully implemented.

class QwtDoubleSize( *args): is fully implemented.

class QwtDynGridLayout( *args): is fully implemented.

class QwtEventPattern( *args): is fully implemented.

class QwtGrid( *args): is fully implemented.

class QwtKnob( *args): is fully implemented. See QwtSliderBase.

class QwtLayoutMetrics( *args): is fully implemented.

class QwtLegend( *args): is fully implemented.

class QwtLegendButton( *args): is fully implemented.

class QwtLegendItem( *args): is fully implemented.

class QwtLegendLabel( *args): is fully implemented.

class QwtMarker( *args): is fully implemented.

class QwtPlotPicker( *args): is fully implemented.

class QwtMarkerDict( *args): FIXME.

class QwtMetricsMap( *args): is fully implemented.

class QwtPaintBuffer( *args): is fully implemented.

class QwtPainter( *args): is fully implemented.

class QwtPicker( *args): is fully implemented.

class QwtPickerClickPointMachine( *args): is fully implemented.

class QwtPickerClickRectMachine( *args): is fully implemented.

class QwtPickerDragPointMachine( *args): is fully implemented.

class QwtPickerDragRectMachine( *args): is fully implemented.

class QwtPickerPolygonMachine( *args): is fully implemented.

class QwtPlainText( *args): is fully implemented.

class QwtPlot( *args)

print. C++ declaration:

void print(QPrinter &, const QwtPlotPrintFilter &);
void print(QPainter *, const QRect &, const QwtPlotPrintFilter &);

print has been renamed to printPlot in Python.

curveKeys. C++ declaration:
```
QArray<long> curveKeys() const;
```
curveKeys returns a list containing the keys of all curves.

closestCurve. C++ declaration:

long closestCurve(int xPos, int yPos, int& distance) const;
long closestCurve(int xPos, int yPos, int& distance,
                  double& xVal, double& yVal, int& index) const;

Python usage:

key, distance, xVal, yVal, index = plot.closestCurve(xPos, yPos)

setCurveData. C++ declaration:
```
bool setCurveData(long key, double *x, double *y, int size);
```
Python usage:
```
plot.setCurveData(key, x, y)
```
key is an index to the curve and x and y are any combination of lists, tuples or NumPy arrays of Python floats. All sequences are internally truncated to the length of the shortest sequence.

setCurveRawData. C++ declaration:

bool setCurveRawData(long key, double* x, double* y, int size);

setCurveRawData is not Pythonic.

axisMargins. C++ declaration:

bool axisMargins(int axis, double& lowMargin, double& highMargin) const;

Python usage:

valid, lowMargin, highMargin = plot.axisMargins(axis)

If the axis is valid, valid=1. If the axis is invalid, valid=0.

axisLabelFormat. C++ declaration:

void axisLabelFormat(int axis, char& format, int& precision, int& width) const;

Python usage:

format, precision, width = plot.axisLabelFormat(axis)

closestMarker. C++ declaration:
```
long closestMarker(int xPos, int yPos, int& distance) const;
```
Python usage:
```
key, distance = plot.closestMarker(xPos, yPos)
```
closestMarker takes the x- and y-coordinates of a point and returns a tuple containing the key of the closest marker and the distance between the closest marker and the point.
markerKeys. C++ declaration:
```
QArray<long> markerKeys() const;
```
markerKeys returns a list containing the keys of all markers.
markerPos. C++ declaration:
```
void markerPos(long key, double& x, double& y) const;
```
Python usage:
```
x, y = plot.markerPos(key)
```
markerPos takes the key of a marker and returns a tuple containing the x- and y-coordinates.

class QwtPlotCanvas( *args): is fully implemented.

class QwtPlotCurve( *args): is fully implemented.

class QwtPlotGrid( *args): is fully implemented.

class QwtPlotItem( *args): is fully implemented.

class QwtPlotLayout( *args): is fully implemented.

class QwtPlotMappedItem( *args): is fully implemented.

class QwtPlotMarker( *args): is fully implemented.

class QwtPlotPrintFilter( *args): is fully implemented.

class QwtPlotZoomer( *args): is fully implemented.

class QwtPushButton( *args): is fully implemented.

class QwtRect( *args): is fully implemented.

class QwtRichText( *args): is fully implemented.

class QwtScale( *args)

labelFormat. C++ declaration:

void labelFormat(char& format, int& precision, int& width) const;

Python usage:

format, precision, width = scale.labelFormat()

minBorderDist. C++ declaration:

void minBorderDist(int& start, int& end) const;

Python usage:

start, end = scale.minBorderDist()

class QwtScaleDiv( *args): is fully implemented.

class QwtScaleDraw( *args): is fully implemented.

class QwtScaleIf( *args): is fully implemented.

class QwtSimpleCompassRose( *args): is fully implemented.

class QwtSlider( *args): is fully implemented. See QwtSliderBase.

class QwtSliderBase( *args)

is fully implemented.

getScrollMode. C++ declaration:

virtual void getScrollMode(const QPoint& point, int& mode, int& direction) = 0;

Python usage:

mode, direction = sliderBase.getScrollMode(point)

See QwtKnob, QwtSlider and QwtWheel.

class QwtSpline( *args)

recalc. C++ declaration:
```
int recalc(double* x, double* y, int n, bool periodic = 0);
```
Python usage:
```
errorCode = spline.recalc(x, y, periodic)
```
x and y are a sequence of floats and periodic is a boolean. The sequences can be a list, a tuple or a NumPy array and all sequences are internally truncated to the length of the shortest sequence.
copyValues. C++ declaration:
```
void copyValues(int enable = 1);
```
copyValues is not Pythonic.

class QwtSymbol( *args): is fully implemented.

class QwtText( *args): is fully implemented.

class QwtThermo( *args): is fully implemented.

class QwtWheel( *args): is fully implemented. See QwtSliderBase.

$\begin{center}\vbox{\input{pyqwt.ind} }\end{center}$