QGIS API Documentation 3.29.0-Master (8c80f25a4f)
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
23
24class QgsMapCanvas;
25class QgsMessageBar;
26
35class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three
36{
37 public:
38
43
49
50 QgsSymbolWidgetContext &operator=( const QgsSymbolWidgetContext &other );
51
58 void setMapCanvas( QgsMapCanvas *canvas );
59
64 QgsMapCanvas *mapCanvas() const;
65
72 void setMessageBar( QgsMessageBar *bar );
73
79 QgsMessageBar *messageBar() const;
80
89 void setExpressionContext( QgsExpressionContext *context );
90
97 QgsExpressionContext *expressionContext() const;
98
104 void setAdditionalExpressionContextScopes( const QList< QgsExpressionContextScope > &scopes );
105
110 QList< QgsExpressionContextScope > additionalExpressionContextScopes() const;
111
117 QList<QgsExpressionContextScope *> globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const SIP_FACTORY;
118
126 Qgis::SymbolType symbolType() const;
127
135 void setSymbolType( Qgis::SymbolType type );
136
137 private:
138
139 QgsMapCanvas *mMapCanvas = nullptr;
140 QgsMessageBar *mMessageBar = nullptr;
141 std::unique_ptr< QgsExpressionContext > mExpressionContext;
142 QList< QgsExpressionContextScope > mAdditionalScopes;
144
145};
146
147#endif // QGSSYMBOLWIDGETCONTEXT_H
SymbolType
Symbol types.
Definition: qgis.h:206
@ 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.
Definition: qgsmapcanvas.h:90
Base class for all map layer types.
Definition: qgsmaplayer.h:73
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
Contains settings which reflect the context in which a symbol (or renderer) widget is shown,...
QgsSymbolWidgetContext()=default
Constructor for QgsSymbolWidgetContext.
#define SIP_FACTORY
Definition: qgis_sip.h:76