1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgssymbolwidgetcontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSymbolWidgetContext
{
%Docstring(signature="appended")
Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the
map canvas and relevant expression contexts.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgssymbolwidgetcontext.h"
%End
public:
QgsSymbolWidgetContext();
%Docstring
Constructor for QgsSymbolWidgetContext.
%End
QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other );
%Docstring
Copy constructor.
:param other: source QgsSymbolWidgetContext
%End
void setMapCanvas( QgsMapCanvas *canvas );
%Docstring
Sets the map canvas associated with the widget. This allows the widget to retrieve the current
map scale and other properties from the canvas.
:param canvas: map canvas
.. seealso:: :py:func:`mapCanvas`
%End
QgsMapCanvas *mapCanvas() const;
%Docstring
Returns the map canvas associated with the widget.
.. seealso:: :py:func:`setMapCanvas`
%End
void setMessageBar( QgsMessageBar *bar );
%Docstring
Sets the message ``bar`` associated with the widget. This allows the widget to push feedback messages
to the appropriate message bar.
.. seealso:: :py:func:`messageBar`
.. versionadded:: 3.6
%End
QgsMessageBar *messageBar() const;
%Docstring
Returns the message bar associated with the widget.
.. seealso:: :py:func:`setMessageBar`
.. versionadded:: 3.6
%End
void setExpressionContext( QgsExpressionContext *context );
%Docstring
Sets the optional expression context used for the widget. This expression context is used for
evaluating data defined symbol properties and for populating based expression widgets in
the layer widget.
:param context: expression context pointer. Ownership is not transferred.
.. seealso:: :py:func:`expressionContext`
.. seealso:: :py:func:`setAdditionalExpressionContextScopes`
%End
QgsExpressionContext *expressionContext() const;
%Docstring
Returns the expression context used for the widget, if set. This expression context is used for
evaluating data defined symbol properties and for populating based expression widgets in
the layer widget.
.. seealso:: :py:func:`setExpressionContext`
%End
void setAdditionalExpressionContextScopes( const QList< QgsExpressionContextScope > &scopes );
%Docstring
Sets a list of additional expression context scopes to show as available within the layer.
:param scopes: list of additional scopes which will be added in order to the end of the default expression context
.. seealso:: :py:func:`setExpressionContext`
%End
QList< QgsExpressionContextScope > additionalExpressionContextScopes() const;
%Docstring
Returns the list of additional expression context scopes to show as available within the layer.
.. seealso:: :py:func:`setAdditionalExpressionContextScopes`
%End
QList<QgsExpressionContextScope *> globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const /Factory/;
%Docstring
Returns list of scopes: global, project, atlas, map, layer.
Ownership is transferred to the caller.
.. versionadded:: 3.0
%End
Qgis::SymbolType symbolType() const;
%Docstring
Returns the associated symbol type, if the widget is being shown as a subcomponent
of a parent symbol configuration widget.
.. seealso:: :py:func:`setSymbolType`
.. versionadded:: 3.18
%End
void setSymbolType( Qgis::SymbolType type );
%Docstring
Sets the associated symbol ``type``, if the widget is being shown as a subcomponent
of a parent symbol configuration widget.
.. seealso:: :py:func:`symbolType`
.. versionadded:: 3.18
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgssymbolwidgetcontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
