File: qgsrulebasedrendererwidget.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 (268 lines) | stat: -rw-r--r-- 7,210 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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/symbology/qgsrulebasedrendererwidget.h                       *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/







class QgsRuleBasedRendererModel : QAbstractItemModel
{
%Docstring(signature="appended")
Tree model for the rules:

(invalid)  == root node
+--- top level rule
+--- top level rule
%End

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

    QgsRuleBasedRendererModel( QgsRuleBasedRenderer *renderer, QObject *parent );
%Docstring
Constructor for QgsRuleBasedRendererModel, for the specified ``renderer``.
%End

    virtual Qt::ItemFlags flags( const QModelIndex &index ) const;

    virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const;

     virtual QVariant headerData( int section, Qt::Orientation orientation,
                         int role = Qt::DisplayRole ) const;
    virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;

    virtual int columnCount( const QModelIndex & = QModelIndex() ) const;

    virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;

    virtual QModelIndex parent( const QModelIndex &index ) const;


    virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole );


    virtual Qt::DropActions supportedDropActions() const;

    virtual QStringList mimeTypes() const;

    virtual QMimeData *mimeData( const QModelIndexList &indexes ) const;

    virtual bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent );


    virtual bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() );



    QgsRuleBasedRenderer::Rule *ruleForIndex( const QModelIndex &index ) const;

    void insertRule( const QModelIndex &parent, int before, QgsRuleBasedRenderer::Rule *newrule );
    void updateRule( const QModelIndex &parent, int row );
    void updateRule( const QModelIndex &index );
    void removeRule( const QModelIndex &index );

    void setSymbol( const QModelIndex &index, QgsSymbol *symbol /Transfer/ );
%Docstring
Sets the ``symbol`` for the rule at the specified ``index``. Ownership of the symbols is
transferred to the renderer.

.. versionadded:: 3.10
%End

    void willAddRules( const QModelIndex &parent, int count ); // call beginInsertRows
    void finishedAddingRules(); // call endInsertRows

    void clearFeatureCounts();

  protected:
};




class QgsRuleBasedRendererWidget : QgsRendererWidget
{

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

    static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/;

    QgsRuleBasedRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer );
    ~QgsRuleBasedRendererWidget();

    virtual QgsFeatureRenderer *renderer();

    virtual void setDockMode( bool dockMode );


  public slots:

    void addRule();
    void editRule();
    void editRule( const QModelIndex &index );
    void removeRule();
    void countFeatures();
    void clearFeatureCounts();

    void refineRuleScales();
    void refineRuleCategories();
    void refineRuleRanges();

    void setRenderingOrder();

    void currentRuleChanged( const QModelIndex &current = QModelIndex(), const QModelIndex &previous = QModelIndex() );
    void selectedRulesChanged();

    void saveSectionWidth( int section, int oldSize, int newSize );
    void restoreSectionWidths();

  protected:
    void refineRule( int type );
    void refineRuleCategoriesGui();
%Docstring
Opens the dialog for refining a rule using categories
%End
    void refineRuleRangesGui();
%Docstring
Opens the dialog for refining a rule using ranges
%End
    void refineRuleScalesGui( const QModelIndexList &index );

    virtual void setSymbolLevels( const QList< QgsLegendSymbolItem > &levels, bool enabled );


    QgsRuleBasedRenderer::Rule *currentRule();

    virtual QList<QgsSymbol *> selectedSymbols();

    QgsRuleBasedRenderer::RuleList selectedRules();
    virtual void refreshSymbolView();

    virtual void keyPressEvent( QKeyEvent *event );





  protected slots:
    virtual void copy();

    virtual void paste();

    virtual void pasteSymbolToSelection();


};




class QgsRendererRulePropsWidget : QgsPanelWidget
{

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

    QgsRendererRulePropsWidget( QgsRuleBasedRenderer::Rule *rule,
                                QgsVectorLayer *layer,
                                QgsStyle *style,
                                QWidget *parent /TransferThis/ = 0,
                                const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() );
%Docstring
Widget to edit the details of a rule based renderer rule.

:param rule: The rule to edit.
:param layer: The layer used to pull layer related information.
:param style: The active QGIS style.
:param parent: The parent widget.
:param context: the symbol widget context
%End

    QgsRuleBasedRenderer::Rule *rule();
%Docstring
Returns the current set rule.

:return: The current rule.
%End

  public slots:

    void testFilter();
%Docstring
Test the filter that is set in the widget
%End

    void buildExpression();
%Docstring
Open the expression builder widget to check if the
%End

    void apply();
%Docstring
Apply any changes from the widget to the set rule.
%End

    virtual void setDockMode( bool dockMode );

%Docstring
Set the widget in dock mode.

:param dockMode: ``True`` for dock mode.
%End

  protected:


};

class QgsRendererRulePropsDialog : QDialog
{

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

    QgsRendererRulePropsDialog( QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent /TransferThis/ = 0, const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() );
%Docstring
Constructor for QgsRendererRulePropsDialog

:param rule: associated rule based renderer rule
:param layer: source vector layer
:param style: style collection
:param parent: parent widget
:param context: symbol widget context
%End

    QgsRuleBasedRenderer::Rule *rule();

  public slots:
    void testFilter();
    void buildExpression();
    virtual void accept();


};


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