QgsStyleManagerDialog class

A dialog allowing users to customize and populate a QgsStyle.

Reference

Public static functions

static auto addColorRampStatic(QWidget* parent, QgsStyle* style, QString RampType = QString()) -> QString: Opens the add color ramp dialog, returning the new color ramp's name if the ramp has been added.

Constructors, destructors, conversion operators

QgsStyleManagerDialog(QgsStyle* style, QWidget*parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags()): Constructor for QgsStyleManagerDialog, with the specified parent widget and window flags.

Public slots

void activate(): Raises, unminimizes and activates this window.
void addItem(): Triggers the dialog for adding a new item, based on the currently selected item type tab.
auto addSmartgroup() -> int: Triggers the dialog to add a new smart group.
auto addTag() -> int: Triggers the dialog to add a new tag.
void editItem(): Triggers the dialog for editing the current item.
void editSmartgroupAction(): Triggers the dialog for editing the selected smart group.
void exportItems(): Triggers the dialog to export items.
void exportItemsPNG(): Triggers the dialog to export selected items as PNG files.
void exportItemsSVG(): Triggers the dialog to export selected items as SVG files.
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.
void filterSymbols(const QString& filter): Sets the filter string to filter symbols by.
void groupChanged(const QModelIndex&): Trigerred when the current group (or tag) is changed.
void groupRenamed(QStandardItem* item): Triggered when a group item is renamed.
void grouptreeContextMenu(QPoint): Context menu for the groupTree.
void importItems(): Triggers the dialog to import items.
auto itemChanged(QStandardItem* item) SIP_DEPRECATED -> Q_DECL_DEPRECATED void deprecated
void listitemsContextMenu(QPoint): Context menu for the listItems ( symbols list )
void onClose(): Closes the dialog.
void onFinished(): Called when the dialog is going to be closed.
void populateList(): Refreshes the list of items.
auto regrouped(QStandardItem*) SIP_DEPRECATED -> Q_DECL_DEPRECATED void deprecated
void removeGroup(): Removes the selected tag or smartgroup.
void removeItem(): Removes the current selected item.
void selectedSymbolsChanged(const QItemSelection& selected, const QItemSelection& deselected): Perform tasks when the selected symbols change.
void showHelp(): Opens the associated help.
void symbolSelected(const QModelIndex&): Perform symbol specific tasks when selected.
void tagSymbolsAction(): Toggles the interactive item tagging mode.

Protected functions

auto addColorRamp() -> bool: add a new color ramp to style
auto addSymbol() -> bool: add a new symbol to style
void enableGroupInputs(bool): Enables or disables the groupTree specific inputs.
void enableItemsForGroupingMode(bool): Enables or disables the groupTree items for grouping mode.
void enableSymbolInputs(bool): Enables or disbables the symbol specific inputs.
auto populateColorRamps(const QStringList& colorRamps, bool checkable = false) SIP_DEPRECATED -> Q_DECL_DEPRECATED void deprecated: Populates the list view with color ramps of the current type with the given names.
void populateGroups(): populate the groups
auto populateSymbols(const QStringList& symbolNames, bool checkable = false) SIP_DEPRECATED -> Q_DECL_DEPRECATED void deprecated: Populates the list view with symbols of the current type with the given names.
auto populateTypes() SIP_DEPRECATED -> Q_DECL_DEPRECATED void deprecated: Populate combo box with known style items (symbols, color ramps).
auto removeColorRamp() SIP_DEPRECATED -> Q_DECL_DEPRECATED bool deprecated
auto removeSymbol() SIP_DEPRECATED -> Q_DECL_DEPRECATED bool deprecated
void setBold(QStandardItem*): sets the text of the item with bold font
auto setSymbolsChecked(const QStringList&) SIP_DEPRECATED -> Q_DECL_DEPRECATED void deprecated

Protected slots

void addFavoriteSelectedSymbols(): Add selected symbols to favorites.
void detagSelectedSymbols(): Remove all tags from selected symbols.
void removeFavoriteSelectedSymbols(): Remove selected symbols from favorites.
void tagSelectedSymbols(bool newTag = false): Tag selected symbols using menu item selection.

Function documentation

QgsStyleManagerDialog::QgsStyleManagerDialog(QgsStyle* style, QWidget*parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

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.

void QgsStyleManagerDialog::activate() public slot

Raises, unminimizes and activates this window.

void QgsStyleManagerDialog::exportItems() public slot

Triggers the dialog to export items.

void QgsStyleManagerDialog::exportItemsPNG() public slot

Triggers the dialog to export selected items as PNG files.

void QgsStyleManagerDialog::exportItemsSVG() public slot

Triggers the dialog to export selected items as SVG files.

void QgsStyleManagerDialog::exportSelectedItemsImages(const QString& dir, const QString& format, QSize size) public slot

Triggers the dialog to export selected items as images of the specified format and size.

void QgsStyleManagerDialog::importItems() public slot

Triggers the dialog to import items.

Q_DECL_DEPRECATED void QgsStyleManagerDialog::itemChanged(QStandardItem* item) SIP_DEPRECATED public slot

Q_DECL_DEPRECATED void QgsStyleManagerDialog::regrouped(QStandardItem*) SIP_DEPRECATED public slot

Q_DECL_DEPRECATED void QgsStyleManagerDialog::populateColorRamps(const QStringList& colorRamps, bool checkable = false) SIP_DEPRECATED protected

Populates the list view with color ramps of the current type with the given names.

Q_DECL_DEPRECATED void QgsStyleManagerDialog::populateSymbols(const QStringList& symbolNames, bool checkable = false) SIP_DEPRECATED protected

Populates the list view with symbols of the current type with the given names.

Q_DECL_DEPRECATED void QgsStyleManagerDialog::populateTypes() SIP_DEPRECATED protected

Populate combo box with known style items (symbols, color ramps).