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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsstyleentityvisitor.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStyleEntityVisitorInterface
{
%Docstring(signature="appended")
An interface for classes which can visit style entity (e.g. symbol)
nodes (using the visitor pattern).
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsstyleentityvisitor.h"
%End
public:
enum class NodeType /BaseType=IntEnum/
{
Project,
Layer,
SymbolRule,
Layouts,
PrintLayout,
LayoutItem,
Report,
ReportHeader,
ReportFooter,
ReportSection,
Annotations,
Annotation,
};
struct StyleLeaf
{
StyleLeaf( const QgsStyleEntityInterface *entity, const QString &identifier = QString(), const QString &description = QString() );
%Docstring
Constructor for StyleLeaf, visiting the given style ``entity`` with the
specified ``identifier`` and ``description``.
Ownership of ``entity`` is not transferred.
%End
QString identifier;
QString description;
const QgsStyleEntityInterface *entity;
};
struct Node
{
Node( QgsStyleEntityVisitorInterface::NodeType type, const QString &identifier, const QString &description );
%Docstring
Constructor for Node, visiting the node with the specified
``identifier`` and ``description``.
%End
QgsStyleEntityVisitorInterface::NodeType type;
QString identifier;
QString description;
};
virtual ~QgsStyleEntityVisitorInterface();
virtual bool visit( const QgsStyleEntityVisitorInterface::StyleLeaf &entity );
%Docstring
Called when the visitor will visit a style ``entity``.
Subclasses should return ``False`` to abort further visitations, or
``True`` to continue visiting after processing this entity.
%End
virtual bool visitEnter( const QgsStyleEntityVisitorInterface::Node &node );
%Docstring
Called when the visitor starts visiting a ``node``.
Subclasses should return ``False`` if they do NOT want to visit this
particular node - e.g. if the node type is
QgsStyleEntityVisitorInterface.NodeType.Layouts and they do not wish to
visit layout objects. In this case the visitor will not process the
node, and will move to the next available node instead. Return ``True``
to proceed with visiting the node.
The default implementation returns ``True``.
%End
virtual bool visitExit( const QgsStyleEntityVisitorInterface::Node &node );
%Docstring
Called when the visitor stops visiting a ``node``.
Subclasses should return ``False`` to abort further visitations, or
``True`` to continue visiting other nodes.
The default implementation returns ``True``.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsstyleentityvisitor.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
