File: qgsrelationeditorwidget.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (203 lines) | stat: -rw-r--r-- 4,921 bytes parent folder | download
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
191
192
193
194
195
196
197
198
199
200
201
202
203
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsrelationeditorwidget.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






%ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsrelationeditorwidget.h>
%End




class QgsRelationEditorWidget : QgsAbstractRelationEditorWidget
{
%Docstring(signature="appended")
The default relation widget in QGIS.

.. versionadded:: 3.18
%End

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

    enum Button
    {
      NoButton,
      Link,
      Unlink,
      SaveChildEdits,
      AddChildFeature,
      DuplicateChildFeature,
      DeleteChildFeature,
      ZoomToChildFeature,
      AllButtons
    };
    typedef QFlags<QgsRelationEditorWidget::Button> Buttons;


    QgsRelationEditorWidget( const QVariantMap &config, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor

:param config: widget configuration
:param parent: parent widget
%End

    void setViewMode( QgsDualView::ViewMode mode );
%Docstring
Define the view mode for the dual view
%End

    QgsDualView::ViewMode viewMode();
%Docstring
Gets the view mode for the dual view
%End

    QgsIFeatureSelectionManager *featureSelectionManager();
%Docstring
The feature selection manager is responsible for the selected features
which are currently being edited.
%End

    virtual void setEditorContext( const QgsAttributeEditorContext &context );

%Docstring
Sets the editor ``context``

.. note::

   if context cadDockWidget is null, it won't be possible to digitize
   the geometry of a referencing feature from this widget
%End

    void setVisibleButtons( const Buttons &buttons );
%Docstring
Defines the buttons which are shown
%End

    Buttons visibleButtons() const;
%Docstring
Returns the buttons which are shown
%End

 void duplicateFeature() /Deprecated/;
%Docstring
Duplicates a feature

.. deprecated:: QGIS 3.18
  use :py:func:`~QgsRelationEditorWidget.duplicateSelectedFeatures` instead
%End

    void duplicateSelectedFeatures();
%Docstring
Duplicates the selected features

.. versionadded:: 3.18
%End

    void unlinkSelectedFeatures();
%Docstring
Unlinks the selected features from the relation
%End

    void deleteSelectedFeatures();
%Docstring
Deletes the currently selected features
%End

    void zoomToSelectedFeatures();
%Docstring
Zooms to the selected features
%End

    virtual QVariantMap config() const;

%Docstring
Returns the current configuration
%End

    virtual void setConfig( const QVariantMap &config );

%Docstring
Defines the current configuration
%End

  public slots:
    virtual void parentFormValueChanged( const QString &attribute, const QVariant &newValue );


  protected:
    virtual void updateUi();
    virtual void beforeSetRelationFeature( const QgsRelation &newRelation, const QgsFeature &newFeature );

    virtual void afterSetRelationFeature();

    virtual void beforeSetRelations( const QgsRelation &newRelation, const QgsRelation &newNmRelation );

    virtual void afterSetRelations();


};


class QgsRelationEditorConfigWidget : QgsAbstractRelationEditorConfigWidget
{
%Docstring(signature="appended")
Creates a new configuration widget for the relation editor widget

.. versionadded:: 3.18
%End

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

    explicit QgsRelationEditorConfigWidget( const QgsRelation &relation, QWidget *parent /TransferThis/ );
%Docstring
Create a new configuration widget

:param relation: The relation for which the configuration dialog will be created
:param parent: A parent widget
%End

    QVariantMap config();
%Docstring
Create a configuration from the current GUI state

:return: A widget configuration
%End

    void setConfig( const QVariantMap &config );
%Docstring
Update the configuration widget to represent the given configuration.

:param config: The configuration which should be represented by this widget
%End

};




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