File: qgslayerpropertiesdialog.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 (186 lines) | stat: -rw-r--r-- 4,804 bytes parent folder | download | duplicates (12)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgslayerpropertiesdialog.h                                   *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsLayerPropertiesDialog : QgsOptionsDialogBase /Abstract/
{
%Docstring(signature="appended")
Base class for "layer properties" dialogs, containing common utilities
for handling functionality in these dialog.

.. warning::

   This is exposed to SIP bindings for legacy reasons only, and is NOT to be considered as stable API.

.. versionadded:: 3.34
%End

%TypeHeaderCode
#include "qgslayerpropertiesdialog.h"
%End
  public:

    QgsLayerPropertiesDialog( QgsMapLayer *layer, QgsMapCanvas *canvas, const QString &settingsKey, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = Qt::WindowFlags(), QgsSettings *settings = 0 );
%Docstring
Constructor for QgsLayerPropertiesDialog.

:param layer: associated map layer
:param canvas: associated map canvas
:param settingsKey: :py:class:`QgsSettings` subgroup key for
                    saving/restore ui states, e.g.
                    "VectorLayerProperties".
:param parent: parent object (owner)
:param fl: widget flags
:param settings: custom :py:class:`QgsSettings` pointer
%End

    void setMetadataWidget( QgsMetadataWidget *widget, QWidget *page );
%Docstring
Sets the metadata ``widget`` and ``page`` associated with the dialog.

This must be called in order for the standard metadata loading/saving
functionality to be available.
%End

    virtual void addPropertiesPageFactory( const QgsMapLayerConfigWidgetFactory *factory );
%Docstring
Adds properties page from a ``factory``.
%End

    void saveDefaultStyle();
%Docstring
Saves the default style when appropriate button is pressed

.. versionadded:: 3.30
%End

    void loadStyle();
%Docstring
Triggers a dialog to load a saved style

.. versionadded:: 3.30
%End

    void saveStyleAs();
%Docstring
Saves a style when appriate button is pressed

.. versionadded:: 3.30
%End

  public slots:

    void loadMetadataFromFile();
%Docstring
Allows the user to load layer metadata from a file.

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

    void saveMetadataToFile();
%Docstring
Allows the user to save the layer's metadata as a file.

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

    void saveMetadataAsDefault();
%Docstring
Saves the current layer metadata as the default for the layer.

:py:func:`~QgsLayerPropertiesDialog.loadDefaultMetadata`
%End

    void loadDefaultMetadata();
%Docstring
Reloads the default layer metadata for the layer.

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

    void loadStyleFromFile();
%Docstring
Allows the user to load layer style from a file.

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

    void saveStyleToFile();
%Docstring
Allows the user to save the layer's style to a file.

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

    void saveStyleAsDefault();
%Docstring
Saves the current layer style as the default for the layer.

:py:func:`~QgsLayerPropertiesDialog.loadDefaultStyle`
%End

    void loadDefaultStyle();
%Docstring
Reloads the default style for the layer.
%End

  protected:
    void initialize();
%Docstring
Initialize the dialog. Must be called in the subclass constructor as the
final call.
%End

    void refocusDialog();
%Docstring
Ensures the dialog is focused and activated.
%End

    void storeCurrentStyleForUndo();
%Docstring
Stores the current layer style so that undo operations can be performed.
%End






  protected slots:



    virtual void rollback();
%Docstring
Rolls back changes made to the layer.
%End

    virtual void optionsStackedWidget_CurrentChanged( int index );


    void openUrl( const QUrl &url );
%Docstring
Handles opening a ``url`` from the dialog.

If the ``url`` refers to a local file then a file explorer will be
opened pointing to the file. If it refers to a remote link then a web
browser will be opened instead.
%End

};

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