QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
A dialog allowing users to customize and populate a QgsStyle. More...
#include <qgsstylemanagerdialog.h>
Public Slots | |
void | activate () |
Raises, unminimizes and activates this window. More... | |
void | addItem () |
Triggers the dialog for adding a new item, based on the currently selected item type tab. More... | |
int | addSmartgroup () |
Triggers the dialog to add a new smart group. More... | |
int | addTag () |
Triggers the dialog to add a new tag. More... | |
void | editItem () |
Triggers the dialog for editing the current item. More... | |
void | editSmartgroupAction () |
Triggers the dialog for editing the selected smart group. More... | |
void | exportItems () |
Triggers the dialog to export items. More... | |
void | exportItemsPNG () |
Triggers the dialog to export selected items as PNG files. More... | |
void | exportItemsSVG () |
Triggers the dialog to export selected items as SVG files. More... | |
void | exportSelectedItemsImages (const QString &dir, const QString &format, QSize size) |
Triggers the dialog to export selected items as images of the specified format and size. More... | |
void | filterSymbols (const QString &filter) |
Sets the filter string to filter symbols by. More... | |
void | groupChanged (const QModelIndex &) |
Triggered when the current group (or tag) is changed. More... | |
void | groupRenamed (QStandardItem *item) |
Triggered when a group item is renamed. More... | |
void | grouptreeContextMenu (QPoint) |
Context menu for the groupTree. More... | |
void | importItems () |
Triggers the dialog to import items. More... | |
Q_DECL_DEPRECATED void | itemChanged (QStandardItem *item) SIP_DEPRECATED |
void | listitemsContextMenu (QPoint) |
Context menu for the listItems ( symbols list ) More... | |
void | onClose () |
Closes the dialog. More... | |
void | onFinished () |
Called when the dialog is going to be closed. More... | |
void | populateList () |
Refreshes the list of items. More... | |
Q_DECL_DEPRECATED void | regrouped (QStandardItem *) SIP_DEPRECATED |
void | removeGroup () |
Removes the selected tag or smartgroup. More... | |
void | removeItem () |
Removes the current selected item. More... | |
void | selectedSymbolsChanged (const QItemSelection &selected, const QItemSelection &deselected) |
Perform tasks when the selected symbols change. More... | |
void | showHelp () |
Opens the associated help. More... | |
void | symbolSelected (const QModelIndex &) |
Perform symbol specific tasks when selected. More... | |
void | tagSymbolsAction () |
Toggles the interactive item tagging mode. More... | |
Public Member Functions | |
QgsStyleManagerDialog (QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS=nullptr, Qt::WindowFlags flags=Qt::WindowFlags(), bool readOnly=false) | |
Constructor for QgsStyleManagerDialog, with the specified parent widget and window flags. More... | |
void | setBaseStyleName (const QString &name) |
Sets the base name for the style, which is used by the dialog to reflect the original style/XML file name. More... | |
void | setFavoritesGroupVisible (bool show) |
Sets whether the favorites group should be shown. More... | |
void | setSmartGroupsVisible (bool show) |
Sets whether smart groups should be shown. More... | |
Static Public Member Functions | |
static QString | addColorRampStatic (QWidget *parent, QgsStyle *style, const QString &RampType=QString()) |
Opens the add color ramp dialog, returning the new color ramp's name if the ramp has been added. More... | |
Protected Slots | |
bool | addColorRamp (const QString &type=QString()) |
Triggers adding a new color ramp. More... | |
void | addFavoriteSelectedSymbols () |
Add selected symbols to favorites. More... | |
void | detagSelectedSymbols () |
Remove all tags from selected symbols. More... | |
void | removeFavoriteSelectedSymbols () |
Remove selected symbols from favorites. More... | |
void | tagSelectedSymbols (bool newTag=false) |
Tag selected symbols using menu item selection. More... | |
Protected Member Functions | |
bool | addSymbol (int symbolType=-1) |
add a new symbol to style More... | |
QString | currentItemName () |
int | currentItemType () |
bool | editColorRamp () |
bool | editSymbol () |
void | enableGroupInputs (bool) |
Enables or disables the groupTree specific inputs. More... | |
void | enableItemsForGroupingMode (bool) |
Enables or disables the groupTree items for grouping mode. More... | |
void | enableSymbolInputs (bool) |
Enables or disbables the symbol specific inputs. More... | |
Q_DECL_DEPRECATED void | populateColorRamps (const QStringList &colorRamps, bool checkable=false) SIP_DEPRECATED |
Populates the list view with color ramps of the current type with the given names. More... | |
void | populateGroups () |
populate the groups More... | |
Q_DECL_DEPRECATED void | populateSymbols (const QStringList &symbolNames, bool checkable=false) SIP_DEPRECATED |
Populates the list view with symbols of the current type with the given names. More... | |
Q_DECL_DEPRECATED void | populateTypes () SIP_DEPRECATED |
Populate combo box with known style items (symbols, color ramps). More... | |
Q_DECL_DEPRECATED bool | removeColorRamp () SIP_DEPRECATED |
Q_DECL_DEPRECATED bool | removeSymbol () SIP_DEPRECATED |
void | setBold (QStandardItem *) |
sets the text of the item with bold font More... | |
Q_DECL_DEPRECATED void | setSymbolsChecked (const QStringList &) SIP_DEPRECATED |
Friends | |
class | QgsStyleExportImportDialog |
A dialog allowing users to customize and populate a QgsStyle.
Definition at line 67 of file qgsstylemanagerdialog.h.
QgsStyleManagerDialog::QgsStyleManagerDialog | ( | QgsStyle * | style, |
QWidget *parent | SIP_TRANSFERTHIS = nullptr , |
||
Qt::WindowFlags | flags = Qt::WindowFlags() , |
||
bool | readOnly = false |
||
) |
Constructor for QgsStyleManagerDialog, with the specified parent widget and window flags.
The style argument specifies the linked 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.
Definition at line 171 of file qgsstylemanagerdialog.cpp.
|
slot |
Raises, unminimizes and activates this window.
Definition at line 1559 of file qgsstylemanagerdialog.cpp.
|
protectedslot |
Triggers adding a new color ramp.
If type is set to a string representing a valid 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.
Definition at line 1566 of file qgsstylemanagerdialog.cpp.
|
static |
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 QgsColorRamp::type() value.
Definition at line 1390 of file qgsstylemanagerdialog.cpp.
|
protectedslot |
Add selected symbols to favorites.
Definition at line 2701 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog for adding a new item, based on the currently selected item type tab.
Definition at line 1245 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to add a new smart group.
Definition at line 2396 of file qgsstylemanagerdialog.cpp.
|
protected |
add a new symbol to style
Definition at line 1286 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to add a new tag.
Definition at line 2346 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 1236 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 1211 of file qgsstylemanagerdialog.cpp.
|
protectedslot |
Remove all tags from selected symbols.
Definition at line 2748 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 1635 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog for editing the current item.
Definition at line 1580 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog for editing the selected smart group.
Definition at line 2762 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 1612 of file qgsstylemanagerdialog.cpp.
|
protected |
Enables or disables the groupTree specific inputs.
Definition at line 2597 of file qgsstylemanagerdialog.cpp.
|
protected |
Enables or disables the groupTree items for grouping mode.
Definition at line 2603 of file qgsstylemanagerdialog.cpp.
|
protected |
Enables or disbables the symbol specific inputs.
Definition at line 2585 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to export items.
Definition at line 2172 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to export selected items as PNG files.
Definition at line 2135 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to export selected items as SVG files.
Definition at line 2144 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to export selected items as images of the specified format and size.
Definition at line 2154 of file qgsstylemanagerdialog.cpp.
|
slot |
Sets the filter string to filter symbols by.
Definition at line 2557 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggered when the current group (or tag) is changed.
Definition at line 2260 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggered when a group item is renamed.
Definition at line 2470 of file qgsstylemanagerdialog.cpp.
|
slot |
Context menu for the groupTree.
Definition at line 2635 of file qgsstylemanagerdialog.cpp.
|
slot |
Triggers the dialog to import items.
Definition at line 2178 of file qgsstylemanagerdialog.cpp.
|
slot |
Definition at line 2131 of file qgsstylemanagerdialog.cpp.
|
slot |
Context menu for the listItems ( symbols list )
Definition at line 2644 of file qgsstylemanagerdialog.cpp.
|
slot |
Closes the dialog.
Definition at line 2801 of file qgsstylemanagerdialog.cpp.
|
slot |
Called when the dialog is going to be closed.
Definition at line 522 of file qgsstylemanagerdialog.cpp.
|
protected |
Populates the list view with color ramps of the current type with the given names.
Definition at line 1207 of file qgsstylemanagerdialog.cpp.
|
protected |
populate the groups
Definition at line 2193 of file qgsstylemanagerdialog.cpp.
|
slot |
Refreshes the list of items.
Definition at line 1198 of file qgsstylemanagerdialog.cpp.
|
protected |
Populates the list view with symbols of the current type with the given names.
Definition at line 1203 of file qgsstylemanagerdialog.cpp.
|
protected |
Populate combo box with known style items (symbols, color ramps).
Definition at line 533 of file qgsstylemanagerdialog.cpp.
|
slot |
Definition at line 2549 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 2126 of file qgsstylemanagerdialog.cpp.
|
protectedslot |
Remove selected symbols from favorites.
Definition at line 2710 of file qgsstylemanagerdialog.cpp.
|
slot |
Removes the selected tag or smartgroup.
Definition at line 2434 of file qgsstylemanagerdialog.cpp.
|
slot |
Removes the current selected item.
Definition at line 2044 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 2121 of file qgsstylemanagerdialog.cpp.
|
slot |
Perform tasks when the selected symbols change.
Definition at line 2567 of file qgsstylemanagerdialog.cpp.
void QgsStyleManagerDialog::setBaseStyleName | ( | const QString & | name | ) |
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".
Definition at line 1554 of file qgsstylemanagerdialog.cpp.
|
protected |
sets the text of the item with bold font
Definition at line 2186 of file qgsstylemanagerdialog.cpp.
void QgsStyleManagerDialog::setFavoritesGroupVisible | ( | bool | show | ) |
Sets whether the favorites group should be shown.
The default is to show the group.
Definition at line 1542 of file qgsstylemanagerdialog.cpp.
void QgsStyleManagerDialog::setSmartGroupsVisible | ( | bool | show | ) |
Sets whether smart groups should be shown.
The default is to show the groups.
Definition at line 1548 of file qgsstylemanagerdialog.cpp.
|
protected |
Definition at line 2553 of file qgsstylemanagerdialog.cpp.
|
slot |
Opens the associated help.
Definition at line 2806 of file qgsstylemanagerdialog.cpp.
|
slot |
Perform symbol specific tasks when selected.
Definition at line 2562 of file qgsstylemanagerdialog.cpp.
|
protectedslot |
Tag selected symbols using menu item selection.
Definition at line 2719 of file qgsstylemanagerdialog.cpp.
|
slot |
Toggles the interactive item tagging mode.
Definition at line 2487 of file qgsstylemanagerdialog.cpp.
|
friend |
Definition at line 444 of file qgsstylemanagerdialog.h.