QGIS API Documentation 3.41.0-Master (d5b93354e9c)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsNullSymbolRendererWidget Class Reference

Blank widget for customizing QgsNullSymbolRenderer. More...

#include <qgsnullsymbolrendererwidget.h>

Inheritance diagram for QgsNullSymbolRendererWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsNullSymbolRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 Constructor for QgsNullSymbolRendererWidget.
 
 ~QgsNullSymbolRendererWidget () override
 
QgsFeatureRendererrenderer () override
 Returns a pointer to the configured renderer.
 
- 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.
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context.
 
virtual void disableSymbolLevels ()
 Disables symbol level modification on the widget.
 
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 QgsVectorLayervectorLayer () 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 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.
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Static Public Member Functions

static QgsRendererWidgetcreate (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 Creates a new QgsNullSymbolRendererWidget object.
 
- 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.
 

Protected Attributes

std::unique_ptr< QgsNullSymbolRenderermRenderer
 Renderer being configured by 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.
 
QgsVectorLayermLayer = nullptr
 
QAction * mPasteAction = nullptr
 
QAction * mPasteSymbolAction = nullptr
 Paste symbol action.
 
QgsStylemStyle = nullptr
 

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 true this 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
QgsDataDefinedSizeLegendWidgetcreateDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend)
 Creates widget to setup data-defined size legend.
 
virtual void refreshSymbolView ()
 
void registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsFeatureRenderer::Property key)
 Registers a data defined override button.
 
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.
 

Detailed Description

Blank widget for customizing QgsNullSymbolRenderer.

Definition at line 32 of file qgsnullsymbolrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsNullSymbolRendererWidget()

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

Constructor for QgsNullSymbolRendererWidget.

Definition at line 28 of file qgsnullsymbolrendererwidget.cpp.

◆ ~QgsNullSymbolRendererWidget()

QgsNullSymbolRendererWidget::~QgsNullSymbolRendererWidget ( )
overridedefault

Member Function Documentation

◆ create()

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

Creates a new QgsNullSymbolRendererWidget object.

Definition at line 23 of file qgsnullsymbolrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsNullSymbolRendererWidget::renderer ( )
overridevirtual

Returns a pointer to the configured renderer.

Implements QgsRendererWidget.

Definition at line 49 of file qgsnullsymbolrendererwidget.cpp.

Member Data Documentation

◆ mRenderer

std::unique_ptr<QgsNullSymbolRenderer> QgsNullSymbolRendererWidget::mRenderer
protected

Renderer being configured by the widget.

Definition at line 49 of file qgsnullsymbolrendererwidget.h.


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