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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsmaplayerconfigwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMapLayerConfigWidgetContext
{
%Docstring(signature="appended")
Encapsulates the context for a :py:class:`QgsMapLayerConfigWidget`.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsmaplayerconfigwidget.h"
%End
public:
QString annotationId() const;
%Docstring
Returns the item ID of the target annotation, when modifying
an annotation from a :py:class:`QgsAnnotationLayer`.
.. seealso:: :py:func:`setAnnotationId`
%End
void setAnnotationId( const QString &id );
%Docstring
Sets the item ``id`` of the target annotation, when modifying
an annotation from a :py:class:`QgsAnnotationLayer`.
.. seealso:: :py:func:`annotationId`
%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.
.. 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`
%End
QgsMessageBar *messageBar() const;
%Docstring
Returns the message bar associated with the widget.
.. seealso:: :py:func:`setMessageBar`
%End
};
class QgsMapLayerConfigWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A panel widget that can be shown in the map style dock
.. versionadded:: 2.16
%End
%TypeHeaderCode
#include "qgsmaplayerconfigwidget.h"
%End
public:
QgsMapLayerConfigWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = 0 );
%Docstring
A panel widget that can be shown in the map style dock
:param layer: The layer active in the dock.
:param canvas: The canvas object.
:param parent: The parent of the widget.
.. note::
The widget is created each time the panel is selected in the dock.
Keep the loading light as possible for speed in the UI.
%End
virtual bool shouldTriggerLayerRepaint() const;
%Docstring
Whether this config widget changes map layer properties in a way that :py:func:`~QgsMapLayerConfigWidget.triggerRepaint` should
be called for the layer after applying changes. This is ``True`` by default, but some config widgets
(for example 3D rendering config) do not need layer repaint as they do not modify 2D map rendering.
.. versionadded:: 3.8
%End
virtual void syncToLayer( QgsMapLayer *layer );
%Docstring
Reset to original (vector layer) values
.. versionadded:: 3.14
%End
virtual void setMapLayerConfigWidgetContext( const QgsMapLayerConfigWidgetContext &context );
%Docstring
Sets the ``context`` under which the widget is being shown.
Subclasses should take care to call the base class implementation when overriding this method.
%End
public slots:
virtual void apply() = 0;
%Docstring
Called when changes to the layer need to be made.
Will be called when live update is enabled.
%End
virtual void focusDefaultWidget();
%Docstring
Focuses the default widget for the page.
.. versionadded:: 3.22
%End
signals:
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsmaplayerconfigwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
