qgscolorwidgets.h

Go to the documentation of this file.

/***************************************************************************
    qgscolorwidgets.h - color selection widgets
    ---------------------
    begin                : September 2014
    copyright            : (C) 2014 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 QGSCOLORWIDGETS_H
#define QGSCOLORWIDGETS_H

#include <QWidgetAction>
#include <QWidget>
#include "qgis_gui.h"
#include "qgis.h"

class QColor;
class QSpinBox;
class QLineEdit;
class QToolButton;

class GUI_EXPORT QgsColorWidget : public QWidget
{
    Q_OBJECT

  public:

    enum ColorComponent
    {
      Multiple = 0, 
      Red, 
      Green, 
      Blue, 
      Hue, 
      Saturation, 
      Value, 
      Alpha 
    };

    QgsColorWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, const ColorComponent component = Multiple );

    QColor color() const;

    ColorComponent component() const { return mComponent; }

    int componentValue() const;

    static QPixmap createDragIcon( const QColor &color );

  public slots:

    virtual void setColor( const QColor &color, const bool emitSignals = false );

    virtual void setComponent( const QgsColorWidget::ColorComponent component );

    virtual void setComponentValue( const int value );

  signals:

    void colorChanged( const QColor &color );

    void hovered();

  protected:

    QColor mCurrentColor;

    ColorComponent mComponent;

    int mExplicitHue = 0;

    int componentRange() const;

    int componentRange( const ColorComponent component ) const;

    int componentValue( const ColorComponent component ) const;

    int hue() const;

    void alterColor( QColor &color, const QgsColorWidget::ColorComponent component, const int newValue ) const;

    static const QPixmap &transparentBackground();

    //Reimplemented to accept dragged colors
    void dragEnterEvent( QDragEnterEvent *e ) override;

    //Reimplemented to accept dropped colors
    void dropEvent( QDropEvent *e ) override;

    void mouseMoveEvent( QMouseEvent *e ) override;
    void mousePressEvent( QMouseEvent *e ) override;
    void mouseReleaseEvent( QMouseEvent *e ) override;
};


class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction
{
    Q_OBJECT

  public:

    QgsColorWidgetAction( QgsColorWidget *colorWidget, QMenu *menu = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QgsColorWidget *colorWidget() { return mColorWidget; }

    void setDismissOnColorSelection( bool dismiss ) { mDismissOnColorSelection = dismiss; }

    bool dismissOnColorSelection() const { return mDismissOnColorSelection; }

  signals:

    void colorChanged( const QColor &color );

  private:
    QMenu *mMenu = nullptr;
    QgsColorWidget *mColorWidget = nullptr;

    //used to suppress recursion with hover events
    bool mSuppressRecurse;

    bool mDismissOnColorSelection;

  private slots:

    void onHover();

    void setColor( const QColor &color );
};



class GUI_EXPORT QgsColorWheel : public QgsColorWidget
{
    Q_OBJECT

  public:

    QgsColorWheel( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    ~QgsColorWheel() override;

    QSize sizeHint() const override;
    void paintEvent( QPaintEvent *event ) override;

  public slots:

    void setColor( const QColor &color, const bool emitSignals = false ) override;

  protected:

    void resizeEvent( QResizeEvent *event ) override;
    void mouseMoveEvent( QMouseEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;
    void mouseReleaseEvent( QMouseEvent *event ) override;

  private:

    enum ControlPart
    {
      None,
      Wheel,
      Triangle
    };

    /*Margin between outer ring and edge of widget*/
    int mMargin = 4;

    /*Thickness of hue ring in pixels*/
    int mWheelThickness = 18;

    /*Part of the wheel where the mouse was originally depressed*/
    ControlPart mClickedPart = QgsColorWheel::None;

    /*Cached image of hue wheel*/
    QImage *mWheelImage = nullptr;

    /*Cached image of inner triangle*/
    QImage *mTriangleImage = nullptr;

    /*Resuable, temporary image for drawing widget*/
    QImage *mWidgetImage = nullptr;

    /*Whether the color wheel image requires redrawing*/
    bool mWheelDirty = true;

    /*Whether the inner triangle image requires redrawing*/
    bool mTriangleDirty = true;

    /*Conical gradient brush used for drawing hue wheel*/
    QBrush mWheelBrush;

    void createImages( const QSizeF size );

    void createWheel();

    void createTriangle();

    void setColorFromPos( const QPointF pos );

};


class GUI_EXPORT QgsColorBox : public QgsColorWidget
{
    Q_OBJECT

  public:

    QgsColorBox( QWidget *parent SIP_TRANSFERTHIS = nullptr, const ColorComponent component = Value );

    ~QgsColorBox() override;

    QSize sizeHint() const override;
    void paintEvent( QPaintEvent *event ) override;

    void setComponent( const ColorComponent component ) override;

  public slots:
    void setColor( const QColor &color, const bool emitSignals = false ) override;

  protected:

    void resizeEvent( QResizeEvent *event ) override;
    void mouseMoveEvent( QMouseEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;

  private:

    /*Margin between outer ring and edge of widget*/
    int mMargin = 2;

    /*Cached image for color box*/
    QImage *mBoxImage = nullptr;

    /*Whether the cached image requires redrawing*/
    bool mDirty = true;

    void createBox();

    int valueRangeX() const;

    int valueRangeY() const;

    QgsColorWidget::ColorComponent yComponent() const;

    int yComponentValue() const;

    QgsColorWidget::ColorComponent xComponent() const;

    int xComponentValue() const;

    void setColorFromPoint( QPoint point );

};


class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget
{
    Q_OBJECT

  public:

    enum Orientation
    {
      Horizontal = 0, 
      Vertical 
    };

    QgsColorRampWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr,
                        const ColorComponent component = QgsColorWidget::Red,
                        const Orientation orientation = QgsColorRampWidget::Horizontal );

    QSize sizeHint() const override;
    void paintEvent( QPaintEvent *event ) override;

    void setOrientation( const Orientation orientation );

    Orientation orientation() const { return mOrientation; }

    void setInteriorMargin( const int margin );

    int interiorMargin() const { return mMargin; }

    void setShowFrame( const bool showFrame );

    bool showFrame() const { return mShowFrame; }

    void setMarkerSize( const int markerSize );

  signals:

    void valueChanged( const int value );

  protected:

    void mouseMoveEvent( QMouseEvent *event ) override;
    void wheelEvent( QWheelEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;

  private:

    /*Orientation for ramp*/
    Orientation mOrientation;

    /*Margin around ramp*/
    int mMargin = 4;

    /*Whether to draw a frame around the ramp*/
    bool mShowFrame = false;

    /*Polygon for upper triangle marker*/
    QPolygonF mTopTriangle;

    /*Polygon for lower triangle marker*/
    QPolygonF mBottomTriangle;

    void setColorFromPoint( QPointF point );

};


class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget
{
    Q_OBJECT

  public:

    QgsColorSliderWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, const ColorComponent component = QgsColorWidget::Red );

    void setComponent( const ColorComponent component ) override;
    void setComponentValue( const int value ) override;
    void setColor( const QColor &color, const bool emitSignals = false ) override;

  private:

    /*Color ramp widget*/
    QgsColorRampWidget *mRampWidget = nullptr;

    /*Spin box widget*/
    QSpinBox *mSpinBox = nullptr;

    int convertRealToDisplay( const int realValue ) const;

    int convertDisplayToReal( const int displayValue ) const;

  private slots:

    void rampColorChanged( const QColor &color );

    void spinChanged( int value );

    void rampChanged( int value );

};


class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget
{
    Q_OBJECT

  public:

    enum ColorTextFormat
    {
      HexRgb = 0, 
      HexRgbA, 
      Rgb, 
      Rgba 
    };
    Q_ENUM( ColorTextFormat )

    
    QgsColorTextWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setColor( const QColor &color, const bool emitSignals = false ) override;

  protected:
    void resizeEvent( QResizeEvent *event ) override;

  private:

    QLineEdit *mLineEdit = nullptr;

    /*Drop-down menu button*/
    QToolButton *mMenuButton = nullptr;

    /*Display format for colors*/
    ColorTextFormat mFormat = QgsColorTextWidget::HexRgb;

    void updateText();

  private slots:

    void textChanged();

    void showMenu();
};


class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget
{
    Q_OBJECT

  public:

    QgsColorPreviewWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void paintEvent( QPaintEvent *event ) override;
    QSize sizeHint() const override;

    QColor color2() const { return mColor2; }

  public slots:

    virtual void setColor2( const QColor &color );

  protected:

    //reimplemented to allow dragging colors
    void mousePressEvent( QMouseEvent *e ) override;

    //reimplemented to click colors
    void mouseReleaseEvent( QMouseEvent *e ) override;

    //reimplemented to allow dragging colors
    void mouseMoveEvent( QMouseEvent *e ) override;

  private:

    /*Secondary color for widget*/
    QColor mColor2;

    QPoint mDragStartPosition;

    /*Draws a color preview within the specified rect.
     * \param color color to draw
     * \param rect rect to draw color in
     * \param painter destination painter
     */
    void drawColor( const QColor &color, QRect rect, QPainter &painter );
};

#endif // #ifndef QGSCOLORWIDGETS_H