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



class QgsFieldConditionalFormatWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A widget for customizing conditional formatting options.

.. versionadded:: 2.12
%End

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

    explicit QgsFieldConditionalFormatWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsFieldConditionalFormatWidget.
%End

 void viewRules() /Deprecated/;
%Docstring
Switches the widget to the rules page.

.. deprecated::
   no longer used, will be removed in QGIS 4.0
%End

    void setLayer( QgsVectorLayer *layer );
%Docstring
Sets the vector ``layer`` associated with the widget.
%End


    void editStyle( int index, const QgsConditionalStyle &style );
%Docstring
Switches the widget to the edit style mode for the specified style,
where ``index`` is the index of the conditional style to edit
and ``style`` is the initial definition of the style.
%End

 void loadStyle( const QgsConditionalStyle &style ) /Deprecated/;
%Docstring

.. deprecated::
   no longer used, use :py:class:`QgsEditConditionalFormatRuleWidget`.loadStyle instead.
%End

 void reset() /Deprecated/;
%Docstring
Resets the formatting options to their default state.

.. deprecated::
   no longer used, will be removed in QGIS 4.0
%End

    void setPresets( const QList<QgsConditionalStyle> &styles );
%Docstring
Sets the preset ``styles`` that can be used for quick pick.
%End

    static QList<QgsConditionalStyle> defaultPresets();
%Docstring
Returns a list of the default presets. Normally used when the widget is
created, however calling :py:func:`~QgsFieldConditionalFormatWidget.setPresets` will override the default styles.
%End

  signals:

    void rulesUpdated( const QString &fieldName );
%Docstring
Emitted when the conditional styling rules are updated.

The ``fieldName`` argument indicates the name of the field whose rules
have been modified, or an empty ``fieldName`` indicates that a row-based
rule was updated.
%End

};

class QgsEditConditionalFormatRuleWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A widget for customizing an individual conditional formatting rule.

.. versionadded:: 3.10
%End

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

    explicit QgsEditConditionalFormatRuleWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for :py:class:`QgsFieldConditionalFormatWidget`, with the specified ``parent`` widget.
%End

    void setLayer( QgsVectorLayer *layer );
%Docstring
Sets the vector ``layer`` associated with the widget.
%End

    void setPresets( const QList<QgsConditionalStyle> &styles );
%Docstring
Sets the preset ``styles`` that can be used for quick pick.
%End

    void loadStyle( const QgsConditionalStyle &style );
%Docstring
Sets the widget to match the settings from the specified ``style``.

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

    QgsConditionalStyle currentStyle() const;
%Docstring
Returns the current style defined by the widget.

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

    void setRule( const QString &rule );
%Docstring
Sets the current expression ``rule`` to show in the widget.
%End

  signals:

    void ruleSaved();
%Docstring
Emitted when a user has opted to save the current rule.
%End

    void ruleDeleted();
%Docstring
Emitted when a user has opted to deleted the current rule.
%End

    void canceled();
%Docstring
Emitted when a user has opted to cancel the rule modification.
%End

};

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