QGIS API Documentation 3.41.0-Master (d5b93354e9c)
Loading...
Searching...
No Matches
qgssymbolwidgetcontext.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssymbolwidgetcontext.h
3 ------------------------
4 begin : September 2016
5 copyright : (C) 2016 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSSYMBOLWIDGETCONTEXT_H
16#define QGSSYMBOLWIDGETCONTEXT_H
17
18#include <memory>
19
21#include "qgis_gui.h"
22
23class QgsMapLayer;
24class QgsMapCanvas;
25class QgsMessageBar;
26
34class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three
35{
36 public:
39 QgsSymbolWidgetContext &operator=( const QgsSymbolWidgetContext &other );
40
47 void setMapCanvas( QgsMapCanvas *canvas );
48
53 QgsMapCanvas *mapCanvas() const;
54
61 void setMessageBar( QgsMessageBar *bar );
62
68 QgsMessageBar *messageBar() const;
69
78 void setExpressionContext( QgsExpressionContext *context );
79
86 QgsExpressionContext *expressionContext() const;
87
93 void setAdditionalExpressionContextScopes( const QList<QgsExpressionContextScope> &scopes );
94
99 QList<QgsExpressionContextScope> additionalExpressionContextScopes() const;
100
105 QList<QgsExpressionContextScope *> globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const SIP_FACTORY;
106
114 Qgis::SymbolType symbolType() const;
115
123 void setSymbolType( Qgis::SymbolType type );
124
125 private:
126 QgsMapCanvas *mMapCanvas = nullptr;
127 QgsMessageBar *mMessageBar = nullptr;
128 std::unique_ptr<QgsExpressionContext> mExpressionContext;
129 QList<QgsExpressionContextScope> mAdditionalScopes;
131};
132
133#endif // QGSSYMBOLWIDGETCONTEXT_H
SymbolType
Symbol types.
Definition qgis.h:574
@ Hybrid
Hybrid symbol.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Map canvas is a class for displaying all GIS data types on a canvas.
Base class for all map layer types.
Definition qgsmaplayer.h:76
A bar for displaying non-blocking messages to the user.
Contains settings which reflect the context in which a symbol (or renderer) widget is shown,...
QgsSymbolWidgetContext()=default
#define SIP_FACTORY
Definition qgis_sip.h:76