QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
|
#include <qgscategorizedsymbolrendererwidget.h>
Public Types | |
enum class | CustomRole : int { Value = Qt::UserRole + 1 } |
Custom model roles. More... | |
Public Slots | |
void | addCategories () |
void | addCategory () |
void | applyColorRamp () |
Applies the color ramp passed on by the color ramp button. | |
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. | |
void | matchToSymbolsFromXml () |
Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name. | |
void | rowsMoved () |
void | showSymbolLevels () |
![]() | |
void | acceptPanel () |
Accept the panel. | |
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. | |
Public Member Functions | |
QgsCategorizedSymbolRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer) | |
~QgsCategorizedSymbolRendererWidget () override | |
void | disableSymbolLevels () override |
Disables symbol level modification on the widget. | |
int | matchToSymbols (QgsStyle *style) |
Replaces category symbols with the symbols from a style that have a matching name. | |
QgsFeatureRenderer * | renderer () override |
Returns pointer to the renderer (no transfer of ownership) | |
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. | |
![]() | |
QgsRendererWidget (QgsVectorLayer *layer, QgsStyle *style) | |
void | applyChanges () |
This method should be called whenever the renderer is actually set on the layer. | |
QgsSymbolWidgetContext | context () const |
Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. | |
void | setDockMode (bool dockMode) override |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. | |
void | showSymbolLevelsDialog (QgsFeatureRenderer *r) |
Show a dialog with renderer's symbol level settings. | |
const QgsVectorLayer * | vectorLayer () const |
Returns the vector layer associated with the widget. | |
![]() | |
QgsPanelWidget (QWidget *parent=nullptr) | |
Base class for any widget that can be shown as a inline panel. | |
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. | |
bool | autoDelete () |
The the auto delete property on the widget. | |
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. | |
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. | |
bool | dockMode () |
Returns the dock mode state. | |
virtual QMenu * | menuButtonMenu () |
Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. | |
virtual QString | menuButtonTooltip () const |
Returns the (translated) tooltip text to use for the menu button for this panel. | |
QString | panelTitle () |
The title of the panel. | |
void | setAutoDelete (bool autoDelete) |
The the auto delete property on the widget. | |
void | setPanelTitle (const QString &panelTitle) |
Set the title of the panel when shown in the interface. | |
![]() | |
virtual | ~QgsExpressionContextGenerator ()=default |
Static Public Member Functions | |
static QgsRendererWidget * | create (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer) |
![]() | |
static QgsPanelWidget * | findParentPanel (QWidget *widget) |
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. | |
Protected Slots | |
void | pasteSymbolToSelection () override |
![]() | |
void | changeSymbolAngle () |
Change marker angles of selected symbols. | |
void | changeSymbolColor () |
Change color of selected symbols. | |
void | changeSymbolOpacity () |
Change opacity of selected symbols. | |
void | changeSymbolSize () |
Change marker sizes of selected symbols. | |
void | changeSymbolUnit () |
Change units mm/map units of selected symbols. | |
void | changeSymbolWidth () |
Change line widths of selected symbols. | |
void | contextMenuViewCategories (QPoint p) |
virtual void | copy () |
virtual void | paste () |
virtual void | pasteSymbolToSelection () |
Pastes the clipboard symbol over selected items. | |
Protected Member Functions | |
void | applyChangeToSymbol () |
Applies current symbol to selected categories, or to all categories if none is selected. | |
void | changeCategorySymbol () |
void | changeSelectedSymbols () |
Changes the selected symbols alone for the change button, if there is a selection. | |
int | currentCategoryRow () |
Returns row index for the currently selected category (-1 if on no selection) | |
void | keyPressEvent (QKeyEvent *event) override |
void | populateCategories () |
void | refreshSymbolView () override |
QList< int > | selectedCategories () |
Returns a list of indexes for the categories under selection. | |
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&). | |
void | setSymbolLevels (const QgsLegendSymbolList &levels, bool enabled) override |
Sets the symbol levels for the renderer defined in the widget. | |
void | updateUiFromRenderer () |
![]() | |
QgsDataDefinedSizeLegendWidget * | createDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend) |
Creates widget to setup data-defined size legend. | |
![]() | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. | |
Protected Attributes | |
std::unique_ptr< QgsSymbol > | mCategorizedSymbol |
QgsCategorizedSymbolRendererModel * | mModel = nullptr |
std::unique_ptr< QgsCategorizedSymbolRenderer > | mRenderer |
![]() | |
QMenu * | contextMenu = nullptr |
QgsSymbolWidgetContext | mContext |
Context in which widget is shown. | |
QAction * | mCopyAction = nullptr |
QAction * | mCopySymbolAction = nullptr |
Copy symbol action. | |
QgsVectorLayer * | mLayer = nullptr |
QAction * | mPasteAction = nullptr |
QAction * | mPasteSymbolAction = nullptr |
Paste symbol action. | |
QgsStyle * | mStyle = nullptr |
Friends | |
class | TestQgsCategorizedRendererWidget |
Additional Inherited Members | |
![]() | |
void | layerVariablesChanged () |
Emitted when expression context variables on the associated vector layers have been changed. | |
Q_DECL_DEPRECATED void | symbolLevelsChanged () |
Emitted when the symbol levels settings have been changed. | |
![]() | |
void | panelAccepted (QgsPanelWidget *panel) |
Emitted when the panel is accepted by the user. | |
void | showPanel (QgsPanelWidget *panel) |
Emit when you require a panel to be show in the interface. | |
void | widgetChanged () |
Emitted when the widget state changes. | |
Definition at line 115 of file qgscategorizedsymbolrendererwidget.h.
|
strong |
Custom model roles.
Enumerator | |
---|---|
Value | Category value. |
Definition at line 128 of file qgscategorizedsymbolrendererwidget.h.
QgsCategorizedSymbolRendererWidget::QgsCategorizedSymbolRendererWidget | ( | QgsVectorLayer * | layer, |
QgsStyle * | style, | ||
QgsFeatureRenderer * | renderer | ||
) |
Definition at line 626 of file qgscategorizedsymbolrendererwidget.cpp.
|
override |
Definition at line 737 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 894 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 1097 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Applies current symbol to selected categories, or to all categories if none is selected.
Definition at line 1287 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Applies the color ramp passed on by the color ramp button.
Definition at line 1051 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 849 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 843 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 813 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Definition at line 855 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Changes the selected symbols alone for the change button, if there is a selection.
Definition at line 786 of file qgscategorizedsymbolrendererwidget.cpp.
|
static |
Definition at line 621 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Returns row index for the currently selected category (-1 if on no selection)
Definition at line 1060 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 1091 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 1084 of file qgscategorizedsymbolrendererwidget.cpp.
|
overridevirtual |
Disables symbol level modification on the widget.
Reimplemented from QgsRendererWidget.
Definition at line 780 of file qgscategorizedsymbolrendererwidget.cpp.
|
overrideprotected |
Definition at line 1321 of file qgscategorizedsymbolrendererwidget.cpp.
int QgsCategorizedSymbolRendererWidget::matchToSymbols | ( | QgsStyle * | style | ) |
Replaces category symbols with the symbols from a style that have a matching name.
style | style containing symbols to match with |
Definition at line 1179 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Replaces category symbols with the symbols from the users' symbol library that have a matching name.
Definition at line 1164 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name.
Definition at line 1196 of file qgscategorizedsymbolrendererwidget.cpp.
|
overrideprotectedslot |
Definition at line 1247 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Definition at line 839 of file qgscategorizedsymbolrendererwidget.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsRendererWidget.
Definition at line 1148 of file qgscategorizedsymbolrendererwidget.cpp.
|
overridevirtual |
Returns pointer to the renderer (no transfer of ownership)
Implements QgsRendererWidget.
Definition at line 768 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 1159 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Returns a list of indexes for the categories under selection.
Definition at line 1068 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Definition at line 1130 of file qgscategorizedsymbolrendererwidget.cpp.
|
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 1106 of file qgscategorizedsymbolrendererwidget.cpp.
|
overridevirtual |
Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
context | symbol widget context |
Reimplemented from QgsRendererWidget.
Definition at line 773 of file qgscategorizedsymbolrendererwidget.cpp.
|
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.
Reimplemented from QgsRendererWidget.
Definition at line 1232 of file qgscategorizedsymbolrendererwidget.cpp.
|
slot |
Definition at line 1154 of file qgscategorizedsymbolrendererwidget.cpp.
|
protected |
Definition at line 742 of file qgscategorizedsymbolrendererwidget.cpp.
|
friend |
Definition at line 262 of file qgscategorizedsymbolrendererwidget.h.
|
protected |
Definition at line 248 of file qgscategorizedsymbolrendererwidget.h.
|
protected |
Definition at line 250 of file qgscategorizedsymbolrendererwidget.h.
|
protected |
Definition at line 246 of file qgscategorizedsymbolrendererwidget.h.