QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
|
Base class for renderer settings widgets. More...
#include <qgsrendererwidget.h>
Signals | |
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. | |
Public Member Functions | |
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. | |
virtual void | disableSymbolLevels () |
Disables symbol level modification on the widget. | |
virtual QgsFeatureRenderer * | renderer ()=0 |
Returns pointer to the renderer (no transfer of ownership) | |
virtual void | setContext (const QgsSymbolWidgetContext &context) |
Sets 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. | |
Protected Slots | |
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 | |
QgsDataDefinedSizeLegendWidget * | createDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend) |
Creates widget to setup data-defined size legend. | |
virtual void | refreshSymbolView () |
virtual QList< QgsSymbol * > | selectedSymbols () |
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&). | |
virtual void | setSymbolLevels (const QList< QgsLegendSymbolItem > &levels, bool enabled) |
Sets the symbol levels for the renderer defined in the widget. | |
![]() | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. | |
Protected Attributes | |
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 |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
static QgsPanelWidget * | findParentPanel (QWidget *widget) |
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. | |
Base class for renderer settings widgets.
WORKFLOW:
Definition at line 45 of file qgsrendererwidget.h.
QgsRendererWidget::QgsRendererWidget | ( | QgsVectorLayer * | layer, |
QgsStyle * | style | ||
) |
Definition at line 37 of file qgsrendererwidget.cpp.
void QgsRendererWidget::applyChanges | ( | ) |
This method should be called whenever the renderer is actually set on the layer.
Definition at line 350 of file qgsrendererwidget.cpp.
|
protectedslot |
Change marker angles of selected symbols.
Definition at line 272 of file qgsrendererwidget.cpp.
|
protectedslot |
Change color of selected symbols.
Definition at line 84 of file qgsrendererwidget.cpp.
|
protectedslot |
Change opacity of selected symbols.
Definition at line 139 of file qgsrendererwidget.cpp.
|
protectedslot |
Change marker sizes of selected symbols.
Definition at line 243 of file qgsrendererwidget.cpp.
|
protectedslot |
Change units mm/map units of selected symbols.
Definition at line 175 of file qgsrendererwidget.cpp.
|
protectedslot |
Change line widths of selected symbols.
Definition at line 213 of file qgsrendererwidget.cpp.
QgsSymbolWidgetContext QgsRendererWidget::context | ( | ) | const |
Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
Definition at line 345 of file qgsrendererwidget.cpp.
|
protectedslot |
Definition at line 79 of file qgsrendererwidget.cpp.
|
inlineprotectedvirtualslot |
Definition at line 170 of file qgsrendererwidget.h.
|
protected |
Creates widget to setup data-defined size legend.
Returns newly created panel - may be nullptr
if it could not be opened. Ownership is transferred to the caller.
Definition at line 372 of file qgsrendererwidget.cpp.
|
virtual |
Disables symbol level modification on the widget.
Reimplemented in QgsCategorizedSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, and QgsSingleSymbolRendererWidget.
Definition at line 368 of file qgsrendererwidget.cpp.
|
signal |
Emitted when expression context variables on the associated vector layers have been changed.
Will request the parent dialog to re-synchronize with the variables.
|
inlineprotectedvirtualslot |
Definition at line 171 of file qgsrendererwidget.h.
|
protectedvirtualslot |
Pastes the clipboard symbol over selected items.
Definition at line 301 of file qgsrendererwidget.cpp.
|
inlineprotectedvirtual |
Reimplemented in QgsCategorizedSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, and QgsRuleBasedRendererWidget.
Definition at line 135 of file qgsrendererwidget.h.
|
pure virtual |
Returns pointer to the renderer (no transfer of ownership)
Implemented in Qgs25DRendererWidget, QgsCategorizedSymbolRendererWidget, QgsEmbeddedSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, QgsHeatmapRendererWidget, QgsInvertedPolygonRendererWidget, QgsMergedFeatureRendererWidget, QgsNullSymbolRendererWidget, QgsPointClusterRendererWidget, QgsPointDisplacementRendererWidget, QgsRuleBasedRendererWidget, and QgsSingleSymbolRendererWidget.
|
inlineprotectedvirtual |
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 in QgsCategorizedSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, and QgsRuleBasedRendererWidget.
Definition at line 134 of file qgsrendererwidget.h.
|
virtual |
Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
context | symbol widget context |
Reimplemented in QgsCategorizedSymbolRendererWidget, QgsEmbeddedSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, QgsHeatmapRendererWidget, QgsInvertedPolygonRendererWidget, QgsMergedFeatureRendererWidget, QgsPointClusterRendererWidget, QgsPointDisplacementRendererWidget, and QgsSingleSymbolRendererWidget.
Definition at line 340 of file qgsrendererwidget.cpp.
|
overridevirtual |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
dockMode | true to enable dock mode. |
Reimplemented from QgsPanelWidget.
Reimplemented in QgsRuleBasedRendererWidget, and QgsSingleSymbolRendererWidget.
Definition at line 355 of file qgsrendererwidget.cpp.
|
protectedvirtual |
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 in QgsCategorizedSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, QgsRuleBasedRendererWidget, and QgsSingleSymbolRendererWidget.
Definition at line 386 of file qgsrendererwidget.cpp.
void QgsRendererWidget::showSymbolLevelsDialog | ( | QgsFeatureRenderer * | r | ) |
Show a dialog with renderer's symbol level settings.
Definition at line 317 of file qgsrendererwidget.cpp.
|
signal |
Emitted when the symbol levels settings have been changed.
|
inline |
Returns the vector layer associated with the widget.
Definition at line 75 of file qgsrendererwidget.h.
|
protected |
Definition at line 111 of file qgsrendererwidget.h.
|
protected |
Context in which widget is shown.
Definition at line 128 of file qgsrendererwidget.h.
|
protected |
Definition at line 112 of file qgsrendererwidget.h.
|
protected |
|
protected |
Definition at line 109 of file qgsrendererwidget.h.
|
protected |
Definition at line 113 of file qgsrendererwidget.h.
|
protected |
|
protected |
Definition at line 110 of file qgsrendererwidget.h.