QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsInvertedPolygonRendererWidget Class Reference

A widget used represent options of a QgsInvertedPolygonRenderer. More...

#include <qgsinvertedpolygonrendererwidget.h>

Inheritance diagram for QgsInvertedPolygonRendererWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsInvertedPolygonRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 Constructor. 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...
 
void setDockMode (bool dockMode) override
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. 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...
 
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...
 

Static Public Member Functions

static QgsRendererWidgetcreate (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 Static creation method. More...
 
- 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 Attributes

std::unique_ptr< QgsRendererWidgetmEmbeddedRendererWidget
 The widget used to represent the mask's embedded renderer. More...
 
std::unique_ptr< QgsInvertedPolygonRenderermRenderer
 The mask renderer. More...
 
- 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
 

Additional Inherited Members

- 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...
 
- Signals inherited from QgsRendererWidget
void layerVariablesChanged ()
 Emitted when expression context variables on the associated vector layers have been changed. More...
 
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...
 
- 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 inherited from QgsRendererWidget
QgsDataDefinedSizeLegendWidgetcreateDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend)
 Creates widget to setup data-defined size legend. More...
 
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&). 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...
 

Detailed Description

A widget used represent options of a QgsInvertedPolygonRenderer.

Since
QGIS 2.4

Definition at line 32 of file qgsinvertedpolygonrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsInvertedPolygonRendererWidget()

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

Constructor.

Parameters
layerthe layer where this renderer is applied
style
rendererthe mask renderer (will not take ownership)

Definition at line 30 of file qgsinvertedpolygonrendererwidget.cpp.

Member Function Documentation

◆ create()

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

Static creation method.

Parameters
layerthe layer where this renderer is applied
style
rendererthe mask renderer (will not take ownership)

Definition at line 25 of file qgsinvertedpolygonrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsInvertedPolygonRendererWidget::renderer ( )
overridevirtual

Returns pointer to the renderer (no transfer of ownership)

Implements QgsRendererWidget.

Definition at line 103 of file qgsinvertedpolygonrendererwidget.cpp.

◆ setContext()

void QgsInvertedPolygonRendererWidget::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 116 of file qgsinvertedpolygonrendererwidget.cpp.

◆ setDockMode()

void QgsInvertedPolygonRendererWidget::setDockMode ( bool  dockMode)
overridevirtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

Parameters
dockModetrue to enable dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 123 of file qgsinvertedpolygonrendererwidget.cpp.

Member Data Documentation

◆ mEmbeddedRendererWidget

std::unique_ptr<QgsRendererWidget> QgsInvertedPolygonRendererWidget::mEmbeddedRendererWidget
protected

The widget used to represent the mask's embedded renderer.

Definition at line 64 of file qgsinvertedpolygonrendererwidget.h.

◆ mRenderer

std::unique_ptr<QgsInvertedPolygonRenderer> QgsInvertedPolygonRendererWidget::mRenderer
protected

The mask renderer.

Definition at line 62 of file qgsinvertedpolygonrendererwidget.h.


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