QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Friends | List of all members
QgsCategorizedSymbolRendererWidget Class Reference

#include <qgscategorizedsymbolrendererwidget.h>

Inheritance diagram for QgsCategorizedSymbolRendererWidget:
Inheritance graph
[legend]

Public Slots

void addCategories ()
 
void addCategory ()
 
void applyColorRamp ()
 Applies the color ramp passed on by the color ramp button. More...
 
void categoriesDoubleClicked (const QModelIndex &idx)
 
void categoryColumnChanged (const QString &field)
 
void changeCategorizedSymbol ()
 
void deleteAllCategories ()
 
void deleteCategories ()
 
void matchToSymbolsFromLibrary ()
 Replaces category symbols with the symbols from the users' symbol library that have a matching name. More...
 
void matchToSymbolsFromXml ()
 Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name. More...
 
void rowsMoved ()
 
void showSymbolLevels ()
 
- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
void openPanel (QgsPanelWidget *panel)
 Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More...
 

Public Member Functions

 QgsCategorizedSymbolRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 
 ~QgsCategorizedSymbolRendererWidget () override
 
void disableSymbolLevels () override
 Disables symbol level modification on the widget. More...
 
int matchToSymbols (QgsStyle *style)
 Replaces category symbols with the symbols from a style that have a matching name. More...
 
QgsFeatureRendererrenderer () override
 Returns pointer to the renderer (no transfer of ownership) More...
 
void setContext (const QgsSymbolWidgetContext &context) override
 Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. More...
 
- Public Member Functions inherited from QgsRendererWidget
 QgsRendererWidget (QgsVectorLayer *layer, QgsStyle *style)
 
void applyChanges ()
 This method should be called whenever the renderer is actually set on the layer. More...
 
QgsSymbolWidgetContext context () const
 Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. More...
 
void setDockMode (bool dockMode) override
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void showSymbolLevelsDialog (QgsFeatureRenderer *r)
 Show a dialog with renderer's symbol level settings. More...
 
const QgsVectorLayervectorLayer () const
 Returns the vector layer associated with the widget. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
virtual bool applySizeConstraintsToStack () const
 Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
void connectChildPanel (QgsPanelWidget *panel)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
void connectChildPanels (const QList< QgsPanelWidget * > &panels)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Static Public Member Functions

static QgsRendererWidgetcreate (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 

Protected Slots

void pasteSymbolToSelection () override
 
- Protected Slots inherited from QgsRendererWidget
void changeSymbolAngle ()
 Change marker angles of selected symbols. More...
 
void changeSymbolColor ()
 Change color of selected symbols. More...
 
void changeSymbolOpacity ()
 Change opacity of selected symbols. More...
 
void changeSymbolSize ()
 Change marker sizes of selected symbols. More...
 
void changeSymbolUnit ()
 Change units mm/map units of selected symbols. More...
 
void changeSymbolWidth ()
 Change line widths of selected symbols. More...
 
void contextMenuViewCategories (QPoint p)
 
virtual void copy ()
 
virtual void paste ()
 
virtual void pasteSymbolToSelection ()
 Pastes the clipboard symbol over selected items. More...
 

Protected Member Functions

void applyChangeToSymbol ()
 Applies current symbol to selected categories, or to all categories if none is selected. More...
 
void changeCategorySymbol ()
 
void changeSelectedSymbols ()
 Changes the selected symbols alone for the change button, if there is a selection. More...
 
int currentCategoryRow ()
 Returns row index for the currently selected category (-1 if on no selection) More...
 
void keyPressEvent (QKeyEvent *event) override
 
void populateCategories ()
 
void refreshSymbolView () override
 
QList< int > selectedCategories ()
 Returns a list of indexes for the categories under selection. More...
 
QgsCategoryList selectedCategoryList ()
 
QList< QgsSymbol * > selectedSymbols () override
 Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&). More...
 
void setSymbolLevels (const QgsLegendSymbolList &levels, bool enabled) override
 Sets the symbol levels for the renderer defined in the widget. More...
 
void updateUiFromRenderer ()
 
- Protected Member Functions inherited from QgsRendererWidget
QgsDataDefinedSizeLegendWidgetcreateDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend)
 Creates widget to setup data-defined size legend. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Protected Attributes

std::unique_ptr< QgsSymbolmCategorizedSymbol
 
QgsCategorizedSymbolRendererModel * mModel = nullptr
 
std::unique_ptr< QgsCategorizedSymbolRenderermRenderer
 
- Protected Attributes inherited from QgsRendererWidget
QMenu * contextMenu = nullptr
 
QgsSymbolWidgetContext mContext
 Context in which widget is shown. More...
 
QAction * mCopyAction = nullptr
 
QAction * mCopySymbolAction = nullptr
 Copy symbol action. More...
 
QgsVectorLayermLayer = nullptr
 
QAction * mPasteAction = nullptr
 
QAction * mPasteSymbolAction = nullptr
 Paste symbol action. More...
 
QgsStylemStyle = nullptr
 

Friends

class TestQgsCategorizedRendererWidget
 

Additional Inherited Members

- Signals inherited from QgsRendererWidget
void layerVariablesChanged ()
 Emitted when expression context variables on the associated vector layers have been changed. More...
 
Q_DECL_DEPRECATED void symbolLevelsChanged ()
 Emitted when the symbol levels settings have been changed. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Detailed Description

Definition at line 92 of file qgscategorizedsymbolrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsCategorizedSymbolRendererWidget()

QgsCategorizedSymbolRendererWidget::QgsCategorizedSymbolRendererWidget ( QgsVectorLayer layer,
QgsStyle style,
QgsFeatureRenderer renderer 
)

Definition at line 498 of file qgscategorizedsymbolrendererwidget.cpp.

◆ ~QgsCategorizedSymbolRendererWidget()

QgsCategorizedSymbolRendererWidget::~QgsCategorizedSymbolRendererWidget ( )
override

Definition at line 608 of file qgscategorizedsymbolrendererwidget.cpp.

Member Function Documentation

◆ addCategories

void QgsCategorizedSymbolRendererWidget::addCategories ( )
slot

Definition at line 769 of file qgscategorizedsymbolrendererwidget.cpp.

◆ addCategory

void QgsCategorizedSymbolRendererWidget::addCategory ( )
slot

Definition at line 972 of file qgscategorizedsymbolrendererwidget.cpp.

◆ applyChangeToSymbol()

void QgsCategorizedSymbolRendererWidget::applyChangeToSymbol ( )
protected

Applies current symbol to selected categories, or to all categories if none is selected.

Definition at line 1172 of file qgscategorizedsymbolrendererwidget.cpp.

◆ applyColorRamp

void QgsCategorizedSymbolRendererWidget::applyColorRamp ( )
slot

Applies the color ramp passed on by the color ramp button.

Definition at line 926 of file qgscategorizedsymbolrendererwidget.cpp.

◆ categoriesDoubleClicked

void QgsCategorizedSymbolRendererWidget::categoriesDoubleClicked ( const QModelIndex &  idx)
slot

Definition at line 723 of file qgscategorizedsymbolrendererwidget.cpp.

◆ categoryColumnChanged

void QgsCategorizedSymbolRendererWidget::categoryColumnChanged ( const QString &  field)
slot

Definition at line 717 of file qgscategorizedsymbolrendererwidget.cpp.

◆ changeCategorizedSymbol

void QgsCategorizedSymbolRendererWidget::changeCategorizedSymbol ( )
slot

Definition at line 684 of file qgscategorizedsymbolrendererwidget.cpp.

◆ changeCategorySymbol()

void QgsCategorizedSymbolRendererWidget::changeCategorySymbol ( )
protected

Definition at line 729 of file qgscategorizedsymbolrendererwidget.cpp.

◆ changeSelectedSymbols()

void QgsCategorizedSymbolRendererWidget::changeSelectedSymbols ( )
protected

Changes the selected symbols alone for the change button, if there is a selection.

Definition at line 657 of file qgscategorizedsymbolrendererwidget.cpp.

◆ create()

QgsRendererWidget * QgsCategorizedSymbolRendererWidget::create ( QgsVectorLayer layer,
QgsStyle style,
QgsFeatureRenderer renderer 
)
static

Definition at line 493 of file qgscategorizedsymbolrendererwidget.cpp.

◆ currentCategoryRow()

int QgsCategorizedSymbolRendererWidget::currentCategoryRow ( )
protected

Returns row index for the currently selected category (-1 if on no selection)

Definition at line 935 of file qgscategorizedsymbolrendererwidget.cpp.

◆ deleteAllCategories

void QgsCategorizedSymbolRendererWidget::deleteAllCategories ( )
slot

Definition at line 966 of file qgscategorizedsymbolrendererwidget.cpp.

◆ deleteCategories

void QgsCategorizedSymbolRendererWidget::deleteCategories ( )
slot

Definition at line 959 of file qgscategorizedsymbolrendererwidget.cpp.

◆ disableSymbolLevels()

void QgsCategorizedSymbolRendererWidget::disableSymbolLevels ( )
overridevirtual

Disables symbol level modification on the widget.

Note
Not available in Python bindings
Since
QGIS 3.20

Reimplemented from QgsRendererWidget.

Definition at line 651 of file qgscategorizedsymbolrendererwidget.cpp.

◆ keyPressEvent()

void QgsCategorizedSymbolRendererWidget::keyPressEvent ( QKeyEvent *  event)
overrideprotected

Definition at line 1206 of file qgscategorizedsymbolrendererwidget.cpp.

◆ matchToSymbols()

int QgsCategorizedSymbolRendererWidget::matchToSymbols ( QgsStyle style)

Replaces category symbols with the symbols from a style that have a matching name.

Parameters
stylestyle containing symbols to match with
Returns
number of symbols matched
See also
matchToSymbolsFromLibrary
matchToSymbolsFromXml
Since
QGIS 2.9

Definition at line 1054 of file qgscategorizedsymbolrendererwidget.cpp.

◆ matchToSymbolsFromLibrary

void QgsCategorizedSymbolRendererWidget::matchToSymbolsFromLibrary ( )
slot

Replaces category symbols with the symbols from the users' symbol library that have a matching name.

See also
matchToSymbolsFromXml
matchToSymbols
Since
QGIS 2.9

Definition at line 1039 of file qgscategorizedsymbolrendererwidget.cpp.

◆ matchToSymbolsFromXml

void QgsCategorizedSymbolRendererWidget::matchToSymbolsFromXml ( )
slot

Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name.

See also
matchToSymbolsFromLibrary
matchToSymbols
Since
QGIS 2.9

Definition at line 1071 of file qgscategorizedsymbolrendererwidget.cpp.

◆ pasteSymbolToSelection

void QgsCategorizedSymbolRendererWidget::pasteSymbolToSelection ( )
overrideprotectedslot

Definition at line 1122 of file qgscategorizedsymbolrendererwidget.cpp.

◆ populateCategories()

void QgsCategorizedSymbolRendererWidget::populateCategories ( )
protected

Definition at line 713 of file qgscategorizedsymbolrendererwidget.cpp.

◆ refreshSymbolView()

void QgsCategorizedSymbolRendererWidget::refreshSymbolView ( )
overrideprotectedvirtual

Reimplemented from QgsRendererWidget.

Definition at line 1023 of file qgscategorizedsymbolrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsCategorizedSymbolRendererWidget::renderer ( )
overridevirtual

Returns pointer to the renderer (no transfer of ownership)

Implements QgsRendererWidget.

Definition at line 639 of file qgscategorizedsymbolrendererwidget.cpp.

◆ rowsMoved

void QgsCategorizedSymbolRendererWidget::rowsMoved ( )
slot

Definition at line 1034 of file qgscategorizedsymbolrendererwidget.cpp.

◆ selectedCategories()

QList< int > QgsCategorizedSymbolRendererWidget::selectedCategories ( )
protected

Returns a list of indexes for the categories under selection.

Definition at line 943 of file qgscategorizedsymbolrendererwidget.cpp.

◆ selectedCategoryList()

QgsCategoryList QgsCategorizedSymbolRendererWidget::selectedCategoryList ( )
protected

Definition at line 1005 of file qgscategorizedsymbolrendererwidget.cpp.

◆ selectedSymbols()

QList< QgsSymbol * > QgsCategorizedSymbolRendererWidget::selectedSymbols ( )
overrideprotectedvirtual

Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&).

Reimplemented from QgsRendererWidget.

Definition at line 981 of file qgscategorizedsymbolrendererwidget.cpp.

◆ setContext()

void QgsCategorizedSymbolRendererWidget::setContext ( const QgsSymbolWidgetContext context)
overridevirtual

Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

Parameters
contextsymbol widget context
See also
context()
Since
QGIS 3.0

Reimplemented from QgsRendererWidget.

Definition at line 644 of file qgscategorizedsymbolrendererwidget.cpp.

◆ setSymbolLevels()

void QgsCategorizedSymbolRendererWidget::setSymbolLevels ( const QgsLegendSymbolList levels,
bool  enabled 
)
overrideprotectedvirtual

Sets the symbol levels for the renderer defined in the widget.

The levels argument defines the updated list of symbols with rendering passes set.

The enabled arguments specifies if symbol levels should be enabled for the renderer.

Since
QGIS 3.20

Reimplemented from QgsRendererWidget.

Definition at line 1107 of file qgscategorizedsymbolrendererwidget.cpp.

◆ showSymbolLevels

void QgsCategorizedSymbolRendererWidget::showSymbolLevels ( )
slot

Definition at line 1029 of file qgscategorizedsymbolrendererwidget.cpp.

◆ updateUiFromRenderer()

void QgsCategorizedSymbolRendererWidget::updateUiFromRenderer ( )
protected

Definition at line 613 of file qgscategorizedsymbolrendererwidget.cpp.

Friends And Related Function Documentation

◆ TestQgsCategorizedRendererWidget

friend class TestQgsCategorizedRendererWidget
friend

Definition at line 227 of file qgscategorizedsymbolrendererwidget.h.

Member Data Documentation

◆ mCategorizedSymbol

std::unique_ptr< QgsSymbol > QgsCategorizedSymbolRendererWidget::mCategorizedSymbol
protected

Definition at line 213 of file qgscategorizedsymbolrendererwidget.h.

◆ mModel

QgsCategorizedSymbolRendererModel* QgsCategorizedSymbolRendererWidget::mModel = nullptr
protected

Definition at line 215 of file qgscategorizedsymbolrendererwidget.h.

◆ mRenderer

std::unique_ptr< QgsCategorizedSymbolRenderer > QgsCategorizedSymbolRendererWidget::mRenderer
protected

Definition at line 211 of file qgscategorizedsymbolrendererwidget.h.


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