qgscolorschemelist.h

Go to the documentation of this file.

/***************************************************************************
    qgscolorschemelist.h
    --------------------
    Date                 : August 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 QGSCOLORSCHEMELIST_H
#define QGSCOLORSCHEMELIST_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscolorscheme.h"
 
#include <QAbstractItemModel>
#include <QFile>
#include <QItemDelegate>
#include <QTreeView>
 
class QMimeData;
class QgsPanelWidget;

class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate
{
    Q_OBJECT
 
  public:
    QgsColorSwatchDelegate( QWidget *parent SIP_TRANSFERTHIS = nullptr );
    void paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    QSize sizeHint( const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    bool editorEvent( QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index ) override;
 
  private slots:
 
    void colorChanged();
 
  private:
    QWidget *mParent = nullptr;

    QPixmap transparentBackground() const;
};
 

class GUI_EXPORT QgsColorSchemeModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    explicit QgsColorSchemeModel( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor(), QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    //reimplemented QAbstractItemModel methods
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
    Qt::DropActions supportedDropActions() const override;
    QStringList mimeTypes() const override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    bool insertRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    QMimeData *mimeData( const QModelIndexList &indexes ) const override;
    bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override;

    QgsNamedColorList colors() const { return mColors; }

    void setScheme( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor() );

    QString context() const { return mContext; }

    QColor baseColor() const { return mBaseColor; }

    void addColor( const QColor &color, const QString &label = QString(), bool allowDuplicate = false );

    bool isDirty() const { return mIsDirty; }
 
  private:
    enum Columns
    {
      ColorSwatch = 0,
      ColorLabel
    };
 
    QgsNamedColorList mColors;
    QgsColorScheme *mScheme = nullptr;
    QString mContext;
    QColor mBaseColor;
    bool mIsDirty = false;
};

class GUI_EXPORT QgsColorSchemeList : public QTreeView
{
    Q_OBJECT
 
  public:
    QgsColorSchemeList( QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsColorScheme *scheme = nullptr, const QString &context = QString(), const QColor &baseColor = QColor() );

    bool saveColorsToScheme();

    bool importColorsFromGpl( QFile &file );

    bool exportColorsToGpl( QFile &file );

    bool isDirty() const;

    QgsColorScheme *scheme();
 
  public slots:

    void setScheme( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor() );

    void removeSelection();

    void addColor( const QColor &color, const QString &label = QString(), bool allowDuplicate = false );

    void pasteColors();

    void copyColors();

    void showImportColorsDialog();

    void showExportColorsDialog();
 
  signals:

    void colorSelected( const QColor &color );
 
  protected:
    void keyPressEvent( QKeyEvent *event ) override;
 
    void mousePressEvent( QMouseEvent *event ) override;
 
    void mouseReleaseEvent( QMouseEvent *event ) override;
 
  private:
    QgsColorScheme *mScheme = nullptr;
    QgsColorSchemeModel *mModel = nullptr;
    QgsColorSwatchDelegate *mSwatchDelegate = nullptr;
 
    QPoint mDragStartPosition;
};
 
#endif