QGIS API Documentation  3.7.0-Master (a888986)
Classes | Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Friends | List of all members
QgsStyleManagerDialog Class Reference

A dialog allowing users to customize and populate a QgsStyle. More...

#include <qgsstylemanagerdialog.h>

Inheritance diagram for QgsStyleManagerDialog:
Inheritance graph
[legend]

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 &)
 Trigerred 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, 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 (QAction *action)
 
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 addColorRamp ()
 add a new color ramp to style More...
 
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
 

Detailed Description

A dialog allowing users to customize and populate a QgsStyle.

Definition at line 66 of file qgsstylemanagerdialog.h.

Constructor & Destructor Documentation

◆ QgsStyleManagerDialog()

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 148 of file qgsstylemanagerdialog.cpp.

Member Function Documentation

◆ activate

void QgsStyleManagerDialog::activate ( )
slot

Raises, unminimizes and activates this window.

Since
QGIS 3.4

Definition at line 993 of file qgsstylemanagerdialog.cpp.

◆ addColorRamp [1/2]

bool QgsStyleManagerDialog::addColorRamp ( QAction *  action)
protectedslot

Definition at line 1005 of file qgsstylemanagerdialog.cpp.

◆ addColorRamp() [2/2]

bool QgsStyleManagerDialog::addColorRamp ( )
protected

add a new color ramp to style

Definition at line 1000 of file qgsstylemanagerdialog.cpp.

◆ addColorRampStatic()

QString QgsStyleManagerDialog::addColorRampStatic ( QWidget *  parent,
QgsStyle style,
QString  RampType = QString() 
)
static

Opens the add color ramp dialog, returning the new color ramp's name if the ramp has been added.

Definition at line 835 of file qgsstylemanagerdialog.cpp.

◆ addFavoriteSelectedSymbols

void QgsStyleManagerDialog::addFavoriteSelectedSymbols ( )
protectedslot

Add selected symbols to favorites.

Definition at line 1736 of file qgsstylemanagerdialog.cpp.

◆ addItem

void QgsStyleManagerDialog::addItem ( )
slot

Triggers the dialog for adding a new item, based on the currently selected item type tab.

Definition at line 716 of file qgsstylemanagerdialog.cpp.

◆ addSmartgroup

int QgsStyleManagerDialog::addSmartgroup ( )
slot

Triggers the dialog to add a new smart group.

Definition at line 1454 of file qgsstylemanagerdialog.cpp.

◆ addSymbol()

bool QgsStyleManagerDialog::addSymbol ( int  symbolType = -1)
protected

add a new symbol to style

Definition at line 738 of file qgsstylemanagerdialog.cpp.

◆ addTag

int QgsStyleManagerDialog::addTag ( )
slot

Triggers the dialog to add a new tag.

Definition at line 1405 of file qgsstylemanagerdialog.cpp.

◆ currentItemName()

QString QgsStyleManagerDialog::currentItemName ( )
protected

Definition at line 707 of file qgsstylemanagerdialog.cpp.

◆ currentItemType()

int QgsStyleManagerDialog::currentItemType ( )
protected

Definition at line 690 of file qgsstylemanagerdialog.cpp.

◆ detagSelectedSymbols

void QgsStyleManagerDialog::detagSelectedSymbols ( )
protectedslot

Remove all tags from selected symbols.

Definition at line 1783 of file qgsstylemanagerdialog.cpp.

◆ editColorRamp()

bool QgsStyleManagerDialog::editColorRamp ( )
protected

Definition at line 1057 of file qgsstylemanagerdialog.cpp.

◆ editItem

void QgsStyleManagerDialog::editItem ( )
slot

Triggers the dialog for editing the current item.

Definition at line 1020 of file qgsstylemanagerdialog.cpp.

◆ editSmartgroupAction

void QgsStyleManagerDialog::editSmartgroupAction ( )
slot

Triggers the dialog for editing the selected smart group.

Definition at line 1797 of file qgsstylemanagerdialog.cpp.

◆ editSymbol()

bool QgsStyleManagerDialog::editSymbol ( )
protected

Definition at line 1036 of file qgsstylemanagerdialog.cpp.

◆ enableGroupInputs()

void QgsStyleManagerDialog::enableGroupInputs ( bool  enable)
protected

Enables or disables the groupTree specific inputs.

Definition at line 1655 of file qgsstylemanagerdialog.cpp.

◆ enableItemsForGroupingMode()

void QgsStyleManagerDialog::enableItemsForGroupingMode ( bool  enable)
protected

Enables or disables the groupTree items for grouping mode.

Definition at line 1661 of file qgsstylemanagerdialog.cpp.

◆ enableSymbolInputs()

void QgsStyleManagerDialog::enableSymbolInputs ( bool  enable)
protected

Enables or disbables the symbol specific inputs.

Definition at line 1643 of file qgsstylemanagerdialog.cpp.

◆ exportItems

void QgsStyleManagerDialog::exportItems ( )
slot

Triggers the dialog to export items.

See also
importItems()

Definition at line 1232 of file qgsstylemanagerdialog.cpp.

◆ exportItemsPNG

void QgsStyleManagerDialog::exportItemsPNG ( )
slot

Triggers the dialog to export selected items as PNG files.

See also
exportItemsSVG()
exportSelectedItemsImages()

Definition at line 1195 of file qgsstylemanagerdialog.cpp.

◆ exportItemsSVG

void QgsStyleManagerDialog::exportItemsSVG ( )
slot

Triggers the dialog to export selected items as SVG files.

See also
exportItemsPNG()
exportSelectedItemsImages()

Definition at line 1204 of file qgsstylemanagerdialog.cpp.

◆ exportSelectedItemsImages

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

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

See also
exportItemsSVG()
exportItemsPNG()

Definition at line 1214 of file qgsstylemanagerdialog.cpp.

◆ filterSymbols

void QgsStyleManagerDialog::filterSymbols ( const QString &  filter)
slot

Sets the filter string to filter symbols by.

Definition at line 1615 of file qgsstylemanagerdialog.cpp.

◆ groupChanged

void QgsStyleManagerDialog::groupChanged ( const QModelIndex &  index)
slot

Trigerred when the current group (or tag) is changed.

Definition at line 1319 of file qgsstylemanagerdialog.cpp.

◆ groupRenamed

void QgsStyleManagerDialog::groupRenamed ( QStandardItem *  item)
slot

Triggered when a group item is renamed.

Definition at line 1528 of file qgsstylemanagerdialog.cpp.

◆ grouptreeContextMenu

void QgsStyleManagerDialog::grouptreeContextMenu ( QPoint  point)
slot

Context menu for the groupTree.

Definition at line 1691 of file qgsstylemanagerdialog.cpp.

◆ importItems

void QgsStyleManagerDialog::importItems ( )
slot

Triggers the dialog to import items.

See also
exportItems()

Definition at line 1238 of file qgsstylemanagerdialog.cpp.

◆ itemChanged

void QgsStyleManagerDialog::itemChanged ( QStandardItem *  item)
slot
Deprecated:
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0

Definition at line 1191 of file qgsstylemanagerdialog.cpp.

◆ listitemsContextMenu

void QgsStyleManagerDialog::listitemsContextMenu ( QPoint  point)
slot

Context menu for the listItems ( symbols list )

Definition at line 1700 of file qgsstylemanagerdialog.cpp.

◆ onClose

void QgsStyleManagerDialog::onClose ( )
slot

Closes the dialog.

Definition at line 1836 of file qgsstylemanagerdialog.cpp.

◆ onFinished

void QgsStyleManagerDialog::onFinished ( )
slot

Called when the dialog is going to be closed.

Definition at line 422 of file qgsstylemanagerdialog.cpp.

◆ populateColorRamps()

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

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

Definition at line 686 of file qgsstylemanagerdialog.cpp.

◆ populateGroups()

void QgsStyleManagerDialog::populateGroups ( )
protected

populate the groups

Definition at line 1253 of file qgsstylemanagerdialog.cpp.

◆ populateList

void QgsStyleManagerDialog::populateList ( )
slot

Refreshes the list of items.

Definition at line 677 of file qgsstylemanagerdialog.cpp.

◆ populateSymbols()

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

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

Definition at line 682 of file qgsstylemanagerdialog.cpp.

◆ populateTypes()

void QgsStyleManagerDialog::populateTypes ( )
protected

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

Deprecated:
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0

Definition at line 434 of file qgsstylemanagerdialog.cpp.

◆ regrouped

void QgsStyleManagerDialog::regrouped ( QStandardItem *  )
slot
Deprecated:
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0

Definition at line 1607 of file qgsstylemanagerdialog.cpp.

◆ removeColorRamp()

bool QgsStyleManagerDialog::removeColorRamp ( )
protected
Deprecated:
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0

Definition at line 1186 of file qgsstylemanagerdialog.cpp.

◆ removeFavoriteSelectedSymbols

void QgsStyleManagerDialog::removeFavoriteSelectedSymbols ( )
protectedslot

Remove selected symbols from favorites.

Definition at line 1745 of file qgsstylemanagerdialog.cpp.

◆ removeGroup

void QgsStyleManagerDialog::removeGroup ( )
slot

Removes the selected tag or smartgroup.

Definition at line 1492 of file qgsstylemanagerdialog.cpp.

◆ removeItem

void QgsStyleManagerDialog::removeItem ( )
slot

Removes the current selected item.

Definition at line 1133 of file qgsstylemanagerdialog.cpp.

◆ removeSymbol()

bool QgsStyleManagerDialog::removeSymbol ( )
protected
Deprecated:
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0

Definition at line 1181 of file qgsstylemanagerdialog.cpp.

◆ selectedSymbolsChanged

void QgsStyleManagerDialog::selectedSymbolsChanged ( const QItemSelection &  selected,
const QItemSelection &  deselected 
)
slot

Perform tasks when the selected symbols change.

Definition at line 1625 of file qgsstylemanagerdialog.cpp.

◆ setBaseStyleName()

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".

Since
QGIS 3.6

Definition at line 988 of file qgsstylemanagerdialog.cpp.

◆ setBold()

void QgsStyleManagerDialog::setBold ( QStandardItem *  item)
protected

sets the text of the item with bold font

Definition at line 1246 of file qgsstylemanagerdialog.cpp.

◆ setFavoritesGroupVisible()

void QgsStyleManagerDialog::setFavoritesGroupVisible ( bool  show)

Sets whether the favorites group should be shown.

The default is to show the group.

Since
QGIS 3.6

Definition at line 976 of file qgsstylemanagerdialog.cpp.

◆ setSmartGroupsVisible()

void QgsStyleManagerDialog::setSmartGroupsVisible ( bool  show)

Sets whether smart groups should be shown.

The default is to show the groups.

Since
QGIS 3.6

Definition at line 982 of file qgsstylemanagerdialog.cpp.

◆ setSymbolsChecked()

void QgsStyleManagerDialog::setSymbolsChecked ( const QStringList &  )
protected
Deprecated:
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0

Definition at line 1611 of file qgsstylemanagerdialog.cpp.

◆ showHelp

void QgsStyleManagerDialog::showHelp ( )
slot

Opens the associated help.

Definition at line 1841 of file qgsstylemanagerdialog.cpp.

◆ symbolSelected

void QgsStyleManagerDialog::symbolSelected ( const QModelIndex &  index)
slot

Perform symbol specific tasks when selected.

Definition at line 1620 of file qgsstylemanagerdialog.cpp.

◆ tagSelectedSymbols

void QgsStyleManagerDialog::tagSelectedSymbols ( bool  newTag = false)
protectedslot

Tag selected symbols using menu item selection.

Definition at line 1754 of file qgsstylemanagerdialog.cpp.

◆ tagSymbolsAction

void QgsStyleManagerDialog::tagSymbolsAction ( )
slot

Toggles the interactive item tagging mode.

Definition at line 1545 of file qgsstylemanagerdialog.cpp.

Friends And Related Function Documentation

◆ QgsStyleExportImportDialog

friend class QgsStyleExportImportDialog
friend

Definition at line 398 of file qgsstylemanagerdialog.h.


The documentation for this class was generated from the following files: