qgscolorscheme.h

Go to the documentation of this file.

/***************************************************************************
                             qgscolorscheme.h
                             -------------------
    begin                : July 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 QGSCOLORSCHEME_H
#define QGSCOLORSCHEME_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QObject>
#include <QPair>
#include <QString>
 
class QgsSettingsEntryStringList;
class QgsSettingsEntryVariant;

typedef QList< QPair< QColor, QString > > QgsNamedColorList;

class CORE_EXPORT QgsColorScheme
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsUserColorScheme *>( sipCpp ) != NULL )
      sipType = sipType_QgsUserColorScheme;
    else if ( dynamic_cast<QgsRecentColorScheme *>( sipCpp ) != NULL )
      sipType = sipType_QgsRecentColorScheme;
    else if ( dynamic_cast<QgsCustomColorScheme *>( sipCpp ) != NULL )
      sipType = sipType_QgsCustomColorScheme;
    else if ( dynamic_cast<QgsProjectColorScheme *>( sipCpp ) != NULL )
      sipType = sipType_QgsProjectColorScheme;
    else if ( dynamic_cast<QgsGplColorScheme *>( sipCpp ) != NULL )
      sipType = sipType_QgsGplColorScheme;
    else
      sipType = sipType_QgsColorScheme;
  SIP_END
#endif
 
  public:

    enum SchemeFlag SIP_ENUM_BASETYPE( IntFlag )
    {
      ShowInColorDialog = 0x01,                                     
      ShowInColorButtonMenu = 0x02,                                 
      ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu 
    };
    Q_DECLARE_FLAGS( SchemeFlags, SchemeFlag )
 
    QgsColorScheme() = default;
 
    virtual ~QgsColorScheme() = default;

    virtual QString schemeName() const = 0;

    virtual SchemeFlags flags() const { return ShowInColorDialog; }

    virtual QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) = 0;

    virtual bool isEditable() const { return false; }

    virtual bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() );

    virtual QgsColorScheme *clone() const = 0 SIP_FACTORY;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsColorScheme::SchemeFlags )
 

class CORE_EXPORT QgsGplColorScheme : public QgsColorScheme
{
  public:
    QgsGplColorScheme() = default;
 
    QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
    bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
  protected:
    virtual QString gplFilePath() = 0;
};

class CORE_EXPORT QgsUserColorScheme : public QgsGplColorScheme
{
  public:
    QgsUserColorScheme( const QString &filename );
 
    QString schemeName() const override;
 
    QgsUserColorScheme *clone() const override SIP_FACTORY;
 
    bool isEditable() const override { return mEditable; }
 
    QgsColorScheme::SchemeFlags flags() const override;

    void setName( const QString &name ) { mName = name; }

    bool erase();

    void setShowSchemeInMenu( bool show );
 
#ifndef SIP_RUN
    static const QgsSettingsEntryStringList *settingsShowInMenuList SIP_SKIP;
#endif
 
  protected:
    QString mName;
 
    QString mFilename;
 
    bool mEditable = false;
 
    QString gplFilePath() override;
};

class CORE_EXPORT QgsRecentColorScheme : public QgsColorScheme
{
  public:
    QgsRecentColorScheme() = default;
 
    QString schemeName() const override { return QObject::tr( "Recent colors" ); }
 
    SchemeFlags flags() const override { return ShowInAllContexts; }
 
    QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
    QgsRecentColorScheme *clone() const override SIP_FACTORY;

    static void addRecentColor( const QColor &color );

    static QColor lastUsedColor();
 
#ifndef SIP_RUN
    static const QgsSettingsEntryVariant *settingsRecentColors SIP_SKIP;
#endif
};

class CORE_EXPORT QgsCustomColorScheme : public QgsColorScheme
{
  public:
    QgsCustomColorScheme() = default;
 
    QString schemeName() const override { return QObject::tr( "Standard colors" ); }
 
    SchemeFlags flags() const override { return ShowInAllContexts; }
 
    QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
    bool isEditable() const override { return true; }
 
    bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
    QgsCustomColorScheme *clone() const override SIP_FACTORY;
 
#ifndef SIP_RUN
    static const QgsSettingsEntryVariant *settingsPaletteColors SIP_SKIP;
    static const QgsSettingsEntryVariant *settingsPaletteLabels SIP_SKIP;
#endif
};

class CORE_EXPORT QgsProjectColorScheme : public QgsColorScheme
{
  public:
    QgsProjectColorScheme() = default;
 
    QString schemeName() const override { return QObject::tr( "Project colors" ); }
 
    SchemeFlags flags() const override { return ShowInAllContexts; }
 
    QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
    bool isEditable() const override { return true; }
 
    bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() ) override;
 
    QgsProjectColorScheme *clone() const override SIP_FACTORY;
};
 
#endif