qgsprojectstylesettings.h

Go to the documentation of this file.

/***************************************************************************
    qgsprojectstylesettings.h
    ---------------------------
    begin                : May 2022
    copyright            : (C) 2022 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 QGSPROJECTSTYLESETTINGS_H
#define QGSPROJECTSTYLESETTINGS_H
 
#include <memory.h>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgstextformat.h"
#include "qgswkbtypes.h"
 
#include <QAbstractListModel>
#include <QColorSpace>
#include <QPointer>
#include <QSortFilterProxyModel>
 
class QDomElement;
class QgsReadWriteContext;
class QDomDocument;
class QgsProject;
class QgsSymbol;
class QgsColorRamp;
class QgsStyle;
class QgsCombinedStyleModel;

class CORE_EXPORT QgsProjectStyleSettings : public QObject
{
    Q_OBJECT
 
  public:
    QgsProjectStyleSettings( QgsProject *project = nullptr );
 
    ~QgsProjectStyleSettings() override;

    QgsSymbol *defaultSymbol( Qgis::SymbolType symbolType ) const SIP_FACTORY;

    void setDefaultSymbol( Qgis::SymbolType symbolType, QgsSymbol *symbol );

    QgsColorRamp *defaultColorRamp() const SIP_FACTORY;

    void setDefaultColorRamp( QgsColorRamp *colorRamp );

    QgsTextFormat defaultTextFormat() const;

    void setDefaultTextFormat( const QgsTextFormat &textFormat );

    bool randomizeDefaultSymbolColor() const { return mRandomizeDefaultSymbolColor; }

    void setRandomizeDefaultSymbolColor( bool randomized );

    double defaultSymbolOpacity() const { return mDefaultSymbolOpacity; }

    void setDefaultSymbolOpacity( double opacity );

    void reset();

    void removeProjectStyle();

    void setProjectStyle( QgsStyle *style SIP_TRANSFER );

    QgsStyle *projectStyle();

    void setColorModel( Qgis::ColorModel colorModel );

    Qgis::ColorModel colorModel() const;

    void setColorSpace( const QColorSpace &colorSpace );

    QColorSpace colorSpace() const;

    bool readXml( const QDomElement &element, const QgsReadWriteContext &context, Qgis::ProjectReadFlags flags = Qgis::ProjectReadFlags() );

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;

    QStringList styleDatabasePaths() const { return mStyleDatabases; }

    QList< QgsStyle * > styles() const;

    QgsStyle *styleAtPath( const QString &path );

    void addStyleDatabasePath( const QString &path );

    void setStyleDatabasePaths( const QStringList &paths );

    QgsCombinedStyleModel *combinedStyleModel();
 
  signals:

    void styleDatabasesChanged();
 
#ifndef SIP_RUN

    void styleDatabaseAboutToBeAdded( const QString &path );

    void styleDatabaseAdded( const QString &path );

    void styleDatabaseAboutToBeRemoved( const QString &path );

    void styleDatabaseRemoved( const QString &path );

    void projectStyleChanged();
 
#endif
  private:
    QgsProject *mProject = nullptr;
 
    std::unique_ptr< QgsSymbol > mDefaultMarkerSymbol;
    std::unique_ptr< QgsSymbol > mDefaultLineSymbol;
    std::unique_ptr< QgsSymbol > mDefaultFillSymbol;
    std::unique_ptr< QgsColorRamp > mDefaultColorRamp;
    QgsTextFormat mDefaultTextFormat;
 
    bool mRandomizeDefaultSymbolColor = true;
    double mDefaultSymbolOpacity = 1.0;
 
    QgsStyle *mProjectStyle = nullptr;
    QStringList mStyleDatabases;
    QList< QPointer< QgsStyle > > mStyles;
 
    QgsCombinedStyleModel *mCombinedStyleModel = nullptr;
    Qgis::ColorModel mColorModel = Qgis::ColorModel::Rgb;
    QColorSpace mColorSpace;
    QString mIccProfileFilePath;
 
    void loadStyleAtPath( const QString &path );
    void clearStyles();

    void makeDirty();
 
    friend class TestQgsProjectProperties;
};

class CORE_EXPORT QgsProjectStyleDatabaseModel : public QAbstractListModel
{
    Q_OBJECT
 
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsProjectStyleDatabaseModel, Role ) : int
    {
      Style SIP_MONKEYPATCH_COMPAT_NAME( StyleRole ) = Qt::UserRole + 1, 
      Path SIP_MONKEYPATCH_COMPAT_NAME( PathRole )                       
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsProjectStyleDatabaseModel( QgsProjectStyleSettings *settings, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    int rowCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;

    QgsStyle *styleFromIndex( const QModelIndex &index ) const;

    QModelIndex indexFromStyle( QgsStyle *style ) const;

    void setShowDefaultStyle( bool show );

    bool showDefaultStyle() const { return mShowDefault; }
 
  private slots:
    void styleDatabaseAboutToBeAdded( const QString &path );
    void styleDatabaseAboutToBeRemoved( const QString &path );
    void styleDatabaseAdded( const QString &path );
    void styleDatabaseRemoved( const QString &path );
 
    void setProjectStyle( QgsStyle *style );
    void projectStyleAboutToBeDestroyed();
    void projectStyleDestroyed();
    void projectStyleChanged();
 
  private:
    QgsProjectStyleSettings *mSettings = nullptr;
    bool mShowDefault = false;
    QPointer< QgsStyle > mProjectStyle;
};

class CORE_EXPORT QgsProjectStyleDatabaseProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    enum class Filter : int SIP_ENUM_BASETYPE( IntFlag )
    {
      FilterHideReadOnly = 1 << 0, 
    };
    Q_ENUM( Filter )
    Q_DECLARE_FLAGS( Filters, Filter )
    Q_FLAG( Filters )

    QgsProjectStyleDatabaseProxyModel( QgsProjectStyleDatabaseModel *model, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;

    QgsProjectStyleDatabaseProxyModel::Filters filters() const;

    void setFilters( QgsProjectStyleDatabaseProxyModel::Filters filters );
 
  private:
    QgsProjectStyleDatabaseProxyModel::Filters mFilters;
};
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProjectStyleDatabaseProxyModel::Filters )
 
 
#endif // QGSPROJECTSTYLESETTINGS_H