qgsstylemanagerdialog.h

Go to the documentation of this file.

/***************************************************************************
    qgsstylemanagerdialog.h
    ---------------------
    begin                : November 2009
    copyright            : (C) 2009 by Martin Dobias
    email                : wonder dot sk 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 QGSSTYLEV2MANAGERDIALOG_H
#define QGSSTYLEV2MANAGERDIALOG_H

#include <QDialog>
#include <QStandardItem>
#include <QAction>
#include <QMenu>

#include "ui_qgsstylemanagerdialogbase.h"
#include "qgshelp.h"
#include "qgsstylemodel.h"
#include "qgis_gui.h"

class QgsStyle;
class QgsTemporaryCursorOverride;
class QgsMessageBar;

#ifndef SIP_RUN
class QgsCheckableStyleModel: public QgsStyleProxyModel
{
    Q_OBJECT
  public:

    explicit QgsCheckableStyleModel( QgsStyle *style, QObject *parent = nullptr, bool readOnly = false );

    void setCheckable( bool checkable );
    void setCheckTag( const QString &tag );

    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;

  private:

    QgsStyle *mStyle = nullptr;
    bool mCheckable = false;
    QString mCheckTag;
    bool mReadOnly = false;

};
#endif

class GUI_EXPORT QgsStyleManagerDialog : public QDialog, private Ui::QgsStyleManagerDialogBase
{
    Q_OBJECT

  public:

    QgsStyleManagerDialog( QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags(),
                           bool readOnly = false );

    static QString addColorRampStatic( QWidget *parent, QgsStyle *style,
                                       QString RampType = QString() );

    void setFavoritesGroupVisible( bool show );

    void setSmartGroupsVisible( bool show );

    void setBaseStyleName( const QString &name );

  public slots:

    // TODO QGIS 4.0 -- most of this should be private

    void activate();

    void addItem();

    void editItem();

    void removeItem();

    void exportItemsSVG();

    void exportItemsPNG();

    void exportSelectedItemsImages( const QString &dir, const QString &format, QSize size );

    void exportItems();

    void importItems();

    void populateList();

    void onFinished();

    void onClose();

    void showHelp();

    Q_DECL_DEPRECATED void itemChanged( QStandardItem *item ) SIP_DEPRECATED;

    void groupChanged( const QModelIndex & );

    void groupRenamed( QStandardItem *item );

    int addTag();

    int addSmartgroup();

    void removeGroup();

    void tagSymbolsAction();

    void editSmartgroupAction();

    Q_DECL_DEPRECATED void regrouped( QStandardItem * ) SIP_DEPRECATED;

    void filterSymbols( const QString &filter );

    void symbolSelected( const QModelIndex & );

    void selectedSymbolsChanged( const QItemSelection &selected, const QItemSelection &deselected );

    void grouptreeContextMenu( QPoint );

    void listitemsContextMenu( QPoint );

  protected slots:
    bool addColorRamp( QAction *action );
    void addFavoriteSelectedSymbols();
    void removeFavoriteSelectedSymbols();
    void tagSelectedSymbols( bool newTag = false );
    void detagSelectedSymbols();

  protected:

    Q_DECL_DEPRECATED void populateTypes() SIP_DEPRECATED;

    void populateGroups();

    Q_DECL_DEPRECATED void setSymbolsChecked( const QStringList & ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void populateSymbols( const QStringList &symbolNames, bool checkable = false ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void populateColorRamps( const QStringList &colorRamps, bool checkable = false ) SIP_DEPRECATED;

    int currentItemType();
    QString currentItemName();

    bool addSymbol( int symbolType = -1 );
    bool addColorRamp();

    bool editSymbol();
    bool editColorRamp();

    Q_DECL_DEPRECATED bool removeSymbol() SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool removeColorRamp() SIP_DEPRECATED;

    void enableSymbolInputs( bool );
    void enableGroupInputs( bool );
    void enableItemsForGroupingMode( bool );

    void setBold( QStandardItem * );

  private slots:

    void tabItemType_currentChanged( int );

    void copyItemsToDefault();

  private:
    int selectedItemType();

    bool allTypesSelected() const;

    struct ItemDetails
    {
      QgsStyle::StyleEntity entityType;
      QgsSymbol::SymbolType symbolType;
      QString name;
    };

    QList< ItemDetails > selectedItems();

    static int copyItems( const QList< ItemDetails > &items, QgsStyle *src, QgsStyle *dst,
                          QWidget *parentWidget, std::unique_ptr<QgsTemporaryCursorOverride> &cursorOverride,
                          bool isImport, const QStringList &importTags, bool addToFavorites, bool ignoreSourceTags );

    QgsMessageBar *mMessageBar = nullptr;

    QgsStyle *mStyle = nullptr;

    QgsCheckableStyleModel *mModel = nullptr;

    QString mStyleFilename;

    bool mModified = false;

    bool mGroupingMode = false;

    QStringList mTagList;

    QMenu *mGroupMenu = nullptr;

    QMenu *mGroupListMenu = nullptr;

    QMenu *mGroupTreeContextMenu = nullptr;

    QMenu *mMenuBtnAddItemColorRamp = nullptr;

    QMenu *mMenuBtnAddItemAll = nullptr;

    QAction *mActionCopyToDefault = nullptr;

    int mBlockGroupUpdates = 0;

    bool mReadOnly = false;
    bool mFavoritesGroupVisible = true;
    bool mSmartGroupVisible = true;
    QString mBaseName;

    friend class QgsStyleExportImportDialog;
};

#endif