QGIS API Documentation 3.39.0-Master (699c004a5df)
|
A widget which allows configuration of the properties of a single QgsSymbolLayer. More...
#include <qgslayerpropertieswidget.h>
Public Slots | |
void | emitSignalChanged () |
void | layerTypeChanged () |
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 | |
void | changed () |
Emitted when the symbol layer configuration is changed in the widget. | |
void | changeLayer (QgsSymbolLayer *layer) |
Emitted when the symbol layer is changed in the widget. | |
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. | |
Public Member Functions | |
QgsLayerPropertiesWidget (QgsSymbolLayer *layer, const QgsSymbol *symbol, QgsVectorLayer *vl, QWidget *parent=nullptr) | |
Constructor for QgsLayerPropertiesWidget. | |
QgsSymbolWidgetContext | context () const |
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. | |
void | setContext (const QgsSymbolWidgetContext &context) |
Sets the context in which the symbol 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. | |
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 |
Protected Member Functions | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
void | populateLayerTypes () |
void | registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key) |
Registers a data defined override button. | |
void | updateSymbolLayerWidget (QgsSymbolLayer *layer) |
Protected Member Functions inherited from QgsPanelWidget | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. | |
Protected Attributes | |
QgsSymbolLayer * | mLayer = nullptr |
const QgsSymbol * | mSymbol = nullptr |
QgsVectorLayer * | mVectorLayer = nullptr |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsPanelWidget | |
static QgsPanelWidget * | findParentPanel (QWidget *widget) |
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. | |
A widget which allows configuration of the properties of a single QgsSymbolLayer.
This widget includes a combobox box for selection of the symbol layer type, and a panel for showing configuration properties for the selected symbol layer type.
Definition at line 43 of file qgslayerpropertieswidget.h.
QgsLayerPropertiesWidget::QgsLayerPropertiesWidget | ( | QgsSymbolLayer * | layer, |
const QgsSymbol * | symbol, | ||
QgsVectorLayer * | vl, | ||
QWidget * | parent = nullptr |
||
) |
Constructor for QgsLayerPropertiesWidget.
layer | the symbol layer |
symbol | the symbol |
vl | associated vector layer |
parent | parent widget |
Definition at line 114 of file qgslayerpropertieswidget.cpp.
|
signal |
Emitted when the symbol layer configuration is changed in the widget.
|
signal |
Emitted when the symbol layer is changed in the widget.
QgsSymbolWidgetContext QgsLayerPropertiesWidget::context | ( | ) | const |
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
Definition at line 174 of file qgslayerpropertieswidget.cpp.
|
overrideprotectedvirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 243 of file qgslayerpropertieswidget.cpp.
|
slot |
Definition at line 438 of file qgslayerpropertieswidget.cpp.
|
slot |
Definition at line 318 of file qgslayerpropertieswidget.cpp.
|
protected |
Definition at line 185 of file qgslayerpropertieswidget.cpp.
|
protected |
Registers a data defined override button.
Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.
Definition at line 303 of file qgslayerpropertieswidget.cpp.
void QgsLayerPropertiesWidget::setContext | ( | const QgsSymbolWidgetContext & | context | ) |
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
context | symbol widget context |
Definition at line 163 of file qgslayerpropertieswidget.cpp.
|
overridevirtual |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
dockMode | true to enable dock mode. |
Reimplemented from QgsPanelWidget.
Definition at line 179 of file qgslayerpropertieswidget.cpp.
|
protected |
Definition at line 210 of file qgslayerpropertieswidget.cpp.
|
protected |
Definition at line 108 of file qgslayerpropertieswidget.h.
|
protected |
Definition at line 110 of file qgslayerpropertieswidget.h.
|
protected |
Definition at line 111 of file qgslayerpropertieswidget.h.