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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/sensor/qgssensorguiregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSensorAbstractGuiMetadata
{
%Docstring(signature="appended")
Stores GUI metadata about one sensor class.
This is a companion to :py:class:`QgsSensorAbstractMetadata`, storing
only the components related to the GUI behavior of sensor.
.. note::
In C++ you can use :py:class:`QgsSensorGuiMetadata` convenience class.
.. versionadded:: 3.32
%End
%TypeHeaderCode
#include "qgssensorguiregistry.h"
%End
public:
QgsSensorAbstractGuiMetadata( const QString &type, const QString &visibleName );
%Docstring
Constructor for QgsSensorAbstractGuiMetadata with the specified class
``type``.
``visibleName`` should be set to a translated, user visible name
identifying the corresponding sensor type.
%End
virtual ~QgsSensorAbstractGuiMetadata();
QString type() const;
%Docstring
Returns the unique type code for the sensor class.
%End
QString visibleName() const;
%Docstring
Returns a translated, user visible name identifying the corresponding
sensor.
%End
virtual QIcon creationIcon() const;
%Docstring
Returns an icon representing creation of the sensor type.
%End
virtual QgsAbstractSensorWidget *createSensorWidget( QgsAbstractSensor *sensor ) /TransferBack/;
%Docstring
Creates a configuration widget for an ``sensor`` of this type. Can
return ``None`` if no configuration GUI is required.
%End
virtual QgsAbstractSensor *createSensor( QObject *parent ) /TransferBack/;
%Docstring
Creates an instance of the corresponding sensor type.
%End
};
class QgsSensorGuiRegistry : QObject
{
%Docstring(signature="appended")
Registry of available sensor GUI behavior.
:py:class:`QgsSensorGuiRegistry` is not usually directly created, but
rather accessed through :py:func:`QgsGui.sensorGuiRegistry()`.
This acts as a companion to :py:class:`QgsSensorRegistry`, handling only
the components related to the GUI behavior of sensors.
.. versionadded:: 3.32
%End
%TypeHeaderCode
#include "qgssensorguiregistry.h"
%End
public:
QgsSensorGuiRegistry( QObject *parent = 0 );
%Docstring
Creates a new empty sensor GUI registry.
QgsSensorGuiRegistry is not usually directly created, but rather
accessed through :py:func:`QgsGui.sensorGuiRegistry()`.
%End
~QgsSensorGuiRegistry();
bool populate();
%Docstring
Populates the registry with standard sensor types. If called on a
non-empty registry then this will have no effect and will return
``False``.
%End
QgsSensorAbstractGuiMetadata *sensorMetadata( const QString &type ) const;
%Docstring
Returns the metadata for the specified sensor ``type``. Returns ``None``
if a corresponding sensor type was not found in the registry.
%End
bool addSensorGuiMetadata( QgsSensorAbstractGuiMetadata *metadata /Transfer/ );
%Docstring
Registers the GUI metadata for a new sensor type. Takes ownership of the
metadata instance.
%End
QgsAbstractSensor *createSensor( const QString &type, QObject *parent = 0 ) const /TransferBack/;
%Docstring
Creates a new instance of a sensor given the ``type``.
%End
QgsAbstractSensorWidget *createSensorWidget( QgsAbstractSensor *sensor ) const /TransferBack/;
%Docstring
Creates a new instance of a sensor configuration widget for the
specified ``sensor``. The ``sensor`` doesn't need to live for the
duration of the widget, it is only used when creating the configuration
widget to match a sensor type and initiate the widget to match the
``sensor`` settings.
%End
QMap<QString, QString> sensorTypes() const;
%Docstring
Returns a list of sensor types handled by the registry.
%End
signals:
void sensorAdded( const QString &type, const QString &name );
%Docstring
Emitted whenever a new sensor type is added to the registry, with the
specified ``type``.
%End
private:
QgsSensorGuiRegistry( const QgsSensorGuiRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/sensor/qgssensorguiregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
