QGIS API Documentation  3.3.0-Master (c515a66)
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsStyleManagerDialog Class Reference

#include <qgsstylemanagerdialog.h>

Inheritance diagram for QgsStyleManagerDialog:
Inheritance graph
[legend]

Public Slots

void addItem ()
 
int addSmartgroup ()
 add a smartgroup More...
 
int addTag ()
 add a tag More...
 
void editItem ()
 
void editSmartgroupAction ()
 edit the selected smart group More...
 
void exportItems ()
 
void exportItemsPNG ()
 
void exportItemsSVG ()
 
void exportSelectedItemsImages (const QString &dir, const QString &format, QSize size)
 
void filterSymbols (const QString &)
 filter the symbols based on input search term More...
 
void groupChanged (const QModelIndex &)
 
void groupRenamed (QStandardItem *)
 
void grouptreeContextMenu (QPoint)
 Context menu for the groupTree. More...
 
void importItems ()
 
void itemChanged (QStandardItem *item)
 
void listitemsContextMenu (QPoint)
 Context menu for the listItems ( symbols list ) More...
 
void onClose ()
 Close the dialog. More...
 
void onFinished ()
 called when the dialog is going to be closed More...
 
void populateList ()
 adds symbols of some type to list More...
 
void regrouped (QStandardItem *)
 symbol changed from one group More...
 
void removeGroup ()
 remove a tag or smartgroup More...
 
void removeItem ()
 
void selectedSymbolsChanged (const QItemSelection &selected, const QItemSelection &deselected)
 Perform tasks when the selected symbols change. More...
 
void showHelp ()
 Open the associated help. More...
 
void symbolSelected (const QModelIndex &)
 Perform symbol specific tasks when selected. More...
 
void tagSymbolsAction ()
 carry out symbol tagging using check boxes More...
 

Public Member Functions

 QgsStyleManagerDialog (QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS=nullptr)
 

Static Public Member Functions

static QString addColorRampStatic (QWidget *parent, QgsStyle *style, QString RampType=QString())
 open add color ramp dialog, return 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 ()
 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...
 
void populateColorRamps (const QStringList &colorRamps, bool checkable=false)
 populate list view with color ramps More...
 
void populateGroups ()
 populate the groups More...
 
void populateSymbols (const QStringList &symbolNames, bool checkable=false)
 populate list view with symbols of the current type with the given names More...
 
void populateTypes ()
 populate combo box with known style items (symbols, color ramps) More...
 
bool removeColorRamp ()
 
bool removeSymbol ()
 
void setBold (QStandardItem *)
 sets the text of the item with bold font More...
 
void setSymbolsChecked (const QStringList &)
 to set symbols checked when in editing mode More...
 

Protected Attributes

QMenu * mGroupListMenu = nullptr
 Sub-menu of mGroupMenu, dynamically filled to show one entry for every group. More...
 
QMenu * mGroupMenu = nullptr
 Context menu for the symbols/colorramps. More...
 
bool mGrouppingMode
 Mode to display the symbol list. More...
 
QMenu * mGroupTreeContextMenu = nullptr
 Context menu for the group tree. More...
 
QMenu * mMenuBtnAddItemColorRamp = nullptr
 Menu for the "Add item" toolbutton when in colorramp mode. More...
 
bool mModified
 
QgsStylemStyle = nullptr
 
QString mStyleFilename
 
QStringList mTagList
 space to store symbol tags More...
 

Detailed Description

Definition at line 34 of file qgsstylemanagerdialog.h.

Constructor & Destructor Documentation

◆ QgsStyleManagerDialog()

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

Definition at line 46 of file qgsstylemanagerdialog.cpp.

Member Function Documentation

◆ addColorRamp [1/2]

bool QgsStyleManagerDialog::addColorRamp ( QAction *  action)
protectedslot

Definition at line 615 of file qgsstylemanagerdialog.cpp.

◆ addColorRamp() [2/2]

bool QgsStyleManagerDialog::addColorRamp ( )
protected

add a new color ramp to style

Definition at line 610 of file qgsstylemanagerdialog.cpp.

◆ addColorRampStatic()

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

open add color ramp dialog, return color ramp's name if the ramp has been added

Definition at line 468 of file qgsstylemanagerdialog.cpp.

◆ addFavoriteSelectedSymbols

void QgsStyleManagerDialog::addFavoriteSelectedSymbols ( )
protectedslot

Add selected symbols to favorites.

Definition at line 1405 of file qgsstylemanagerdialog.cpp.

◆ addItem

void QgsStyleManagerDialog::addItem ( )
slot

Definition at line 348 of file qgsstylemanagerdialog.cpp.

◆ addSmartgroup

int QgsStyleManagerDialog::addSmartgroup ( )
slot

add a smartgroup

Definition at line 1097 of file qgsstylemanagerdialog.cpp.

◆ addSymbol()

bool QgsStyleManagerDialog::addSymbol ( )
protected

add a new symbol to style

Definition at line 371 of file qgsstylemanagerdialog.cpp.

◆ addTag

int QgsStyleManagerDialog::addTag ( )
slot

add a tag

Definition at line 1051 of file qgsstylemanagerdialog.cpp.

◆ currentItemName()

QString QgsStyleManagerDialog::currentItemName ( )
protected

Definition at line 340 of file qgsstylemanagerdialog.cpp.

◆ currentItemType()

int QgsStyleManagerDialog::currentItemType ( )
protected

Definition at line 323 of file qgsstylemanagerdialog.cpp.

◆ detagSelectedSymbols

void QgsStyleManagerDialog::detagSelectedSymbols ( )
protectedslot

Remove all tags from selected symbols.

Definition at line 1478 of file qgsstylemanagerdialog.cpp.

◆ editColorRamp()

bool QgsStyleManagerDialog::editColorRamp ( )
protected

Definition at line 671 of file qgsstylemanagerdialog.cpp.

◆ editItem

void QgsStyleManagerDialog::editItem ( )
slot

Definition at line 630 of file qgsstylemanagerdialog.cpp.

◆ editSmartgroupAction

void QgsStyleManagerDialog::editSmartgroupAction ( )
slot

edit the selected smart group

Definition at line 1501 of file qgsstylemanagerdialog.cpp.

◆ editSymbol()

bool QgsStyleManagerDialog::editSymbol ( )
protected

Definition at line 650 of file qgsstylemanagerdialog.cpp.

◆ enableGroupInputs()

void QgsStyleManagerDialog::enableGroupInputs ( bool  enable)
protected

Enables or disables the groupTree specific inputs.

Definition at line 1327 of file qgsstylemanagerdialog.cpp.

◆ enableItemsForGroupingMode()

void QgsStyleManagerDialog::enableItemsForGroupingMode ( bool  enable)
protected

Enables or disables the groupTree items for grouping mode.

Definition at line 1333 of file qgsstylemanagerdialog.cpp.

◆ enableSymbolInputs()

void QgsStyleManagerDialog::enableSymbolInputs ( bool  enable)
protected

Enables or disbables the symbol specific inputs.

Definition at line 1315 of file qgsstylemanagerdialog.cpp.

◆ exportItems

void QgsStyleManagerDialog::exportItems ( )
slot

Definition at line 877 of file qgsstylemanagerdialog.cpp.

◆ exportItemsPNG

void QgsStyleManagerDialog::exportItemsPNG ( )
slot

Definition at line 842 of file qgsstylemanagerdialog.cpp.

◆ exportItemsSVG

void QgsStyleManagerDialog::exportItemsSVG ( )
slot

Definition at line 851 of file qgsstylemanagerdialog.cpp.

◆ exportSelectedItemsImages

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

Definition at line 861 of file qgsstylemanagerdialog.cpp.

◆ filterSymbols

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

filter the symbols based on input search term

Definition at line 1280 of file qgsstylemanagerdialog.cpp.

◆ groupChanged

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

Definition at line 953 of file qgsstylemanagerdialog.cpp.

◆ groupRenamed

void QgsStyleManagerDialog::groupRenamed ( QStandardItem *  item)
slot

Definition at line 1157 of file qgsstylemanagerdialog.cpp.

◆ grouptreeContextMenu

void QgsStyleManagerDialog::grouptreeContextMenu ( QPoint  point)
slot

Context menu for the groupTree.

Definition at line 1363 of file qgsstylemanagerdialog.cpp.

◆ importItems

void QgsStyleManagerDialog::importItems ( )
slot

Definition at line 883 of file qgsstylemanagerdialog.cpp.

◆ itemChanged

void QgsStyleManagerDialog::itemChanged ( QStandardItem *  item)
slot

Definition at line 814 of file qgsstylemanagerdialog.cpp.

◆ listitemsContextMenu

void QgsStyleManagerDialog::listitemsContextMenu ( QPoint  point)
slot

Context menu for the listItems ( symbols list )

Definition at line 1374 of file qgsstylemanagerdialog.cpp.

◆ onClose

void QgsStyleManagerDialog::onClose ( )
slot

Close the dialog.

Definition at line 1538 of file qgsstylemanagerdialog.cpp.

◆ onFinished

void QgsStyleManagerDialog::onFinished ( )
slot

called when the dialog is going to be closed

Definition at line 195 of file qgsstylemanagerdialog.cpp.

◆ populateColorRamps()

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

populate list view with color ramps

Definition at line 301 of file qgsstylemanagerdialog.cpp.

◆ populateGroups()

void QgsStyleManagerDialog::populateGroups ( )
protected

populate the groups

Definition at line 898 of file qgsstylemanagerdialog.cpp.

◆ populateList

void QgsStyleManagerDialog::populateList ( )
slot

adds symbols of some type to list

Definition at line 263 of file qgsstylemanagerdialog.cpp.

◆ populateSymbols()

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

populate list view with symbols of the current type with the given names

Definition at line 273 of file qgsstylemanagerdialog.cpp.

◆ populateTypes()

void QgsStyleManagerDialog::populateTypes ( )
protected

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

Definition at line 207 of file qgsstylemanagerdialog.cpp.

◆ regrouped

void QgsStyleManagerDialog::regrouped ( QStandardItem *  item)
slot

symbol changed from one group

Definition at line 1241 of file qgsstylemanagerdialog.cpp.

◆ removeColorRamp()

bool QgsStyleManagerDialog::removeColorRamp ( )
protected

Definition at line 792 of file qgsstylemanagerdialog.cpp.

◆ removeFavoriteSelectedSymbols

void QgsStyleManagerDialog::removeFavoriteSelectedSymbols ( )
protectedslot

Remove selected symbols from favorites.

Definition at line 1422 of file qgsstylemanagerdialog.cpp.

◆ removeGroup

void QgsStyleManagerDialog::removeGroup ( )
slot

remove a tag or smartgroup

Definition at line 1129 of file qgsstylemanagerdialog.cpp.

◆ removeItem

void QgsStyleManagerDialog::removeItem ( )
slot

Definition at line 747 of file qgsstylemanagerdialog.cpp.

◆ removeSymbol()

bool QgsStyleManagerDialog::removeSymbol ( )
protected

Definition at line 770 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 1300 of file qgsstylemanagerdialog.cpp.

◆ setBold()

void QgsStyleManagerDialog::setBold ( QStandardItem *  item)
protected

sets the text of the item with bold font

Definition at line 891 of file qgsstylemanagerdialog.cpp.

◆ setSymbolsChecked()

void QgsStyleManagerDialog::setSymbolsChecked ( const QStringList &  symbols)
protected

to set symbols checked when in editing mode

Definition at line 1269 of file qgsstylemanagerdialog.cpp.

◆ showHelp

void QgsStyleManagerDialog::showHelp ( )
slot

Open the associated help.

Definition at line 1543 of file qgsstylemanagerdialog.cpp.

◆ symbolSelected

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

Perform symbol specific tasks when selected.

Definition at line 1295 of file qgsstylemanagerdialog.cpp.

◆ tagSelectedSymbols

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

Tag selected symbols using menu item selection.

Definition at line 1439 of file qgsstylemanagerdialog.cpp.

◆ tagSymbolsAction

void QgsStyleManagerDialog::tagSymbolsAction ( )
slot

carry out symbol tagging using check boxes

Definition at line 1172 of file qgsstylemanagerdialog.cpp.

Member Data Documentation

◆ mGroupListMenu

QMenu* QgsStyleManagerDialog::mGroupListMenu = nullptr
protected

Sub-menu of mGroupMenu, dynamically filled to show one entry for every group.

Definition at line 169 of file qgsstylemanagerdialog.h.

◆ mGroupMenu

QMenu* QgsStyleManagerDialog::mGroupMenu = nullptr
protected

Context menu for the symbols/colorramps.

Definition at line 166 of file qgsstylemanagerdialog.h.

◆ mGrouppingMode

bool QgsStyleManagerDialog::mGrouppingMode
protected

Mode to display the symbol list.

Definition at line 160 of file qgsstylemanagerdialog.h.

◆ mGroupTreeContextMenu

QMenu* QgsStyleManagerDialog::mGroupTreeContextMenu = nullptr
protected

Context menu for the group tree.

Definition at line 172 of file qgsstylemanagerdialog.h.

◆ mMenuBtnAddItemColorRamp

QMenu* QgsStyleManagerDialog::mMenuBtnAddItemColorRamp = nullptr
protected

Menu for the "Add item" toolbutton when in colorramp mode.

Definition at line 175 of file qgsstylemanagerdialog.h.

◆ mModified

bool QgsStyleManagerDialog::mModified
protected

Definition at line 157 of file qgsstylemanagerdialog.h.

◆ mStyle

QgsStyle* QgsStyleManagerDialog::mStyle = nullptr
protected

Definition at line 153 of file qgsstylemanagerdialog.h.

◆ mStyleFilename

QString QgsStyleManagerDialog::mStyleFilename
protected

Definition at line 155 of file qgsstylemanagerdialog.h.

◆ mTagList

QStringList QgsStyleManagerDialog::mTagList
protected

space to store symbol tags

Definition at line 163 of file qgsstylemanagerdialog.h.


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