| QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
    | 
A widget used represent options of a QgsEmbeddedSymbolRenderer. More...
#include <qgsembeddedsymbolrendererwidget.h>

| Public Member Functions | |
| QgsEmbeddedSymbolRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer) | |
| Constructor. | |
| ~QgsEmbeddedSymbolRendererWidget () override | |
| QgsExpressionContext | createExpressionContext () const override | 
| This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
| 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. | |
|  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. | |
| 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. | |
| 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. | |
|  Public Member Functions inherited from QgsPanelWidget | |
| QgsPanelWidget (QWidget *parent=nullptr) | |
| Base class for any widget that can be shown as a inline panel. | |
| virtual bool | applySizeConstraintsToStack () const | 
| Returns trueif 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 nullptrif 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. | |
|  Public Member Functions inherited from QgsExpressionContextGenerator | |
| virtual | ~QgsExpressionContextGenerator ()=default | 
| Static Public Member Functions | |
| static QgsRendererWidget * | create (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer) | 
| Static creation method. | |
|  Static Public Member Functions inherited from QgsPanelWidget | |
| static QgsPanelWidget * | findParentPanel (QWidget *widget) | 
| Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. | |
| Additional Inherited Members | |
|  Public Slots inherited from QgsPanelWidget | |
| void | acceptPanel () | 
| Accept the panel. | |
| void | openPanel (QgsPanelWidget *panel) | 
| Open a panel or dialog depending on dock mode setting If dock mode is truethis method will emit the showPanel signal for connected slots to handle the open event. | |
|  Signals inherited from QgsRendererWidget | |
| 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. | |
|  Signals inherited from QgsPanelWidget | |
| 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. | |
|  Protected Slots inherited from QgsRendererWidget | |
| 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 inherited from QgsRendererWidget | |
| 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. | |
|  Protected Member Functions inherited from QgsPanelWidget | |
| void | keyPressEvent (QKeyEvent *event) override | 
| Overridden key press event to handle the esc event on the widget. | |
|  Protected Attributes inherited from QgsRendererWidget | |
| 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 | 
A widget used represent options of a QgsEmbeddedSymbolRenderer.
Definition at line 32 of file qgsembeddedsymbolrendererwidget.h.
| QgsEmbeddedSymbolRendererWidget::QgsEmbeddedSymbolRendererWidget | ( | QgsVectorLayer * | layer, | 
| QgsStyle * | style, | ||
| QgsFeatureRenderer * | renderer | ||
| ) | 
Constructor.
| layer | the layer where this renderer is applied | 
| style | |
| renderer | the merged feature renderer (will not take ownership) | 
Definition at line 26 of file qgsembeddedsymbolrendererwidget.cpp.
| 
 | overridedefault | 
| 
 | static | 
Static creation method.
| layer | the layer where this renderer is applied | 
| style | |
| renderer | the merged feature renderer (will not take ownership) | 
Definition at line 21 of file qgsembeddedsymbolrendererwidget.cpp.
| 
 | overridevirtual | 
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 98 of file qgsembeddedsymbolrendererwidget.cpp.
| 
 | overridevirtual | 
Returns pointer to the renderer (no transfer of ownership)
Implements QgsRendererWidget.
Definition at line 83 of file qgsembeddedsymbolrendererwidget.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 88 of file qgsembeddedsymbolrendererwidget.cpp.