qgscolorrampbutton.h

Go to the documentation of this file.

/***************************************************************************
    qgscolorrampbutton.h - Color ramp button
     --------------------------------------
    Date                 : November 27, 2016
    Copyright            : (C) 2016 by Mathieu Pellerin
    Email                : nirvn dot asia 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 QGSCOLORRAMPBUTTON_H
#define QGSCOLORRAMPBUTTON_H
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QToolButton>
 
class QgsPanelWidget;
class QgsColorRamp;
class QgsStyle;

class GUI_EXPORT QgsColorRampButton : public QToolButton
{
    Q_OBJECT
    Q_PROPERTY( QString colorRampDialogTitle READ colorRampDialogTitle WRITE setColorRampDialogTitle )
    Q_PROPERTY( bool acceptLiveUpdates READ acceptLiveUpdates WRITE setAcceptLiveUpdates )
    Q_PROPERTY( bool showMenu READ showMenu WRITE setShowMenu )
    Q_PROPERTY( QgsColorRamp *defaultColorRamp READ defaultColorRamp WRITE setDefaultColorRamp )
    Q_PROPERTY( QString context READ context WRITE setContext )
 
  public:

    QgsColorRampButton( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QString &dialogTitle = QString() );
 
    ~QgsColorRampButton() override;
 
    QSize sizeHint() const override;

    QgsColorRamp *colorRamp() const SIP_FACTORY;

    void setColorRampDialogTitle( const QString &title );

    QString colorRampDialogTitle() const;

    bool acceptLiveUpdates() const { return mAcceptLiveUpdates; }

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

    void setShowMenu( bool showMenu );

    bool showMenu() const;

    void setDefaultColorRamp( QgsColorRamp *colorramp );

    QgsColorRamp *defaultColorRamp() const SIP_FACTORY;

    void setShowRandomColorRamp( bool showRandom ) { mShowRandomColorRamp = showRandom; }

    bool showRandomColorRamp() const { return mShowRandomColorRamp; }

    bool isRandomColorRamp() const;

    void setShowNull( bool showNull );

    bool showNull() const;

    bool isNull() const;

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

    QString context() const { return mContext; }

    void setShowGradientOnly( bool gradientonly ) { mShowGradientOnly = gradientonly; }

    bool showGradientOnly() const { return mShowGradientOnly; }

    void setColorRampName( const QString &name ) { mColorRampName = name; }

    QString colorRampName() const { return mColorRampName; }
 
  public slots:

    void setColorRamp( QgsColorRamp *colorramp );

    void setRandomColorRamp();

    void setColorRampFromName( const QString &name = QString() );

    void setButtonBackground( QgsColorRamp *colorramp = nullptr );

    void setToDefaultColorRamp();

    void setToNull();
 
  signals:

    void colorRampChanged();
 
  private slots:
 
    void rampWidgetUpdated();
 
  protected:
    bool event( QEvent *e ) override;
    void changeEvent( QEvent *e ) override;
    void showEvent( QShowEvent *e ) override;
    void resizeEvent( QResizeEvent *event ) override;

    void mousePressEvent( QMouseEvent *e ) override;
 
  private:
    QString mColorRampDialogTitle;
    bool mShowGradientOnly = false;
    std::unique_ptr<QgsColorRamp> mColorRamp;
    QString mColorRampName;
    QgsStyle *mStyle = nullptr;
 
    std::unique_ptr<QgsColorRamp> mDefaultColorRamp;
    QString mContext;
    bool mAcceptLiveUpdates = true;
    bool mShowRandomColorRamp = false;
    bool mShowNull = false;
 
    QMenu *mMenu = nullptr;
    QMenu *mAllRampsMenu = nullptr;
 
    QSize mIconSize;

    QPixmap createMenuIcon( QgsColorRamp *colorramp );
 
  private slots:
 
    void buttonClicked();

    void showColorRampDialog();

    void createColorRamp();

    void saveColorRamp();

    void invertColorRamp();

    void loadColorRamp();

    void prepareMenu();
};
 
#endif