File: qgseffectstackpropertieswidget.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; 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: 154
file content (251 lines) | stat: -rw-r--r-- 6,512 bytes parent folder | download | duplicates (14)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/effects/qgseffectstackpropertieswidget.h                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsEffectStackPropertiesWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A widget for modifying the properties of a :py:class:`QgsEffectStack`,
including adding and reordering effects within the stack.

.. seealso:: :py:class:`QgsEffectStack`

.. seealso:: :py:class:`QgsEffectStackPropertiesDialog`

.. seealso:: :py:class:`QgsEffectStackCompactWidget`
%End

%TypeHeaderCode
#include "qgseffectstackpropertieswidget.h"
%End
  public:
    QgsEffectStackPropertiesWidget( QgsEffectStack *stack, QWidget *parent /TransferThis/ = 0 );
%Docstring
QgsEffectStackPropertiesWidget constructor

:param stack: :py:class:`QgsEffectStack` to modify in the widget
:param parent: parent widget
%End

    ~QgsEffectStackPropertiesWidget();

    QgsEffectStack *stack();
%Docstring
Returns effect stack attached to the widget

:return: :py:class:`QgsEffectStack` modified by the widget
%End

    void setPreviewPicture( const QPicture &picture );
%Docstring
Sets the picture to use for effect previews for the dialog

:param picture: preview picture
%End

  public slots:

    void moveEffectDown();
%Docstring
Moves the currently selected effect down in the stack.
%End

    void moveEffectUp();
%Docstring
Moves the currently selected effect up in the stack.
%End

    void addEffect();
%Docstring
Adds a new effect to the stack.
%End

    void removeEffect();
%Docstring
Removes the currently selected effect from the stack.
%End

    void effectChanged();
%Docstring
Updates the widget when the selected effect changes type.
%End

    void updatePreview();
%Docstring
Updates the effect preview icon.
%End

    void changeEffect( QgsPaintEffect *newEffect );
%Docstring
Updates the effect stack when the currently selected effect changes
properties.

:param newEffect: new effect to replace existing effect at selected
                  position within the stack.
%End

  protected:

    void loadStack();
%Docstring
Refreshes the widget to reflect the current state of the stack.
%End

    void loadStack( QgsEffectStack *stack );
%Docstring
Refreshes the widget to reflect the current state of a specified stack.

:param stack: :py:class:`QgsEffectStack` for widget
%End

    void updateUi();
%Docstring
Enables or disables widgets depending on the selected effect within the
stack.
%End


    void moveEffectByOffset( int offset );
%Docstring
Moves the currently selected effect within the stack by a specified
offset
%End

    void setWidget( QWidget *widget );
%Docstring
Sets the effect properties widget
%End
};



class QgsEffectStackPropertiesDialog : QgsDialog
{
%Docstring(signature="appended")
A dialog for modifying the properties of a :py:class:`QgsEffectStack`,
including adding and reordering effects within the stack.

.. seealso:: :py:class:`QgsEffectStack`

.. seealso:: :py:class:`QgsEffectStackPropertiesWidget`

.. seealso:: :py:class:`QgsEffectStackCompactWidget`
%End

%TypeHeaderCode
#include "qgseffectstackpropertieswidget.h"
%End
  public:
    QgsEffectStackPropertiesDialog( QgsEffectStack *stack, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags f = Qt::WindowFlags() );
%Docstring
QgsEffectStackPropertiesDialog constructor

:param stack: :py:class:`QgsEffectStack` to modify in the dialog
:param parent: parent widget
:param f: window flags
%End

    QgsEffectStack *stack();
%Docstring
Returns effect stack attached to the dialog

:return: :py:class:`QgsEffectStack` modified by the dialog
%End

    void setPreviewPicture( const QPicture &picture );
%Docstring
Sets the picture to use for effect previews for the dialog

:param picture: preview picture
%End

  protected:

};



class QgsEffectStackCompactWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A small widget consisting of a checkbox for enabling/disabling an effect
stack and a button for opening an effect stack customization dialog.

.. seealso:: :py:class:`QgsEffectStack`

.. seealso:: :py:class:`QgsEffectStackPropertiesWidget`

.. seealso:: :py:class:`QgsEffectStackPropertiesDialog`
%End

%TypeHeaderCode
#include "qgseffectstackpropertieswidget.h"
%End
  public:
    QgsEffectStackCompactWidget( QWidget *parent /TransferThis/ = 0, QgsPaintEffect *effect = 0 );
%Docstring
QgsEffectStackCompactWidget constructor

:param parent: parent widget
:param effect: :py:class:`QgsPaintEffect` for modification by the
               widget. If the effect is not a
               :py:class:`QgsEffectStack`, it will be automatically
               converted to an effect stack consisting of the original
               effect
%End
    ~QgsEffectStackCompactWidget();

    void setPaintEffect( QgsPaintEffect *effect );
%Docstring
Sets paint effect attached to the widget,

:param effect: :py:class:`QgsPaintEffect` for modification by the
               widget. If the effect is not a
               :py:class:`QgsEffectStack`, it will be automatically
               converted to an effect stack consisting of the original
               effect

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

    QgsPaintEffect *paintEffect() const;
%Docstring
Returns paint effect attached to the widget

:return: :py:class:`QgsPaintEffect` modified by the widget

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

    void setPreviewPicture( const QPicture &picture );
%Docstring
Sets the picture to use for effect previews for the dialog

:param picture: preview picture
%End

  signals:

    void changed();
%Docstring
Emitted when the paint effect properties change
%End

};

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