1/************************************************************************
2 * This file has been generated automatically from                      *
3 *                                                                      *
4 * src/gui/symbology/qgsstylemanagerdialog.h                            *
5 *                                                                      *
6 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
7 ************************************************************************/
8
9
10
11
12
13
14class QgsStyleManagerDialog : QDialog
15{
16%Docstring
17
18A dialog allowing users to customize and populate a QgsStyle.
19%End
20
21%TypeHeaderCode
22#include "qgsstylemanagerdialog.h"
23%End
24  public:
25
26    QgsStyleManagerDialog( QgsStyle *style, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags flags = Qt::WindowFlags(),
27                           bool readOnly = false );
28%Docstring
29Constructor for QgsStyleManagerDialog, with the specified ``parent`` widget and window ``flags``.
30
31The ``style`` argument specifies the linked QgsStyle database. Symbols and objects contained within
32this style will be shown in the dialog, and changes made within the dialog will be applied to ``style``.
33The ``style`` object must last for the lifetime of the dialog.
34%End
35
36
37    static QString addColorRampStatic( QWidget *parent, QgsStyle *style,
38                                       const QString &RampType = QString() );
39%Docstring
40Opens the add color ramp dialog, returning the new color ramp's name if the ramp has been added.
41
42The ``RampType`` argument should be set to a string representing a valid :py:func:`QgsColorRamp.type()` value.
43%End
44
45    void setFavoritesGroupVisible( bool show );
46%Docstring
47Sets whether the favorites group should be shown. The default is to show the group.
48
49.. versionadded:: 3.6
50%End
51
52    void setSmartGroupsVisible( bool show );
53%Docstring
54Sets whether smart groups should be shown. The default is to show the groups.
55
56.. versionadded:: 3.6
57%End
58
59    void setBaseStyleName( const QString &name );
60%Docstring
61Sets the base ``name`` for the style, which is used by the dialog to reflect the
62original style/XML file name.
63
64``name`` should be stripped of any extensions and folder information, e.g. "transport_styles",
65not "d:/stuff/transport_styles.xml".
66
67.. versionadded:: 3.6
68%End
69
70  public slots:
71
72
73    void activate();
74%Docstring
75Raises, unminimizes and activates this window
76
77.. versionadded:: 3.4
78%End
79
80    void addItem();
81%Docstring
82Triggers the dialog for adding a new item, based on the currently
83selected item type tab.
84%End
85
86    void editItem();
87%Docstring
88Triggers the dialog for editing the current item.
89%End
90
91    void removeItem();
92%Docstring
93Removes the current selected item.
94%End
95
96    void exportItemsSVG();
97%Docstring
98Triggers the dialog to export selected items as SVG files.
99
100.. seealso:: :py:func:`exportItemsPNG`
101
102.. seealso:: :py:func:`exportSelectedItemsImages`
103%End
104
105    void exportItemsPNG();
106%Docstring
107Triggers the dialog to export selected items as PNG files.
108
109.. seealso:: :py:func:`exportItemsSVG`
110
111.. seealso:: :py:func:`exportSelectedItemsImages`
112%End
113
114    void exportSelectedItemsImages( const QString &dir, const QString &format, QSize size );
115%Docstring
116Triggers the dialog to export selected items as images of the specified ``format`` and ``size``.
117
118.. seealso:: :py:func:`exportItemsSVG`
119
120.. seealso:: :py:func:`exportItemsPNG`
121%End
122
123    void exportItems();
124%Docstring
125Triggers the dialog to export items.
126
127.. seealso:: :py:func:`importItems`
128%End
129
130    void importItems();
131%Docstring
132Triggers the dialog to import items.
133
134.. seealso:: :py:func:`exportItems`
135%End
136
137    void populateList();
138%Docstring
139Refreshes the list of items.
140%End
141
142    void onFinished();
143%Docstring
144Called when the dialog is going to be closed.
145%End
146
147    void onClose();
148%Docstring
149Closes the dialog
150%End
151
152    void showHelp();
153%Docstring
154Opens the associated help
155%End
156
157 void itemChanged( QStandardItem *item ) /Deprecated/;
158%Docstring
159
160.. deprecated:: QGIS 3.6
161   - has no effect and will be removed in QGIS 4.0
162%End
163
164    void groupChanged( const QModelIndex & );
165%Docstring
166Triggered when the current group (or tag) is changed.
167%End
168
169    void groupRenamed( QStandardItem *item );
170%Docstring
171Triggered when a group ``item`` is renamed.
172%End
173
174    int addTag();
175%Docstring
176Triggers the dialog to add a new tag.
177%End
178
179    int addSmartgroup();
180%Docstring
181Triggers the dialog to add a new smart group.
182%End
183
184    void removeGroup();
185%Docstring
186Removes the selected tag or smartgroup.
187%End
188
189    void tagSymbolsAction();
190%Docstring
191Toggles the interactive item tagging mode.
192%End
193
194    void editSmartgroupAction();
195%Docstring
196Triggers the dialog for editing the selected smart group.
197%End
198
199 void regrouped( QStandardItem * ) /Deprecated/;
200%Docstring
201
202.. deprecated:: QGIS 3.6
203   - has no effect and will be removed in QGIS 4.0
204%End
205
206    void filterSymbols( const QString &filter );
207%Docstring
208Sets the ``filter`` string to filter symbols by.
209%End
210
211    void symbolSelected( const QModelIndex & );
212%Docstring
213Perform symbol specific tasks when selected
214%End
215
216    void selectedSymbolsChanged( const QItemSelection &selected, const QItemSelection &deselected );
217%Docstring
218Perform tasks when the selected symbols change
219%End
220
221    void grouptreeContextMenu( QPoint );
222%Docstring
223Context menu for the groupTree
224%End
225
226    void listitemsContextMenu( QPoint );
227%Docstring
228Context menu for the listItems ( symbols list )
229%End
230
231  protected slots:
232
233    bool addColorRamp( const QString &type = QString() );
234%Docstring
235Triggers adding a new color ramp.
236
237If ``type`` is set to a string representing a valid :py:func:`QgsColorRamp.type()` value then a new ramp
238of that type will be created. If ``type`` is empty, then the user will be prompted to select
239the color ramp type.
240%End
241
242    void addFavoriteSelectedSymbols();
243%Docstring
244Add selected symbols to favorites
245%End
246    void removeFavoriteSelectedSymbols();
247%Docstring
248Remove selected symbols from favorites
249%End
250    void tagSelectedSymbols( bool newTag = false );
251%Docstring
252Tag selected symbols using menu item selection
253%End
254    void detagSelectedSymbols();
255%Docstring
256Remove all tags from selected symbols
257%End
258
259  protected:
260
261 void populateTypes() /Deprecated/;
262%Docstring
263Populate combo box with known style items (symbols, color ramps).
264
265.. deprecated:: QGIS 3.6
266   - has no effect and will be removed in QGIS 4.0
267%End
268
269    void populateGroups();
270%Docstring
271populate the groups
272%End
273
274 void setSymbolsChecked( const QStringList & ) /Deprecated/;
275%Docstring
276
277.. deprecated:: QGIS 3.6
278   - has no effect and will be removed in QGIS 4.0
279%End
280
281 void populateSymbols( const QStringList &symbolNames, bool checkable = false ) /Deprecated/;
282%Docstring
283Populates the list view with symbols of the current type with the given names.
284
285.. deprecated::
286   No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
287%End
288
289 void populateColorRamps( const QStringList &colorRamps, bool checkable = false ) /Deprecated/;
290%Docstring
291Populates the list view with color ramps of the current type with the given names.
292
293.. deprecated::
294   No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
295%End
296
297    int currentItemType();
298    QString currentItemName();
299
300    bool addSymbol( int symbolType = -1 );
301%Docstring
302add a new symbol to style
303%End
304
305    bool editSymbol();
306    bool editColorRamp();
307
308 bool removeSymbol() /Deprecated/;
309%Docstring
310
311.. deprecated:: QGIS 3.6
312   - has no effect and will be removed in QGIS 4.0
313%End
314
315 bool removeColorRamp() /Deprecated/;
316%Docstring
317
318.. deprecated:: QGIS 3.6
319   - has no effect and will be removed in QGIS 4.0
320%End
321
322    void enableSymbolInputs( bool );
323%Docstring
324Enables or disbables the symbol specific inputs
325%End
326    void enableGroupInputs( bool );
327%Docstring
328Enables or disables the groupTree specific inputs
329%End
330    void enableItemsForGroupingMode( bool );
331%Docstring
332Enables or disables the groupTree items for grouping mode
333%End
334
335    void setBold( QStandardItem * );
336%Docstring
337sets the text of the item with bold font
338%End
339
340};
341
342/************************************************************************
343 * This file has been generated automatically from                      *
344 *                                                                      *
345 * src/gui/symbology/qgsstylemanagerdialog.h                            *
346 *                                                                      *
347 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
348 ************************************************************************/
349