QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
Public Slots | Public Member Functions | List of all members
QgsRendererMeshPropertiesWidget Class Reference

Widget for renderer properties of the mesh, contours (scalars) and vectors data associated with the mesh layer. More...

#include <qgsrenderermeshpropertieswidget.h>

Inheritance diagram for QgsRendererMeshPropertiesWidget:
Inheritance graph
[legend]

Public Slots

void apply () override
 Applies the settings made in the dialog. More...
 
- Public Slots inherited from QgsMapLayerConfigWidget
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...
 

Public Member Functions

 QgsRendererMeshPropertiesWidget (QgsMeshLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
 A widget to hold the renderer properties for a mesh layer. More...
 
void syncToLayer (QgsMapLayer *mapLayer) override
 Synchronize widgets state with associated map layer. More...
 
- Public Member Functions inherited from QgsMapLayerConfigWidget
 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...
 

Additional Inherited Members

- Signals inherited from QgsMapLayerConfigWidget
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...
 
- 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...
 
- Protected Attributes inherited from QgsMapLayerConfigWidget
QgsMapLayermLayer = nullptr
 
QgsMapCanvasmMapCanvas = nullptr
 
QgsMapLayerConfigWidgetContext mMapLayerConfigWidgetContext
 

Detailed Description

Widget for renderer properties of the mesh, contours (scalars) and vectors data associated with the mesh layer.

Definition at line 39 of file qgsrenderermeshpropertieswidget.h.

Constructor & Destructor Documentation

◆ QgsRendererMeshPropertiesWidget()

QgsRendererMeshPropertiesWidget::QgsRendererMeshPropertiesWidget ( QgsMeshLayer layer,
QgsMapCanvas canvas,
QWidget *  parent = nullptr 
)

A widget to hold the renderer properties for a mesh layer.

Parameters
layerThe mesh layer to style
canvasThe canvas object used
parentParent object

Definition at line 29 of file qgsrenderermeshpropertieswidget.cpp.

Member Function Documentation

◆ apply

void QgsRendererMeshPropertiesWidget::apply ( )
overrideslot

Applies the settings made in the dialog.

Definition at line 82 of file qgsrenderermeshpropertieswidget.cpp.

◆ syncToLayer()

void QgsRendererMeshPropertiesWidget::syncToLayer ( QgsMapLayer mapLayer)
overridevirtual

Synchronize widgets state with associated map layer.

Since
QGIS 3.22, replace syncToLayer() without argument

Reimplemented from QgsMapLayerConfigWidget.

Definition at line 143 of file qgsrenderermeshpropertieswidget.cpp.


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