File: qgsattributeeditorrelation.sip.in

package info (click to toggle)
qgis 3.44.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,237,544 kB
  • sloc: cpp: 1,668,420; python: 381,688; xml: 23,474; perl: 4,078; sh: 3,733; ansic: 2,799; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 155
file content (174 lines) | stat: -rw-r--r-- 4,743 bytes parent folder | download | duplicates (10)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/editform/qgsattributeeditorrelation.h                       *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsAttributeEditorRelation : QgsAttributeEditorElement
{
%Docstring(signature="appended")
This element will load a relation editor onto the form.
%End

%TypeHeaderCode
#include "qgsattributeeditorrelation.h"
%End
  public:
    static const QMetaObject staticMetaObject;

  public:

    enum Button
    {
      Link,
      Unlink,
      SaveChildEdits,
      AddChildFeature,
      DuplicateChildFeature,
      DeleteChildFeature,
      ZoomToChildFeature,
      AllButtons
    };

    typedef QFlags<QgsAttributeEditorRelation::Button> Buttons;


 QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent );
%Docstring
.. deprecated:: 3.16
%End

 QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent );
%Docstring
.. deprecated:: 3.16
%End

    QgsAttributeEditorRelation( const QString &relationId, QgsAttributeEditorElement *parent );
%Docstring
Creates a new element which embeds a relation.

:param relationId: The id of the relation to embed
:param parent: The parent (used as container)
%End

    QgsAttributeEditorRelation( const QgsRelation &relation, QgsAttributeEditorElement *parent );
%Docstring
Creates a new element which embeds a relation.

:param relation: The relation to embed
:param parent: The parent (used as container)
%End


    const QgsRelation &relation() const;
%Docstring
Gets the id of the relation which shall be embedded

:return: the id
%End

    bool init( QgsRelationManager *relManager );
%Docstring
Initializes the relation from the id

:param relManager: The relation manager to use for the initialization

:return: ``True`` if the relation was found in the relationmanager
%End

    virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/;


    bool forceSuppressFormPopup() const;
%Docstring
Determines the force suppress form popup status.

.. versionadded:: 3.16
%End

    void setForceSuppressFormPopup( bool forceSuppressFormPopup );
%Docstring
Sets force suppress form popup status to ``forceSuppressFormPopup``.
This flag is to override the layer and general settings regarding the
automatic opening of the attribute form dialog when digitizing is
completed.

.. versionadded:: 3.16
%End

    QVariant nmRelationId() const;
%Docstring
Determines the relation id of the second relation involved in an N:M
relation.

.. versionadded:: 3.16
%End

    void setNmRelationId( const QVariant &nmRelationId = QVariant() );
%Docstring
Sets ``nmRelationId`` for the relation id of the second relation
involved in an N:M relation. If it's empty, then it's considered as a
1:M relationship.

.. versionadded:: 3.16
%End

    QString label() const;
%Docstring
Determines the label of this element

.. versionadded:: 3.16
%End

    void setLabel( const QString &label = QString() );
%Docstring
Sets ``label`` for this element If it's empty it takes the relation id
as label

.. versionadded:: 3.16
%End

    QString relationWidgetTypeId() const;
%Docstring
Returns the current relation widget type id

.. versionadded:: 3.18
%End

    void setRelationWidgetTypeId( const QString &relationWidgetTypeId );
%Docstring
Sets the relation widget type

.. versionadded:: 3.18
%End

    QVariantMap relationEditorConfiguration() const;
%Docstring
Returns the relation editor widget configuration

.. versionadded:: 3.18
%End

    void setRelationEditorConfiguration( const QVariantMap &config );
%Docstring
Sets the relation editor configuration

.. versionadded:: 3.18
%End

};

QFlags<QgsAttributeEditorRelation::Button> operator|(QgsAttributeEditorRelation::Button f1, QFlags<QgsAttributeEditorRelation::Button> f2);


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