File: qgsmetadatawidget.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (190 lines) | stat: -rw-r--r-- 4,594 bytes parent folder | download | duplicates (6)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsmetadatawidget.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsMetadataWidget : QWidget
{
%Docstring(signature="appended")
A wizard to edit metadata on a map layer.
%End

%TypeHeaderCode
#include "qgsmetadatawidget.h"
%End
  public:
    enum Mode /BaseType=IntEnum/
    {
      LayerMetadata,
      ProjectMetadata,
    };

    QgsMetadataWidget( QWidget *parent /TransferThis/ = 0, QgsMapLayer *layer = 0 );
%Docstring
Constructor for the wizard.

If ``layer`` is set, then this constructor automatically sets the
widget's :py:func:`~QgsMetadataWidget.metadata` to match the layer's
metadata..

.. seealso:: :py:func:`setMetadata`
%End

    void setMode( Mode mode );
%Docstring
Sets the widget's current ``mode``.

.. seealso:: :py:func:`mode`

.. versionadded:: 3.2
%End

    Mode mode() const;
%Docstring
Returns the widget's current mode.

.. seealso:: :py:func:`setMode`

.. versionadded:: 3.2
%End

    void setMetadata( const QgsAbstractMetadataBase *metadata );
%Docstring
Sets the ``metadata`` to display in the widget.

This method can be called after constructing a QgsMetadataWidget in
order to set the displayed metadata to custom, non-layer based metadata.

Calling this method will automatically
:py:func:`~QgsMetadataWidget.setMode` to the correct mode corresponding
to the specified ``metadata`` object.

.. seealso:: :py:func:`metadata`
%End

    QgsAbstractMetadataBase *metadata() /Factory/;
%Docstring
Returns a :py:class:`QgsAbstractMetadataBase` object representing the
current state of the widget.

Caller takes ownership of the returned object.

.. seealso:: :py:func:`saveMetadata`
%End

    void saveMetadata( QgsAbstractMetadataBase *metadata );
%Docstring
Save all fields in a metadata object.

.. seealso:: :py:func:`metadata`

.. seealso:: :py:func:`acceptMetadata`

.. seealso:: :py:func:`checkMetadata`
%End

    bool checkMetadata();
%Docstring
Check if values in the wizard are correct.

.. seealso:: :py:func:`saveMetadata`
%End

    void crsChanged();
%Docstring
If the CRS is updated.
%End

    void acceptMetadata();
%Docstring
Saves the metadata to the layer.
%End

    static QMap<QString, QString> parseLanguages();
%Docstring
Returns a list of languages available by default in the wizard.
%End

    static QStringList parseLicenses();
%Docstring
Returns a list of licences available by default in the wizard.
%End

    static QStringList parseLinkTypes();
%Docstring
Returns a list of link types available by default in the wizard.

.. seealso:: https://github.com/OSGeo/Cat-Interop/blob/master/LinkPropertyLookupTable.csv
%End

    static QStringList parseMimeTypes();
%Docstring
Returns a list of MIME types available by default in the wizard.

.. seealso:: https://fr.wikipedia.org/wiki/Type_MIME
%End

    static QMap<QString, QString> parseTypes();
%Docstring
Returns a list of types available by default in the wizard.
%End

    void setMapCanvas( QgsMapCanvas *canvas );
%Docstring
Sets a map ``canvas`` associated with the widget.
%End

    QString title() const;
%Docstring
Returns the current title field for the metadata.

.. seealso:: :py:func:`setTitle`

.. seealso:: :py:func:`titleChanged`

.. versionadded:: 3.2
%End

  public slots:

    void setTitle( const QString &title );
%Docstring
Sets the ``title`` field for the metadata.

.. seealso:: :py:func:`title`

.. seealso:: :py:func:`titleChanged`

.. versionadded:: 3.2
%End

  signals:

    void titleChanged( const QString &title );
%Docstring
Emitted when the ``title`` field is changed.

.. seealso:: :py:func:`title`

.. seealso:: :py:func:`setTitle`

.. versionadded:: 3.2
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsmetadatawidget.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/