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 <QColorDialog>
#include <QPushButton>
#include <QTemporaryFile>

class QMimeData;

class GUI_EXPORT QgsColorButton: public QPushButton
{
    Q_OBJECT
    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_FLAGS( QColorDialog::ColorDialogOptions )
    Q_PROPERTY( QColorDialog::ColorDialogOptions colorDialogOptions READ colorDialogOptions WRITE setColorDialogOptions )

  public:
    QgsColorButton( QWidget *parent = nullptr, const QString& cdt = "", const QColorDialog::ColorDialogOptions& cdo = nullptr );
    ~QgsColorButton();

    void setColor( const QColor &color );
    QColor color() const;

    void setColorDialogOptions( const QColorDialog::ColorDialogOptions& cdo );

    QColorDialog::ColorDialogOptions colorDialogOptions();

    void setColorDialogTitle( const QString& cdt );

    QString colorDialogTitle();

    bool acceptLiveUpdates() { return mAcceptLiveUpdates; }

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

  public slots:
    void setButtonBackground( QColor color = QColor() );

  signals:
    void colorChanged( const QColor &color );

  protected:
    void changeEvent( QEvent* e ) override;
    void showEvent( QShowEvent* e ) override;
    static const QPixmap& transpBkgrd();

    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 dropEvent( QDropEvent *e ) override;

  private:
    QString mColorDialogTitle;
    QColor mColor;
    QColorDialog::ColorDialogOptions mColorDialogOptions;
    bool mAcceptLiveUpdates;
    QTemporaryFile mTempPNG;
    bool mColorSet; // added in QGIS 2.1

    QPoint mDragStartPosition;
    bool mPickingColor;

    void showContextMenu( QMouseEvent* event );

    QMimeData* createColorMimeData() const;

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

#ifdef Q_OS_WIN

    QString fullPath( const QString &path );
#endif

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

  private slots:
    void onButtonClicked();

    void setValidColor( const QColor& newColor );
};

#endif