qgsgradientstopeditor.h

Go to the documentation of this file.

/***************************************************************************
    qgsgradientstopeditor.h
    -----------------------
    begin                : April 2016
    copyright            : (C) 2016 by Nyall Dawson
    email                : nyall dot dawson 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 QGSGRADIENTSTOPEDITOR_H
#define QGSGRADIENTSTOPEDITOR_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscolorrampimpl.h"
 
#include <QWidget>

 
class GUI_EXPORT QgsGradientStopEditor : public QWidget
{
    Q_OBJECT
 
  public:
    QgsGradientStopEditor( QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsGradientColorRamp *ramp = nullptr );

    void setGradientRamp( const QgsGradientColorRamp &ramp );

    QgsGradientColorRamp gradientRamp() const { return mGradient; }

    void selectStop( int index );

    QgsGradientStop selectedStop() const;
 
    QSize sizeHint() const override;
    void paintEvent( QPaintEvent *event ) override;
 
  public slots:

    void setSelectedStopColor( const QColor &color );

    void setSelectedStopOffset( double offset );

    void setSelectedStopColorSpec( QColor::Spec spec );

    void setSelectedStopDirection( Qgis::AngularDirection direction );

    void setSelectedStopDetails( const QColor &color, double offset );

    void deleteSelectedStop();

    void setColor1( const QColor &color );

    void setColor2( const QColor &color );
 
  signals:

    void changed();

    void selectedStopChanged( const QgsGradientStop &stop );
 
  protected:
    void mouseMoveEvent( QMouseEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;
    void mouseDoubleClickEvent( QMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;
 
    //Reimplemented to accept dragged colors
    void dragEnterEvent( QDragEnterEvent *e ) override;
 
    //Reimplemented to accept dropped colors
    void dropEvent( QDropEvent *e ) override;
 
  private:
    QPixmap transparentBackground();

    void drawStopMarker( QPainter &painter, QPoint topMiddle, const QColor &color, bool selected = false );

    double pointToRelativePosition( int x ) const;

    int relativePositionToPoint( double position ) const;

    bool selectedStopIsMovable() const;

    int findClosestStop( int x, int threshold = -1 ) const;
 
    QgsGradientColorRamp mGradient;

    QgsGradientStopsList mStops;

    int mSelectedStop = 0;

    QPolygonF sOuterTriangle;

    QPolygonF sInnerTriangle;
 
    static constexpr int FRAME_MARGIN_PX = 2;
    static constexpr int MARKER_WIDTH = 11;
    static constexpr int MARKER_HEIGHT = 14;
    static constexpr double MARKER_GAP = 1.5;
    static constexpr int MARGIN_BOTTOM = MARKER_HEIGHT + 2;
    static constexpr int MARGIN_X = MARKER_WIDTH / 2;
    static constexpr int CLICK_THRESHOLD = MARKER_WIDTH / 2 + 3;
};
 
#endif // QGSGRADIENTSTOPEDITOR_H