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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgspainteffectregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsPaintEffectWidget /External/;
class QgsPaintEffectAbstractMetadata
{
%Docstring(signature="appended")
Stores metadata about a paint effect class.
.. note::
It's necessary to implement the :py:func:`~createPaintEffect` function.
In C++ you can use the :py:class:`QgsPaintEffectMetadata` convenience class to
simplify creation of the metadata.
%End
%TypeHeaderCode
#include "qgspainteffectregistry.h"
%End
public:
QgsPaintEffectAbstractMetadata( const QString &name, const QString &visibleName );
%Docstring
Construct a new QgsPaintEffectAbstractMetadata
:param name: unique string representing paint effect class
:param visibleName: user visible name representing paint effect class
%End
virtual ~QgsPaintEffectAbstractMetadata();
QString name() const;
%Docstring
Returns the unique string representing the paint effect class
:return: unique string
.. seealso:: :py:func:`visibleName`
%End
QString visibleName() const;
%Docstring
Returns the user visible string representing the paint effect class
:return: friendly user visible string
.. seealso:: :py:func:`name`
%End
virtual QgsPaintEffect *createPaintEffect( const QVariantMap &map ) = 0 /Factory/;
%Docstring
Create a paint effect of this class given an encoded map of properties.
:param map: properties string map
:return: new paint effect
%End
virtual QgsPaintEffectWidget *createWidget() /Factory/;
%Docstring
Create configuration widget for paint effect of this class. Can return
``None`` if there's no GUI for the paint effect class.
:return: configuration widget
%End
protected:
};
class QgsPaintEffectRegistry
{
%Docstring(signature="appended")
Registry of available paint effects.
:py:class:`QgsPaintEffectRegistry` is not usually directly created, but
rather accessed through :py:func:`QgsApplication.paintEffectRegistry()`.
%End
%TypeHeaderCode
#include "qgspainteffectregistry.h"
%End
public:
QgsPaintEffectRegistry();
~QgsPaintEffectRegistry();
QgsPaintEffectAbstractMetadata *effectMetadata( const QString &name ) const;
%Docstring
Returns the metadata for a specific effect.
:param name: unique string name for paint effect class
:return: paint effect metadata if found, otherwise ``None``
%End
bool addEffectType( QgsPaintEffectAbstractMetadata *metadata /Transfer/ );
%Docstring
Registers a new effect type.
:param metadata: effect metadata. Ownership is transferred to the
registry.
:return: ``True`` if add was successful.
%End
QgsPaintEffect *createEffect( const QString &name, const QVariantMap &properties = QVariantMap() ) const /Factory/;
%Docstring
Creates a new paint effect given the effect name and properties map.
:param name: unique name representing paint effect class
:param properties: encoded string map of effect properties
:return: new paint effect of specified class, or ``None`` if matching
paint effect could not be created
%End
QgsPaintEffect *createEffect( const QDomElement &element ) const /Factory/;
%Docstring
Creates a new paint effect given a DOM element storing paint effect
properties.
:param element: encoded DOM element of effect properties
:return: new paint effect, or ``None`` if matching paint effect could
not be created
%End
QStringList effects() const;
%Docstring
Returns a list of known paint effects.
:return: list of paint effect names
%End
static QgsPaintEffect *defaultStack() /Factory/;
%Docstring
Returns a new effect stack consisting of a sensible selection of default
effects. All effects except the standard draw source effect are
disabled, but are included so that they can be easily drawn just by
enabling the effect.
:return: default effects stack
.. seealso:: :py:func:`isDefaultStack`
%End
static bool isDefaultStack( QgsPaintEffect *effect );
%Docstring
Tests whether a paint effect matches the default effects stack.
:param effect: paint effect to test
:return: ``True`` if effect is default stack
.. seealso:: :py:func:`defaultStack`
%End
private:
QgsPaintEffectRegistry( const QgsPaintEffectRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgspainteffectregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
