File: qgsattributeformeditorwidget.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 (129 lines) | stat: -rw-r--r-- 4,171 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsattributeformeditorwidget.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsAttributeFormEditorWidget : QgsAttributeFormWidget
{
%Docstring(signature="appended")
A widget consisting of both an editor widget and additional widgets for
controlling the behavior of the editor widget depending on a number of
possible modes. For instance, if the parent attribute form is in the
multi edit mode, this widget will show both the editor widget and a tool
button for controlling the multi edit results.
%End

%TypeHeaderCode
#include "qgsattributeformeditorwidget.h"
%End
  public:
    explicit QgsAttributeFormEditorWidget( QgsEditorWidgetWrapper *editorWidget, const QString &widgetType, QgsAttributeForm *form /TransferThis/ );
%Docstring
Constructor for QgsAttributeFormEditorWidget.

:param editorWidget: associated editor widget wrapper (for default/edit
                     modes)
:param widgetType: the type identifier of the widget passed in the
                   wrapper
:param form: parent attribute form
%End

    ~QgsAttributeFormEditorWidget();

    virtual void createSearchWidgetWrappers( const QgsAttributeEditorContext &context = QgsAttributeEditorContext() );


    void initialize( const QVariant &initialValue, bool mixedValues = false, const QVariantList &additionalFieldValues = QVariantList() );
%Docstring
Resets the widget to an initial value.

:param initialValue: initial value to show in widget
:param mixedValues: set to ``True`` to initially show the mixed values
                    state
:param additionalFieldValues: a variant map of additional field names
                              with their corresponding values
%End

    bool hasChanged() const;
%Docstring
Returns ``True`` if the widget's value has been changed since it was
initialized.

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

    QVariant currentValue() const;
%Docstring
Returns the current value of the attached editor widget.
%End

    void setConstraintStatus( const QString &constraint, const QString &description, const QString &err, QgsEditorWidgetWrapper::ConstraintResult result );
%Docstring
Set the constraint status for this widget.
%End

    void setConstraintResultVisible( bool editable );
%Docstring
Set the constraint result label visible or invisible according to the
layer editable status
%End

    QgsEditorWidgetWrapper *editorWidget() const;
%Docstring
Returns the editor widget wrapper

.. versionadded:: 3.10
%End

  public slots:

    void setIsMixed( bool mixed );
%Docstring
Sets whether the widget should be displayed in a "mixed values" mode.

:param mixed: set to ``True`` to show in a mixed values state
%End

    void changesCommitted();
%Docstring
Called when field values have been committed;
%End

  signals:

 void valueChanged( const QVariant &value );
%Docstring
Emitted when the widget's value changes

:param value: new widget value

.. deprecated:: 3.10

   Use valuesChanged instead.
%End

    void valuesChanged( const QVariant &value, const QVariantList &additionalFieldValues );
%Docstring
Emitted when the widget's value changes

:param value: new widget value
:param additionalFieldValues: of the potential additional fields

.. versionadded:: 3.10
%End

};

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