qgsgradientcolorrampdialog.h

Go to the documentation of this file.

/***************************************************************************
    qgsgradientcolorrampdialog.h
    ----------------------------
    begin                : December 2009
    copyright            : (C) 2009 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSGRADIENTCOLORRAMPDIALOG_H
#define QGSGRADIENTCOLORRAMPDIALOG_H
 
#include "ui_qgsgradientcolorrampdialogbase.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgshelp.h"
 
#include <QDialog>
 
class QgsGradientColorRamp;
class QgsSettingsEntryBool;
class QwtPlot;
class QwtPlotCurve;
class QwtPlotMarker;
class QgsGradientPlotEventFilter;

class GUI_EXPORT QgsGradientColorRampDialog : public QDialog, private Ui::QgsGradientColorRampDialogBase
{
    Q_OBJECT
    Q_PROPERTY( QgsGradientColorRamp ramp READ ramp WRITE setRamp )
 
  public:
    static const QgsSettingsEntryBool *settingsPlotHue SIP_SKIP;
    static const QgsSettingsEntryBool *settingsPlotLightness SIP_SKIP;
    static const QgsSettingsEntryBool *settingsPlotSaturation SIP_SKIP;
    static const QgsSettingsEntryBool *settingsPlotAlpha SIP_SKIP;

    QgsGradientColorRampDialog( const QgsGradientColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsGradientColorRampDialog() override;

    QgsGradientColorRamp ramp() const { return mRamp; }

    void setRamp( const QgsGradientColorRamp &ramp );

    QDialogButtonBox *buttonBox() const;
 
  signals:

    void changed();
 
  public slots:

    void setColor1( const QColor &color );

    void setColor2( const QColor &color );
 
  private slots:
    void cboType_currentIndexChanged( int index );
    void btnInformation_pressed();
    void updateRampFromStopEditor();
    void updateColorButtons();
    void updateStopEditor();
    void selectedStopChanged( const QgsGradientStop &stop );
    void colorWidgetChanged( const QColor &color );
    void mPositionSpinBox_valueChanged( double val );
    void mPlotHueCheckbox_toggled( bool checked );
    void mPlotLightnessCheckbox_toggled( bool checked );
    void mPlotSaturationCheckbox_toggled( bool checked );
    void mPlotAlphaCheckbox_toggled( bool checked );
    void plotMousePress( QPointF point );
    void plotMouseRelease( QPointF point );
    void plotMouseMove( QPointF point );
    void showHelp();
 
  private:
    QgsGradientColorRamp mRamp;
    QwtPlotCurve *mLightnessCurve = nullptr;
    QwtPlotCurve *mSaturationCurve = nullptr;
    QwtPlotCurve *mHueCurve = nullptr;
    QwtPlotCurve *mAlphaCurve = nullptr;
    QList<QwtPlotMarker *> mMarkers;
    QgsGradientPlotEventFilter *mPlotFilter = nullptr;
    int mCurrentPlotColorComponent = -1;
    int mCurrentPlotMarkerIndex = 0;
    int mBlockChanges = 0;
 
    void updatePlot();
    void addPlotMarker( double x, double y, const QColor &color, bool isSelected = false );
    void addMarkersForColor( double x, const QColor &color, bool isSelected = false );
 
    // Returns TRUE if it's possible to edit direction regarding given colorSpec
    static bool hasDirection( QColor::Spec colorSpec );
};
 
 
#ifndef SIP_RUN
//
// NOTE:
// For private only, not part of stable api or exposed to Python bindings
//
class GUI_EXPORT QgsGradientPlotEventFilter : public QObject
{
    Q_OBJECT
 
  public:
    QgsGradientPlotEventFilter( QwtPlot *plot );
 
    bool eventFilter( QObject *object, QEvent *event ) override;
 
  signals:
 
    void mousePress( QPointF );
    void mouseRelease( QPointF );
    void mouseMove( QPointF );
 
  private:
    QwtPlot *mPlot = nullptr;
    QPointF mapPoint( QPointF point ) const;
};
#endif
 
#endif