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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgsstylemanagerdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsStyleManagerDialog : QDialog
{
%Docstring(signature="appended")
A dialog allowing users to customize and populate a :py:class:`QgsStyle`.
%End
%TypeHeaderCode
#include "qgsstylemanagerdialog.h"
%End
public:
QgsStyleManagerDialog( QgsStyle *style, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags flags = Qt::WindowFlags(),
bool readOnly = false );
%Docstring
Constructor for QgsStyleManagerDialog, with the specified ``parent`` widget and window ``flags``.
The ``style`` argument specifies the linked :py:class:`QgsStyle` database. Symbols and objects contained within
this style will be shown in the dialog, and changes made within the dialog will be applied to ``style``.
The ``style`` object must last for the lifetime of the dialog.
%End
static QString addColorRampStatic( QWidget *parent, QgsStyle *style,
const QString &RampType = QString() );
%Docstring
Opens the add color ramp dialog, returning the new color ramp's name if the ramp has been added.
The ``RampType`` argument should be set to a string representing a valid :py:func:`QgsColorRamp.type()` value.
%End
void setFavoritesGroupVisible( bool show );
%Docstring
Sets whether the favorites group should be shown. The default is to show the group.
.. versionadded:: 3.6
%End
void setSmartGroupsVisible( bool show );
%Docstring
Sets whether smart groups should be shown. The default is to show the groups.
.. versionadded:: 3.6
%End
void setBaseStyleName( const QString &name );
%Docstring
Sets the base ``name`` for the style, which is used by the dialog to reflect the
original style/XML file name.
``name`` should be stripped of any extensions and folder information, e.g. "transport_styles",
not "d:/stuff/transport_styles.xml".
.. versionadded:: 3.6
%End
public slots:
void activate();
%Docstring
Raises, unminimizes and activates this window
.. versionadded:: 3.4
%End
void addItem();
%Docstring
Triggers the dialog for adding a new item, based on the currently
selected item type tab.
%End
void editItem();
%Docstring
Triggers the dialog for editing the current item.
%End
void removeItem();
%Docstring
Removes the current selected item.
%End
void exportItemsSVG();
%Docstring
Triggers the dialog to export selected items as SVG files.
.. seealso:: :py:func:`exportItemsPNG`
.. seealso:: :py:func:`exportSelectedItemsImages`
%End
void exportItemsPNG();
%Docstring
Triggers the dialog to export selected items as PNG files.
.. seealso:: :py:func:`exportItemsSVG`
.. seealso:: :py:func:`exportSelectedItemsImages`
%End
void exportSelectedItemsImages( const QString &dir, const QString &format, QSize size );
%Docstring
Triggers the dialog to export selected items as images of the specified ``format`` and ``size``.
.. seealso:: :py:func:`exportItemsSVG`
.. seealso:: :py:func:`exportItemsPNG`
%End
void exportItems();
%Docstring
Triggers the dialog to export items.
.. seealso:: :py:func:`importItems`
%End
void importItems();
%Docstring
Triggers the dialog to import items.
.. seealso:: :py:func:`exportItems`
%End
void populateList();
%Docstring
Refreshes the list of items.
%End
void onFinished();
%Docstring
Called when the dialog is going to be closed.
%End
void onClose();
%Docstring
Closes the dialog
%End
void showHelp();
%Docstring
Opens the associated help
%End
void itemChanged( QStandardItem *item ) /Deprecated/;
%Docstring
.. deprecated:: QGIS 3.6
- has no effect and will be removed in QGIS 4.0
%End
void groupChanged( const QModelIndex & );
%Docstring
Triggered when the current group (or tag) is changed.
%End
void groupRenamed( QStandardItem *item );
%Docstring
Triggered when a group ``item`` is renamed.
%End
int addTag();
%Docstring
Triggers the dialog to add a new tag.
%End
int addSmartgroup();
%Docstring
Triggers the dialog to add a new smart group.
%End
void removeGroup();
%Docstring
Removes the selected tag or smartgroup.
%End
void tagSymbolsAction();
%Docstring
Toggles the interactive item tagging mode.
%End
void editSmartgroupAction();
%Docstring
Triggers the dialog for editing the selected smart group.
%End
void regrouped( QStandardItem * ) /Deprecated/;
%Docstring
.. deprecated:: QGIS 3.6
- has no effect and will be removed in QGIS 4.0
%End
void filterSymbols( const QString &filter );
%Docstring
Sets the ``filter`` string to filter symbols by.
%End
void symbolSelected( const QModelIndex & );
%Docstring
Perform symbol specific tasks when selected
%End
void selectedSymbolsChanged( const QItemSelection &selected, const QItemSelection &deselected );
%Docstring
Perform tasks when the selected symbols change
%End
void grouptreeContextMenu( QPoint );
%Docstring
Context menu for the groupTree
%End
void listitemsContextMenu( QPoint );
%Docstring
Context menu for the listItems ( symbols list )
%End
protected slots:
bool addColorRamp( const QString &type = QString() );
%Docstring
Triggers adding a new color ramp.
If ``type`` is set to a string representing a valid :py:func:`QgsColorRamp.type()` value then a new ramp
of that type will be created. If ``type`` is empty, then the user will be prompted to select
the color ramp type.
%End
void addFavoriteSelectedSymbols();
%Docstring
Add selected symbols to favorites
%End
void removeFavoriteSelectedSymbols();
%Docstring
Remove selected symbols from favorites
%End
void tagSelectedSymbols( bool newTag = false );
%Docstring
Tag selected symbols using menu item selection
%End
void detagSelectedSymbols();
%Docstring
Remove all tags from selected symbols
%End
protected:
void populateTypes() /Deprecated/;
%Docstring
Populate combo box with known style items (symbols, color ramps).
.. deprecated:: QGIS 3.6
- has no effect and will be removed in QGIS 4.0
%End
void populateGroups();
%Docstring
populate the groups
%End
void setSymbolsChecked( const QStringList & ) /Deprecated/;
%Docstring
.. deprecated:: QGIS 3.6
- has no effect and will be removed in QGIS 4.0
%End
void populateSymbols( const QStringList &symbolNames, bool checkable = false ) /Deprecated/;
%Docstring
Populates the list view with symbols of the current type with the given names.
.. deprecated::
No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
%End
void populateColorRamps( const QStringList &colorRamps, bool checkable = false ) /Deprecated/;
%Docstring
Populates the list view with color ramps of the current type with the given names.
.. deprecated::
No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
%End
int currentItemType();
QString currentItemName();
bool addSymbol( int symbolType = -1 );
%Docstring
add a new symbol to style
%End
bool editSymbol();
bool editColorRamp();
bool removeSymbol() /Deprecated/;
%Docstring
.. deprecated:: QGIS 3.6
- has no effect and will be removed in QGIS 4.0
%End
bool removeColorRamp() /Deprecated/;
%Docstring
.. deprecated:: QGIS 3.6
- has no effect and will be removed in QGIS 4.0
%End
void enableSymbolInputs( bool );
%Docstring
Enables or disbables the symbol specific inputs
%End
void enableGroupInputs( bool );
%Docstring
Enables or disables the groupTree specific inputs
%End
void enableItemsForGroupingMode( bool );
%Docstring
Enables or disables the groupTree items for grouping mode
%End
void setBold( QStandardItem * );
%Docstring
sets the text of the item with bold font
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgsstylemanagerdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|