QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Slots | Signals | Public Member Functions | Protected Attributes | List of all members
QgsMapLayerConfigWidget Class Referenceabstract

A panel widget that can be shown in the map style dock. More...

#include <qgsmaplayerconfigwidget.h>

Inheritance diagram for QgsMapLayerConfigWidget:
Inheritance graph
[legend]

Public Slots

virtual void apply ()=0
 Called when changes to the layer need to be made. More...
 
virtual void focusDefaultWidget ()
 Focuses the default widget for the page. More...
 
- 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

void dynamicTemporalControlToggled (bool enabled)
 Emitted whenever the dynamic temporal control option is toggled in the associated layer properties dialog. 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...
 

Public Member Functions

 QgsMapLayerConfigWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
 A panel widget that can be shown in the map style dock. More...
 
virtual void setMapLayerConfigWidgetContext (const QgsMapLayerConfigWidgetContext &context)
 Sets the context under which the widget is being shown. More...
 
virtual bool shouldTriggerLayerRepaint () const
 Whether this config widget changes map layer properties in a way that triggerRepaint() should be called for the layer after applying changes. More...
 
virtual void syncToLayer (QgsMapLayer *layer)
 Reset to original (vector layer) values. 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...
 
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. 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...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Protected Attributes

QgsMapLayermLayer = nullptr
 
QgsMapCanvasmMapCanvas = nullptr
 
QgsMapLayerConfigWidgetContext mMapLayerConfigWidgetContext
 

Additional Inherited Members

- 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 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 panel widget that can be shown in the map style dock.

Since
QGIS 2.16

Definition at line 115 of file qgsmaplayerconfigwidget.h.

Constructor & Destructor Documentation

◆ QgsMapLayerConfigWidget()

QgsMapLayerConfigWidget::QgsMapLayerConfigWidget ( QgsMapLayer layer,
QgsMapCanvas canvas,
QWidget *  parent = nullptr 
)

A panel widget that can be shown in the map style dock.

Parameters
layerThe layer active in the dock.
canvasThe canvas object.
parentThe parent of the widget.
Note
The widget is created each time the panel is selected in the dock. Keep the loading light as possible for speed in the UI.

Definition at line 37 of file qgsmaplayerconfigwidget.cpp.

Member Function Documentation

◆ apply

virtual void QgsMapLayerConfigWidget::apply ( )
pure virtualslot

Called when changes to the layer need to be made.

Will be called when live update is enabled.

◆ dynamicTemporalControlToggled

void QgsMapLayerConfigWidget::dynamicTemporalControlToggled ( bool  enabled)
signal

Emitted whenever the dynamic temporal control option is toggled in the associated layer properties dialog.

Note
Not available in Python bindings
Since
QGIS 3.20

◆ focusDefaultWidget

void QgsMapLayerConfigWidget::focusDefaultWidget ( )
virtualslot

Focuses the default widget for the page.

Since
QGIS 3.22

Definition at line 50 of file qgsmaplayerconfigwidget.cpp.

◆ setMapLayerConfigWidgetContext()

void QgsMapLayerConfigWidget::setMapLayerConfigWidgetContext ( const QgsMapLayerConfigWidgetContext context)
virtual

Sets the context under which the widget is being shown.

Subclasses should take care to call the base class implementation when overriding this method.

Definition at line 45 of file qgsmaplayerconfigwidget.cpp.

◆ shouldTriggerLayerRepaint()

virtual bool QgsMapLayerConfigWidget::shouldTriggerLayerRepaint ( ) const
inlinevirtual

Whether this config widget changes map layer properties in a way that triggerRepaint() should be called for the layer after applying changes.

This is true by default, but some config widgets (for example 3D rendering config) do not need layer repaint as they do not modify 2D map rendering.

Since
QGIS 3.8

Definition at line 136 of file qgsmaplayerconfigwidget.h.

◆ syncToLayer()

virtual void QgsMapLayerConfigWidget::syncToLayer ( QgsMapLayer layer)
inlinevirtual

Reset to original (vector layer) values.

Since
QGIS 3.14

Reimplemented in QgsPointCloudRendererPropertiesWidget, and QgsRendererMeshPropertiesWidget.

Definition at line 142 of file qgsmaplayerconfigwidget.h.

Member Data Documentation

◆ mLayer

QgsMapLayer* QgsMapLayerConfigWidget::mLayer = nullptr
protected

Definition at line 182 of file qgsmaplayerconfigwidget.h.

◆ mMapCanvas

QgsMapCanvas* QgsMapLayerConfigWidget::mMapCanvas = nullptr
protected

Definition at line 183 of file qgsmaplayerconfigwidget.h.

◆ mMapLayerConfigWidgetContext

QgsMapLayerConfigWidgetContext QgsMapLayerConfigWidget::mMapLayerConfigWidgetContext
protected

Definition at line 184 of file qgsmaplayerconfigwidget.h.


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