QGIS/python/gui/auto_generated/qgscurveeditorwidget.sip.in

122 lines
3.2 KiB
Plaintext
Raw Normal View History

2017-05-23 14:39:33 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgscurveeditorwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsCurveEditorWidget : QWidget
{
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
A widget for manipulating QgsCurveTransform curves.
2017-05-23 14:39:33 +02:00
.. versionadded:: 3.0
%End
2017-05-23 14:39:33 +02:00
%TypeHeaderCode
#include "qgscurveeditorwidget.h"
%End
public:
QgsCurveEditorWidget( QWidget *parent /TransferThis/ = 0, const QgsCurveTransform &curve = QgsCurveTransform() );
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsCurveEditorWidget.
2017-05-23 14:39:33 +02:00
%End
~QgsCurveEditorWidget();
QgsCurveTransform curve() const;
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns a curve representing the current curve from the widget.
.. seealso:: :py:func:`setCurve`
2017-05-23 14:39:33 +02:00
%End
void setCurve( const QgsCurveTransform &curve );
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the ``curve`` to show in the widget.
.. seealso:: :py:func:`curve`
2017-05-23 14:39:33 +02:00
%End
void setHistogramSource( const QgsVectorLayer *layer, const QString &expression );
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets a ``layer`` and ``expression`` source for values to show in a histogram
behind the curve. The histogram is generated in a background thread to keep
the widget responsive.
.. seealso:: :py:func:`minHistogramValueRange`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`maxHistogramValueRange`
2017-05-23 14:39:33 +02:00
%End
double minHistogramValueRange() const;
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns the minimum expected value for the range of values shown in the histogram.
.. seealso:: :py:func:`maxHistogramValueRange`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`setMinHistogramValueRange`
2017-05-23 14:39:33 +02:00
%End
double maxHistogramValueRange() const;
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns the maximum expected value for the range of values shown in the histogram.
.. seealso:: :py:func:`minHistogramValueRange`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`setMaxHistogramValueRange`
2017-05-23 14:39:33 +02:00
%End
public slots:
2017-05-23 14:39:33 +02:00
void setMinHistogramValueRange( double minValueRange );
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the minimum expected value for the range of values shown in the histogram.
.. seealso:: :py:func:`setMaxHistogramValueRange`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`minHistogramValueRange`
2017-05-23 14:39:33 +02:00
%End
void setMaxHistogramValueRange( double maxValueRange );
2017-05-23 14:39:33 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the maximum expected value for the range of values shown in the histogram.
.. seealso:: :py:func:`setMinHistogramValueRange`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`maxHistogramValueRange`
2017-05-23 14:39:33 +02:00
%End
signals:
void changed();
2017-05-23 14:39:33 +02:00
%Docstring
Emitted when the widget curve changes
%End
protected:
virtual void keyPressEvent( QKeyEvent *event );
};
2017-05-23 14:39:33 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgscurveeditorwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/