QGIS API Documentation 3.39.0-Master (699c004a5df)
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsLayerPropertiesWidget Class Reference

A widget which allows configuration of the properties of a single QgsSymbolLayer. More...

#include <qgslayerpropertieswidget.h>

Inheritance diagram for QgsLayerPropertiesWidget:
Inheritance graph
[legend]

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

QgsSymbolLayermLayer = nullptr
 
const QgsSymbolmSymbol = nullptr
 
QgsVectorLayermVectorLayer = nullptr
 

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.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ QgsLayerPropertiesWidget()

QgsLayerPropertiesWidget::QgsLayerPropertiesWidget ( QgsSymbolLayer layer,
const QgsSymbol symbol,
QgsVectorLayer vl,
QWidget *  parent = nullptr 
)

Constructor for QgsLayerPropertiesWidget.

Parameters
layerthe symbol layer
symbolthe symbol
vlassociated vector layer
parentparent widget

Definition at line 114 of file qgslayerpropertieswidget.cpp.

Member Function Documentation

◆ changed

void QgsLayerPropertiesWidget::changed ( )
signal

Emitted when the symbol layer configuration is changed in the widget.

◆ changeLayer

void QgsLayerPropertiesWidget::changeLayer ( QgsSymbolLayer layer)
signal

Emitted when the symbol layer is changed in the widget.

◆ context()

QgsSymbolWidgetContext QgsLayerPropertiesWidget::context ( ) const

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also
setContext()

Definition at line 174 of file qgslayerpropertieswidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLayerPropertiesWidget::createExpressionContext ( ) const
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.

◆ emitSignalChanged

void QgsLayerPropertiesWidget::emitSignalChanged ( )
slot

Definition at line 438 of file qgslayerpropertieswidget.cpp.

◆ layerTypeChanged

void QgsLayerPropertiesWidget::layerTypeChanged ( )
slot

Definition at line 318 of file qgslayerpropertieswidget.cpp.

◆ populateLayerTypes()

void QgsLayerPropertiesWidget::populateLayerTypes ( )
protected

Definition at line 185 of file qgslayerpropertieswidget.cpp.

◆ registerDataDefinedButton()

void QgsLayerPropertiesWidget::registerDataDefinedButton ( QgsPropertyOverrideButton button,
QgsSymbolLayer::Property  key 
)
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.

◆ setContext()

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.

Parameters
contextsymbol widget context
See also
context()

Definition at line 163 of file qgslayerpropertieswidget.cpp.

◆ setDockMode()

void QgsLayerPropertiesWidget::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 179 of file qgslayerpropertieswidget.cpp.

◆ updateSymbolLayerWidget()

void QgsLayerPropertiesWidget::updateSymbolLayerWidget ( QgsSymbolLayer layer)
protected

Definition at line 210 of file qgslayerpropertieswidget.cpp.

Member Data Documentation

◆ mLayer

QgsSymbolLayer* QgsLayerPropertiesWidget::mLayer = nullptr
protected

Definition at line 108 of file qgslayerpropertieswidget.h.

◆ mSymbol

const QgsSymbol* QgsLayerPropertiesWidget::mSymbol = nullptr
protected

Definition at line 110 of file qgslayerpropertieswidget.h.

◆ mVectorLayer

QgsVectorLayer* QgsLayerPropertiesWidget::mVectorLayer = nullptr
protected

Definition at line 111 of file qgslayerpropertieswidget.h.


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