qgscolorswatchgrid.h

Go to the documentation of this file.

/***************************************************************************
    qgscolorswatchgrid.h
    ------------------
    Date                 : July 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 QGSCOLORSWATCHGRID_H
#define QGSCOLORSWATCHGRID_H

#include "qgscolorscheme.h"
#include <QWidget>
#include <QWidgetAction>
#include "qgis_gui.h"
#include "qgis_sip.h"

class GUI_EXPORT QgsColorSwatchGrid : public QWidget
{
    Q_OBJECT

  public:

    QgsColorSwatchGrid( QgsColorScheme *scheme, const QString &context = QString(), QWidget *parent SIP_TRANSFERTHIS = nullptr );

    //Reimplemented to set fixed size on widget
    QSize minimumSizeHint() const override;

    //Reimplemented to set fixed size on widget
    QSize sizeHint() const override;

    QString context() const { return mContext; }

    void setContext( const QString &context );

    QColor baseColor() const { return mBaseColor; }

    void setBaseColor( const QColor &baseColor );

    QgsNamedColorList *colors() { return &mColors; }

  public slots:

    void refreshColors();

  signals:

    void colorChanged( const QColor &color );

    void hovered();

  protected:

    //reimplemented QWidget events
    void paintEvent( QPaintEvent *event ) override;
    void mouseMoveEvent( QMouseEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;
    void mouseReleaseEvent( QMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;
    void focusInEvent( QFocusEvent *event ) override;
    void focusOutEvent( QFocusEvent *event ) override;

  private:
    QgsColorScheme *mScheme = nullptr;
    QString mContext;
    QgsNamedColorList mColors;
    QColor mBaseColor;

    bool mDrawBoxDepressed;
    int mCurrentHoverBox;

    bool mFocused;
    int mCurrentFocusBox;

    int mWidth;
    int mLabelHeight = 0;
    int mLabelMargin = 0;

    int mSwatchSize = 0;
    int mSwatchOutlineSize = 0;

    int mSwatchMargin = 0;

    int mSwatchSpacing = 0;

    bool mPressedOnWidget;

    int calculateHeight() const;

    void draw( QPainter &painter );

    int swatchForPosition( QPoint position ) const;

    void updateTooltip( int colorIdx );

    QPixmap transparentBackground();
};


class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction
{
    Q_OBJECT

  public:

    QgsColorSwatchGridAction( QgsColorScheme *scheme, QMenu *menu = nullptr, const QString &context = QString(), QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setBaseColor( const QColor &baseColor );

    QColor baseColor() const;

    QString context() const;

    void setContext( const QString &context );

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

    bool dismissOnColorSelection() const { return mDismissOnColorSelection; }

  public slots:

    void refreshColors();

  signals:

    void colorChanged( const QColor &color );

  private:
    QMenu *mMenu = nullptr;
    QgsColorSwatchGrid *mColorSwatchGrid = nullptr;

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

  private slots:

    void setColor( const QColor &color );

    void onHover();
};

#endif