qgssvgselectorwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgssvgselectorwidget.h - group and preview selector for SVG files
                             built off of work in qgssymbollayerwidget
 
    ---------------------
    begin                : April 2, 2013
    copyright            : (C) 2013 by Larry Shaffer
    email                : larrys at dakcarto 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 QGSSVGSELECTORWIDGET_H
#define QGSSVGSELECTORWIDGET_H
 
#include "ui_widget_svgselector.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsguiutils.h"
#include "qgsproperty.h"
 
#include <QAbstractListModel>
#include <QDialog>
#include <QDialogButtonBox>
#include <QElapsedTimer>
#include <QItemDelegate>
#include <QLayout>
#include <QSortFilterProxyModel>
#include <QStandardItemModel>
#include <QThread>
#include <QWidget>
 
class QCheckBox;
class QLayout;
class QLineEdit;
class QListView;
class QPushButton;
class QTreeView;
 
class QgsExpressionContextGenerator;
class QgsSvgSelectorListModel;
class QgsPropertyOverrideButton;
 
 
#ifndef SIP_RUN
 

class GUI_EXPORT QgsSvgParametersModel : public QAbstractTableModel
{
    Q_OBJECT
 
  public:
    enum class Column : int
    {
      NameColumn = 0,
      ExpressionColumn = 1,
    };
 
    QgsSvgParametersModel( QObject *parent = nullptr );

    void setParameters( const QMap<QString, QgsProperty> &parameters );
    QMap<QString, QgsProperty> parameters() const;

    void removeParameters( const QModelIndexList &indexList );

    void setLayer( QgsVectorLayer *layer );
    QgsVectorLayer *layer() const { return mLayer; }

    void setExpressionContextGenerator( const QgsExpressionContextGenerator *generator );
    const QgsExpressionContextGenerator *expressionContextGenerator() const { return mExpressionContextGenerator; }
 
    int rowCount( const QModelIndex &parent ) const override;
    int columnCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
    QVariant headerData( int section, Qt::Orientation orientation, int role ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
 
  public slots:
    void addParameter();
 
  signals:
    void parametersChanged( const QMap<QString, QgsProperty> &parameters );
 
  private:
    struct Parameter
    {
        Parameter( const QString &name, const QgsProperty &property )
          : name( name )
          , property( property )
        {}
 
        QString name;
        QgsProperty property;
    };
 
    QList<Parameter> mParameters;
    QgsVectorLayer *mLayer = nullptr;
    const QgsExpressionContextGenerator *mExpressionContextGenerator = nullptr;
};

class GUI_EXPORT QgsSvgParameterValueDelegate : public QItemDelegate
{
    Q_OBJECT
 
  public:
    QgsSvgParameterValueDelegate( QObject *parent = nullptr )
      : QItemDelegate( parent )
    {}
 
    QWidget *createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    void setEditorData( QWidget *editor, const QModelIndex &index ) const override;
    void setModelData( QWidget *editor, QAbstractItemModel *model, const QModelIndex &index ) const override;
    void updateEditorGeometry( QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
};
 

class GUI_EXPORT QgsSvgSelectorLoader : public QThread
{
    Q_OBJECT
 
  public:
    QgsSvgSelectorLoader( QObject *parent = nullptr );
 
    ~QgsSvgSelectorLoader() override;

    void run() override;

    virtual void stop();

    void setPath( const QString &path ) { mPath = path; }
 
  signals:

    void foundSvgs( QStringList svgs );
 
  private:
    QString mPath;
    bool mCanceled = false;
    QStringList mQueuedSvgs;
 
    QElapsedTimer mTimer;
    int mTimerThreshold = 0;
    QSet<QString> mTraversedPaths;
 
    void loadPath( const QString &path );
    void loadImages( const QString &path );
};

class GUI_EXPORT QgsSvgGroupLoader : public QThread
{
    Q_OBJECT
 
  public:
    QgsSvgGroupLoader( QObject *parent = nullptr );
 
    ~QgsSvgGroupLoader() override;

    void run() override;

    virtual void stop();

    void setParentPaths( const QStringList &parentPaths ) { mParentPaths = parentPaths; }
 
  signals:

    void foundPath( const QString &parentPath, const QString &path );
 
  private:
    QStringList mParentPaths;
    bool mCanceled = false;
    QSet<QString> mTraversedPaths;
 
    void loadGroup( const QString &parentPath );
};

#endif

class GUI_EXPORT QgsSvgSelectorFilterModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    QgsSvgSelectorFilterModel( QObject *parent SIP_TRANSFERTHIS, const QString &path = QString(), int iconSize = 30 );
 
  private:
    QgsSvgSelectorListModel *mModel = nullptr;
};

class GUI_EXPORT QgsSvgSelectorListModel : public QAbstractListModel
{
    Q_OBJECT
 
  public:
    QgsSvgSelectorListModel( QObject *parent SIP_TRANSFERTHIS, int iconSize = 30 );

    QgsSvgSelectorListModel( QObject *parent SIP_TRANSFERTHIS, const QString &path, int iconSize = 30 );
 
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
 
  protected:
    QStringList mSvgFiles;
 
  private:
    QPixmap createPreview( const QString &entry ) const;
    QgsSvgSelectorLoader *mSvgLoader = nullptr;
 
    int mIconSize = 30;
 
  private slots:

    void addSvgs( const QStringList &svgs );
 
    friend class TestQgsSvgSelectorWidget;
};
 

class GUI_EXPORT QgsSvgSelectorGroupsModel : public QStandardItemModel
{
    Q_OBJECT
 
  public:
    QgsSvgSelectorGroupsModel( QObject *parent SIP_TRANSFERTHIS );
    ~QgsSvgSelectorGroupsModel() override;
 
  private:
    QgsSvgGroupLoader *mLoader = nullptr;
    QHash<QString, QStandardItem *> mPathItemHash;
 
  private slots:
 
    void addPath( const QString &parentPath, const QString &path );
};

class GUI_EXPORT QgsSvgSelectorWidget : public QWidget, private Ui::WidgetSvgSelector
{
    Q_OBJECT
 
  public:
    QgsSvgSelectorWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void initParametersModel( const QgsExpressionContextGenerator *generator, QgsVectorLayer *layer = nullptr );
 
    QString currentSvgPath() const;

    QgsPictureSourceLineEditBase *sourceLineEdit() const { return mSourceLineEdit; }

    void setAllowParameters( bool allow );

    Q_DECL_DEPRECATED bool allowParamerters() const SIP_DEPRECATED { return mAllowParameters; } // spellok

    bool allowParameters() const { return mAllowParameters; }

    void setBrowserVisible( bool visible );

    bool browserVisible() const { return mBrowserVisible; }

    QgsPropertyOverrideButton *propertyOverrideToolButton() const;
 
  public slots:
    void setSvgPath( const QString &svgPath );

    void setSvgParameters( const QMap<QString, QgsProperty> &parameters );
 
  signals:

    void svgSelected( const QString &path );

    void svgParametersChanged( const QMap<QString, QgsProperty> &parameters );
 
  protected:
    void populateList();
 
  private slots:
    void populateIcons( const QModelIndex &idx );
    void svgSelectionChanged( const QModelIndex &idx );
    void updateCurrentSvgPath( const QString &svgPath );
    void svgSourceChanged( const QString &text );
 
  private:
    int mIconSize = 30;
    QString mCurrentSvgPath; 
    bool mAllowParameters = false;
    bool mBrowserVisible = true;
    QgsSvgParametersModel *mParametersModel = nullptr;
};

class GUI_EXPORT QgsSvgSelectorDialog : public QDialog
{
    Q_OBJECT
  public:
    QgsSvgSelectorDialog(
      QWidget *parent SIP_TRANSFERTHIS = nullptr,
      Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags,
      QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close | QDialogButtonBox::Ok,
      Qt::Orientation orientation = Qt::Horizontal
    );

    QgsSvgSelectorWidget *svgSelector() { return mSvgSelector; }
 
  protected:
    QVBoxLayout *mLayout = nullptr;
    QDialogButtonBox *mButtonBox = nullptr;
    QgsSvgSelectorWidget *mSvgSelector = nullptr;
};
 
#endif // QGSSVGSELECTORWIDGET_H