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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsadvanceddigitizingtoolsregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAdvancedDigitizingToolAbstractMetadata
{
%Docstring(signature="appended")
Stores metadata about one advanced digitizing tool class.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsadvanceddigitizingtoolsregistry.h"
%End
public:
QgsAdvancedDigitizingToolAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() );
%Docstring
Constructor for QgsAdvancedDigitizingToolAbstractMetadata with the
specified tool ``name``.
``visibleName`` should be set to a translated, user visible name
identifying the corresponding annotation item.
An optional ``icon`` can be set, which will be used by the advanced
digitizing dock widget.
%End
virtual ~QgsAdvancedDigitizingToolAbstractMetadata();
QString name() const;
%Docstring
Returns the tool's unique name
%End
QString visibleName() const;
%Docstring
Returns the tool's translatable user-friendly name
%End
QIcon icon() const;
%Docstring
Returns the tool's icon
%End
virtual QgsAdvancedDigitizingTool *createTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) /Factory/;
%Docstring
Returns new tool of this type. Return ``None`` on error
%End
protected:
};
class QgsAdvancedDigitizingToolsRegistry
{
%Docstring(signature="appended")
Registry of available advanced digitizing tools.
:py:class:`QgsAdvancedDigitizingToolsRegistry` is not usually directly
created, but rather accessed through
:py:func:`QgsGui.advancedDigitizingToolsRegistry()`.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsadvanceddigitizingtoolsregistry.h"
%End
public:
QgsAdvancedDigitizingToolsRegistry();
~QgsAdvancedDigitizingToolsRegistry();
void addDefaultTools();
%Docstring
Adds the default tools shipped in QGIS
%End
bool addTool( QgsAdvancedDigitizingToolAbstractMetadata *toolMetaData /Transfer/ );
%Docstring
Adds an advanced digitizing tool (take ownership) and return ``True`` on
success
%End
bool removeTool( const QString &name );
%Docstring
Removes the advanced digitizing tool matching the provided ``name`` and
return ``True`` on success
%End
QgsAdvancedDigitizingToolAbstractMetadata *toolMetadata( const QString &name );
%Docstring
Returns the advanced digitizing tool matching the provided ``name`` or
``None`` when no match available
%End
const QStringList toolMetadataNames() const;
%Docstring
Returns the list of registered tool names
%End
private:
QgsAdvancedDigitizingToolsRegistry( const QgsAdvancedDigitizingToolsRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsadvanceddigitizingtoolsregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
