QGIS/python/gui/symbology/qgscptcitycolorrampdialog.sip.in

82 lines
2.2 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgscptcitycolorrampdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsCptCityColorRampDialog : QDialog
{
%Docstring
A dialog which allows users to modify the properties of a QgsCptCityColorRamp.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgscptcitycolorrampdialog.h"
%End
public:
QgsCptCityColorRampDialog( const QgsCptCityColorRamp &ramp, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsCptCityColorRampDialog.
:param ramp: initial ramp to show in dialog
:param parent: parent widget
%End
QgsCptCityColorRamp ramp() const;
%Docstring
Returns a color ramp representing the current settings from the dialog.
.. seealso:: :py:func:`setRamp`
%End
void setRamp( const QgsCptCityColorRamp &ramp );
%Docstring
Sets the color ramp to show in the dialog.
:param ramp: color ramp
.. seealso:: :py:func:`ramp`
%End
QString selectedName() const;
%Docstring
Returns the name of the ramp currently selected in the dialog.
%End
bool saveAsGradientRamp() const;
%Docstring
Returns true if the ramp should be converted to a :py:class:`QgsGradientColorRamp`.
%End
virtual bool eventFilter( QObject *obj, QEvent *event );
signals:
void changed();
%Docstring
Emitted when the dialog settings change
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgscptcitycolorrampdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/