QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
A panel widget that can be shown in the map style dock. More...
#include <qgsmaplayerconfigwidget.h>
Public Slots | |
virtual void | apply ()=0 |
Called when changes to the layer need to be made. More... | |
![]() | |
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 | |
QgsMapLayerConfigWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr) | |
A panel widget that can be shown in the map style dock. 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... | |
![]() | |
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... | |
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 | |
QgsMapLayer * | mLayer = nullptr |
QgsMapCanvas * | mMapCanvas = nullptr |
Additional Inherited Members | |
![]() | |
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 QgsPanelWidget * | findParentPanel (QWidget *widget) |
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More... | |
![]() | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. More... | |
A panel widget that can be shown in the map style dock.
Definition at line 33 of file qgsmaplayerconfigwidget.h.
QgsMapLayerConfigWidget::QgsMapLayerConfigWidget | ( | QgsMapLayer * | layer, |
QgsMapCanvas * | canvas, | ||
QWidget * | parent = nullptr |
||
) |
A panel widget that can be shown in the map style dock.
layer | The layer active in the dock. |
canvas | The canvas object. |
parent | The parent of the widget. |
Definition at line 18 of file qgsmaplayerconfigwidget.cpp.
|
pure virtualslot |
Called when changes to the layer need to be made.
Will be called when live update is enabled.
|
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.
Definition at line 54 of file qgsmaplayerconfigwidget.h.
|
inlinevirtual |
Reset to original (vector layer) values.
Definition at line 60 of file qgsmaplayerconfigwidget.h.
|
protected |
Definition at line 71 of file qgsmaplayerconfigwidget.h.
|
protected |
Definition at line 72 of file qgsmaplayerconfigwidget.h.