qgssymbolselectordialog.h

Go to the documentation of this file.

/***************************************************************************
    qgssymbolselectordialog.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 QGSSYMBOLSELECTORDIALOG_H
#define QGSSYMBOLSELECTORDIALOG_H
 
#include "ui_qgssymbolselectordialogbase.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgshelp.h"
#include "qgspanelwidget.h"
#include "qgsproperty.h"
#include "qgssymbolwidgetcontext.h"
 
#include <QDialog>
#include <QDialogButtonBox>
#include <QPointer>
#include <QStandardItemModel>
 
class QgsStyle;
class QgsSymbol;
class QgsSymbolLayer;
class QgsVectorLayer;
 
class QMenu;
class QWidget;
 
class SymbolLayerItem;
class QgsMarkerSymbol;
class QgsLineSymbol;
class QgsMarkerSymbolLayer;
class QgsLineSymbolLayer;
 
class QgsMapCanvas;
 
#ifndef SIP_RUN
 
class DataDefinedRestorer : public QObject
{
    Q_OBJECT
  public:
    DataDefinedRestorer( QgsSymbol *symbol, const QgsSymbolLayer *symbolLayer );
 
  public slots:
    void restore();
 
  private:
    QgsMarkerSymbol *mMarker = nullptr;
    const QgsMarkerSymbolLayer *mMarkerSymbolLayer = nullptr;
    double mSize = 0;
    double mAngle = 0;
    QPointF mMarkerOffset;
    QgsProperty mDDSize;
    QgsProperty mDDAngle;
 
    QgsLineSymbol *mLine = nullptr;
    const QgsLineSymbolLayer *mLineSymbolLayer = nullptr;
    double mWidth = 0;
    double mLineOffset = 0;
    QgsProperty mDDWidth;
 
    void save();
};
#endif
 
class QgsSymbolSelectorDialog;

class GUI_EXPORT QgsSymbolSelectorWidget : public QgsPanelWidget, private Ui::QgsSymbolSelectorDialogBase
{
    Q_OBJECT
    friend class QgsSymbolSelectorDialog;
 
  public:
    // TODO QGIS 4.0 - transfer ownership of symbol to widget!

    QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *style, QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    // TODO QGIS 4.0 -- remove when normal constructor takes ownership

    static QgsSymbolSelectorWidget *createWidgetWithSymbolOwnership( std::unique_ptr<QgsSymbol> symbol, QgsStyle *style, QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ) SIP_SKIP;

    QMenu *advancedMenu();

    void setContext( const QgsSymbolWidgetContext &context );

    QgsSymbolWidgetContext context() const;

    QgsSymbol *symbol() { return mSymbol; }
 
    // TODO QGIS 4.0 - transfer ownership of symbol to widget!

    void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent = nullptr ) SIP_SKIP;
 
  public slots:

    void moveLayerDown();

    void moveLayerUp();

    void addLayer();

    void removeLayer();

    void lockLayer();

    void duplicateLayer();

    void layerChanged();

    void updateLayerPreview();

    void updatePreview();

    void symbolChanged();

    void changeLayer( QgsSymbolLayer *layer );
 
  signals:

    void symbolModified();
 
  private slots:

    void projectDataChanged();

    void layersAboutToBeRemoved( const QList<QgsMapLayer *> &layers );
 
  private:
    void reloadSymbol();

    void updateUi();

    void updateLockButton();
 
    void updateLockButtonIcon();
 
    SymbolLayerItem *currentLayerItem();

    QgsSymbolLayer *currentLayer();

    void moveLayerByOffset( int offset );

    void setWidget( QWidget *widget );
 
    QgsStyle *mStyle = nullptr;
    QgsSymbol *mSymbol = nullptr;
    std::unique_ptr<QgsSymbol> mOwnedSymbol;
    QMenu *mAdvancedMenu = nullptr;
    QAction *mLockColorAction = nullptr;
    QAction *mLockSelectionColorAction = nullptr;
    QPointer<QgsVectorLayer> mVectorLayer;
 
    QStandardItemModel *mSymbolLayersModel = nullptr;
    QWidget *mPresentWidget = nullptr;
 
    std::unique_ptr<DataDefinedRestorer> mDataDefineRestorer;
    QgsSymbolWidgetContext mContext;
    QgsFeature mPreviewFeature;
    QgsExpressionContext mPreviewExpressionContext;
    bool mBlockModified = false;
};

class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsSymbolSelectorDialog( QgsSymbol *symbol, QgsStyle *style, QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr, bool embedded = false );

    QMenu *advancedMenu();

    void setContext( const QgsSymbolWidgetContext &context );

    QgsSymbolWidgetContext context() const;

    QgsSymbol *symbol();

    void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent = nullptr ) SIP_SKIP;

    QDialogButtonBox *buttonBox() const;
 
  public slots:
 
    void moveLayerDown();
    void moveLayerUp();
 
    void addLayer();
    void removeLayer();
 
    void lockLayer();

    void duplicateLayer();
 
    void layerChanged();
 
    void updateLayerPreview();
    void updatePreview();

    void symbolChanged();

    void changeLayer( QgsSymbolLayer *layer );
 
  protected:
    // Reimplements dialog keyPress event so we can ignore it
    void keyPressEvent( QKeyEvent *e ) override;
 
  private slots:
 
    void showHelp();
 
  signals:

    void symbolModified();
 
  private:
    void reloadSymbol();
 
    void updateUi();
 
    void updateLockButton();
 
    SymbolLayerItem *currentLayerItem();
 
    QgsSymbolLayer *currentLayer();
 
    void moveLayerByOffset( int offset );
 
    void setWidget( QWidget *widget );
 
    QgsSymbolSelectorWidget *mSelectorWidget = nullptr;
    QDialogButtonBox *mButtonBox = nullptr;
};
 
#endif