qgscolorbuttonv2.h

Go to the documentation of this file.

/***************************************************************************
    qgscolorbutton.h - Color button
     --------------------------------------
    Date                 : 12-Dec-2006
    Copyright            : (C) 2006 by Tom Elwertowski
    Email                : telwertowski at users dot sourceforge dot net
 ***************************************************************************
 *                                                                         *
 *   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 QGSCOLORBUTTONV2_H
#define QGSCOLORBUTTONV2_H

#include <QColorDialog>
#include <QToolButton>
#include <QTemporaryFile>
#include "qgscolorscheme.h"

class QMimeData;
class QgsColorSchemeRegistry;
class QgsPanelWidget;

class GUI_EXPORT QgsColorButtonV2 : public QToolButton
{
    Q_OBJECT
    Q_ENUMS( Behaviour )
    Q_PROPERTY( QString colorDialogTitle READ colorDialogTitle WRITE setColorDialogTitle )
    Q_PROPERTY( bool acceptLiveUpdates READ acceptLiveUpdates WRITE setAcceptLiveUpdates )
    Q_PROPERTY( QColor color READ color WRITE setColor )
    Q_PROPERTY( bool allowAlpha READ allowAlpha WRITE setAllowAlpha )
    Q_PROPERTY( bool showMenu READ showMenu WRITE setShowMenu )
    Q_PROPERTY( Behaviour behaviour READ behaviour WRITE setBehaviour )
    Q_PROPERTY( QColor defaultColor READ defaultColor WRITE setDefaultColor )
    Q_PROPERTY( bool showNoColor READ showNoColor WRITE setShowNoColor )
    Q_PROPERTY( QString noColorString READ noColorString WRITE setNoColorString )
    Q_PROPERTY( QString context READ context WRITE setContext )

  public:

    enum Behaviour
    {
      ShowDialog = 0, 
      SignalOnly 
    };

    QgsColorButtonV2( QWidget *parent = nullptr, const QString& cdt = "", QgsColorSchemeRegistry* registry = nullptr );

    virtual ~QgsColorButtonV2();

    virtual QSize sizeHint() const override;

    QColor color() const;

    void setAllowAlpha( const bool allowAlpha );

    bool allowAlpha() const { return mAllowAlpha; }

    void setColorDialogTitle( const QString& title );

    QString colorDialogTitle() const;

    bool acceptLiveUpdates() const { return mAcceptLiveUpdates; }

    void setAcceptLiveUpdates( const bool accept ) { mAcceptLiveUpdates = accept; }

    void setShowMenu( const bool showMenu );

    bool showMenu() const { return menu() ? true : false; }

    void setBehaviour( const Behaviour behaviour );

    Behaviour behaviour() const { return mBehaviour; }

    void setDefaultColor( const QColor& color );

    QColor defaultColor() const { return mDefaultColor; }

    void setShowNoColor( const bool showNoColorOption ) { mShowNoColorOption = showNoColorOption; }

    bool showNoColor() const { return mShowNoColorOption; }

    void setNoColorString( const QString& noColorString ) { mNoColorString = noColorString; }

    void setShowNull( bool showNull );

    bool showNull() const;

    bool isNull() const;

    QString noColorString() const { return mNoColorString; }

    void setContext( const QString& context ) { mContext = context; }

    QString context() const { return mContext; }

    void setColorSchemeRegistry( QgsColorSchemeRegistry* registry ) { mColorSchemeRegistry = registry; }

    QgsColorSchemeRegistry* colorSchemeRegistry() { return mColorSchemeRegistry; }

  public slots:

    void setColor( const QColor &color );

    void setButtonBackground( const QColor &color = QColor() );

    void copyColor();

    void pasteColor();

    void activatePicker();

    void setToNoColor();

    void setToDefaultColor();

    void setToNull();

  signals:

    void colorChanged( const QColor &color );

    void colorClicked( const QColor &color );

  protected:

    bool event( QEvent *e ) override;
    void changeEvent( QEvent* e ) override;
    void showEvent( QShowEvent* e ) override;
    void resizeEvent( QResizeEvent *event ) override;

    static const QPixmap& transparentBackground();

    void mousePressEvent( QMouseEvent* e ) override;

    void mouseMoveEvent( QMouseEvent *e ) override;

    void mouseReleaseEvent( QMouseEvent *e ) override;

    void keyPressEvent( QKeyEvent *e ) override;

    void dragEnterEvent( QDragEnterEvent * e ) override;

    void dragLeaveEvent( QDragLeaveEvent *e ) override;

    void dropEvent( QDropEvent *e ) override;

  private:

    Behaviour mBehaviour;
    QString mColorDialogTitle;
    QColor mColor;

    QgsColorSchemeRegistry* mColorSchemeRegistry;

    QColor mDefaultColor;
    QString mContext;
    bool mAllowAlpha;
    bool mAcceptLiveUpdates;
    bool mColorSet;

    bool mShowNoColorOption;
    QString mNoColorString;
    bool mShowNull;

    QPoint mDragStartPosition;
    bool mPickingColor;

    QMenu* mMenu;

    QSize mIconSize;

    bool colorFromMimeData( const QMimeData *mimeData, QColor &resultColor );

    void stopPicking( QPointF eventPos, bool sampleColor = true );

    QPixmap createMenuIcon( const QColor &color, const bool showChecks = true );

  private slots:

    void buttonClicked();

    void showColorDialog();

    void setValidColor( const QColor& newColor );

    void setValidTemporaryColor( const QColor& newColor );

    void panelAccepted( QgsPanelWidget* widget );

    void addRecentColor( const QColor& color );

    void prepareMenu();
};

#endif