qgssymbolwidgetcontext.h

Go to the documentation of this file.

/***************************************************************************
    qgssymbolwidgetcontext.h
    ------------------------
    begin                : September 2016
    copyright            : (C) 2016 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 QGSSYMBOLWIDGETCONTEXT_H
#define QGSSYMBOLWIDGETCONTEXT_H
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgsexpressioncontext.h"
 
class QgsMapLayer;
class QgsMapCanvas;
class QgsMessageBar;

class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three
{
  public:
    QgsSymbolWidgetContext() = default;
    QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other );
    QgsSymbolWidgetContext &operator=( const QgsSymbolWidgetContext &other );

    void setMapCanvas( QgsMapCanvas *canvas );

    QgsMapCanvas *mapCanvas() const;

    void setMessageBar( QgsMessageBar *bar );

    QgsMessageBar *messageBar() const;

    void setExpressionContext( QgsExpressionContext *context );

    QgsExpressionContext *expressionContext() const;

    void setAdditionalExpressionContextScopes( const QList<QgsExpressionContextScope> &scopes );

    QList<QgsExpressionContextScope> additionalExpressionContextScopes() const;

    QList<QgsExpressionContextScope *> globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const SIP_FACTORY;

    Qgis::SymbolType symbolType() const;

    void setSymbolType( Qgis::SymbolType type );
 
  private:
    QgsMapCanvas *mMapCanvas = nullptr;
    QgsMessageBar *mMessageBar = nullptr;
    std::unique_ptr<QgsExpressionContext> mExpressionContext;
    QList<QgsExpressionContextScope> mAdditionalScopes;
    Qgis::SymbolType mSymbolType = Qgis::SymbolType::Hybrid;
};
 
#endif // QGSSYMBOLWIDGETCONTEXT_H