qgscolorbutton.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 QGSCOLORBUTTON_H
#define QGSCOLORBUTTON_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QColorDialog>
#include <QToolButton>
 
class QMimeData;
class QgsColorSchemeRegistry;
class QgsPanelWidget;
class QgsColorPickerHelper;

class GUI_EXPORT QgsColorButton : public QToolButton
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsColorButton *>( sipCpp ) )
      sipType = sipType_QgsColorButton;
    else
      sipType = NULL;
    SIP_END
#endif
 
 
    Q_OBJECT
    Q_PROPERTY( QString colorDialogTitle READ colorDialogTitle WRITE setColorDialogTitle )
    Q_PROPERTY( QColor color READ color WRITE setColor )
    Q_PROPERTY( bool allowOpacity READ allowOpacity WRITE setAllowOpacity )
    Q_PROPERTY( bool showMenu READ showMenu WRITE setShowMenu )
    Q_PROPERTY( Behavior behavior READ behavior WRITE setBehavior )
    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 opaqueColorString READ opaqueColorString WRITE setOpaqueColorString )
    Q_PROPERTY( QString context READ context WRITE setContext )
 
  public:
    enum Behavior
    {
      ShowDialog = 0, 
      SignalOnly      
    };
    Q_ENUM( Behavior )
 
    
    QgsColorButton( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QString &cdt = QString(), QgsColorSchemeRegistry *registry = nullptr );
 
    QSize minimumSizeHint() const override;
    QSize sizeHint() const override;

    QColor color() const;

    void setAllowOpacity( bool allowOpacity );

    bool allowOpacity() const { return mAllowOpacity; }

    void setColorDialogTitle( const QString &title );

    QString colorDialogTitle() const;

    void setShowMenu( bool showMenu );

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

    void setBehavior( Behavior behavior );

    Behavior behavior() const { return mBehavior; }

    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 setOpaqueColorString( const QString &opaqueColorString ) { mOpaqueColorString = opaqueColorString; }

    void setShowNull( bool showNull, const QString &nullString = QString() );

    bool showNull() const;

    bool isNull() const;

    QString noColorString() const { return mNoColorString; }

    QString opaqueColorString() const { return mOpaqueColorString; }

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

    QString context() const { return mContext; }

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

    QgsColorSchemeRegistry *colorSchemeRegistry() { return mColorSchemeRegistry; }

    void linkToProjectColor( const QString &name );

    QString linkedProjectColorName() const { return mLinkedColorName; }

    static QPixmap createMenuIcon( const QColor &color, bool showChecks = true );
 
  public slots:

    void setColor( const QColor &color );

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

    void copyColor();

    void pasteColor();

    void activatePicker();

    void setToNoColor();

    void setToOpaqueColor();

    void setToDefaultColor();

    void setToNull();

    void unlink();
 
  signals:

    void colorChanged( const QColor &color );

    void colorClicked( const QColor &color );

    void cleared();

    void unlinked();
 
  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 contextMenuEvent( QContextMenuEvent *e ) override;

    void mouseMoveEvent( QMouseEvent *e ) override;

    void dragEnterEvent( QDragEnterEvent *e ) override;

    void dragLeaveEvent( QDragLeaveEvent *e ) override;

    void dropEvent( QDropEvent *e ) override;
 
    void wheelEvent( QWheelEvent *event ) override;
 
  private:
    Behavior mBehavior = QgsColorButton::ShowDialog;
    QString mColorDialogTitle;
    QColor mColor;
    QSize mMinimumSize;
 
    QgsColorSchemeRegistry *mColorSchemeRegistry = nullptr;
 
    QColor mDefaultColor;
 
    QgsColorPickerHelper *mPickerHelper = nullptr;
 
    QString mContext;
    bool mAllowOpacity = false;
    bool mColorSet = false;
 
    bool mShowNoColorOption = false;
    QString mNoColorString;
    QString mOpaqueColorString;
    bool mShowNull = false;
    QString mNullColorString;
 
    QPoint mDragStartPosition;
 
    QMenu *mMenu = nullptr;
 
    QSize mIconSize;
    QString mLinkedColorName;
    bool mShowMenu = true;

    bool colorFromMimeData( const QMimeData *mimeData, QColor &resultColor );
 
    QColor linkedProjectColor() const;
 
  private slots:
 
    void buttonClicked();
 
    void showColorDialog();

    void setValidColor( const QColor &newColor );

    void setValidTemporaryColor( const QColor &newColor );

    void addRecentColor( const QColor &color );

    void prepareMenu();
 
    void onColorPicked( const QColor &color );
    void onColorHovered( const QColor &color );
    void colorPickingCanceled();
 
    friend class QgsColorTooltip;
};
 
#endif