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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/annotations/qgsannotationitemwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAnnotationItemBaseWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A base class for property widgets for annotation items.
All annotation item widgets should inherit from this base class.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsannotationitemwidget.h"
%End
public:
QgsAnnotationItemBaseWidget( QWidget *parent /TransferThis/ );
%Docstring
Constructor for QgsAnnotationItemBaseWidget.
%End
virtual QgsAnnotationItem *createItem() = 0 /Factory/;
%Docstring
Creates a new item matching the settings defined in the widget.
%End
virtual void updateItem( QgsAnnotationItem *item ) = 0;
%Docstring
Updates an existing item to match the settings defined in the widget.
%End
bool setItem( QgsAnnotationItem *item );
%Docstring
Sets the current ``item`` to show in the widget. If ``True`` is
returned, ``item`` was an acceptable type for display in this widget and
the widget has been updated to match ``item``'s properties.
If ``False`` is returned, then the widget could not be successfully
updated to show the properties of ``item``.
%End
virtual void setLayer( QgsAnnotationLayer *layer );
%Docstring
Sets the associated annotation map ``layer``.
.. seealso:: :py:func:`layer`
.. versionadded:: 3.40
%End
QgsAnnotationLayer *layer();
%Docstring
Returns the associated annotation map layer.
.. seealso:: :py:func:`setLayer`
.. versionadded:: 3.40
%End
void setItemId( const QString &id );
%Docstring
Sets the associated annotation item ``id``.
.. seealso:: :py:func:`itemId`
.. versionadded:: 3.40
%End
QString itemId() const;
%Docstring
Returns the associated annotation item id.
.. seealso:: :py:func:`setItemId`
.. versionadded:: 3.40
%End
virtual void setContext( const QgsSymbolWidgetContext &context );
%Docstring
Sets the ``context`` in which the widget is shown, e.g., the associated
map canvas and expression contexts.
.. seealso:: :py:func:`context`
%End
QgsSymbolWidgetContext context() const;
%Docstring
Returns the context in which the widget is shown, e.g., the associated
map canvas and expression contexts.
.. seealso:: :py:func:`setContext`
%End
public slots:
virtual void focusDefaultWidget();
%Docstring
Focuses the default widget for the page.
%End
signals:
void itemChanged();
%Docstring
Emitted when the annotation item definition in the widget is changed by
the user.
%End
protected:
virtual bool setNewItem( QgsAnnotationItem *item );
%Docstring
Attempts to update the widget to show the properties for the specified
``item``.
Subclasses can override this if they support changing items in place.
Implementations must return ``True`` if the item was accepted and the
widget was updated.
%End
const QgsRenderedAnnotationItemDetails *renderedItemDetails();
%Docstring
Retrieve rendered annotation details for the associated annotation, if
available.
.. versionadded:: 3.40
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/annotations/qgsannotationitemwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
