QgsLayerPropertiesWidget Class Reference

#include <qgslayerpropertieswidget.h>

Inheritance diagram for QgsLayerPropertiesWidget:

Public Slots
void	emitSignalChanged ()
void	layerTypeChanged ()
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	changed ()
void	changeLayer (QgsSymbolLayer *)
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
	QgsLayerPropertiesWidget (QgsSymbolLayer *layer, const QgsSymbol *symbol, QgsVectorLayer *vl, QWidget *parent=nullptr)
	Constructor for QgsLayerPropertiesWidget. More...
QgsSymbolWidgetContext	context () const
	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...
void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...
void	setDockMode (bool dockMode) override
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. 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...
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...
QString	panelTitle ()
	The title of the panel. More...
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget. More...
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface. More...
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. More...
void	populateLayerTypes ()
void	registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key)
	Registers a data defined override button. More...
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. More...

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. More...

Detailed Description

Definition at line 41 of file qgslayerpropertieswidget.h.

Constructor & Destructor Documentation

QgsLayerPropertiesWidget()

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

Constructor for QgsLayerPropertiesWidget.

Parameters

layer	the symbol layer
symbol	the symbol
vl	associated vector layer
parent	parent widget

Definition at line 92 of file qgslayerpropertieswidget.cpp.

Member Function Documentation

changed

void QgsLayerPropertiesWidget::changed ( )

signal

changeLayer

void QgsLayerPropertiesWidget::changeLayer ( QgsSymbolLayer *  )

signal

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()

Since

QGIS 3.0

Definition at line 145 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.

Since

QGIS 3.0

Implements QgsExpressionContextGenerator.

Definition at line 212 of file qgslayerpropertieswidget.cpp.

emitSignalChanged

void QgsLayerPropertiesWidget::emitSignalChanged ( )

slot

Definition at line 304 of file qgslayerpropertieswidget.cpp.

layerTypeChanged

void QgsLayerPropertiesWidget::layerTypeChanged ( )

slot

Definition at line 279 of file qgslayerpropertieswidget.cpp.

populateLayerTypes()

void QgsLayerPropertiesWidget::populateLayerTypes ( )

protected

Definition at line 156 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.

Since

QGIS 3.0

Definition at line 264 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

context

symbol widget context

See also

context()

Since

QGIS 3.0

Definition at line 136 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

dockMode

True to enable dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 150 of file qgslayerpropertieswidget.cpp.

updateSymbolLayerWidget()

void QgsLayerPropertiesWidget::updateSymbolLayerWidget ( QgsSymbolLayer *  layer )

protected

Definition at line 179 of file qgslayerpropertieswidget.cpp.

Member Data Documentation

mLayer

QgsSymbolLayer* QgsLayerPropertiesWidget::mLayer = nullptr

protected

Definition at line 101 of file qgslayerpropertieswidget.h.

mSymbol

const QgsSymbol* QgsLayerPropertiesWidget::mSymbol = nullptr

protected

Definition at line 103 of file qgslayerpropertieswidget.h.

mVectorLayer

QgsVectorLayer* QgsLayerPropertiesWidget::mVectorLayer = nullptr

protected

Definition at line 104 of file qgslayerpropertieswidget.h.

---

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

• /tmp/buildd/qgis-3.2.0+99unstable/src/gui/symbology/qgslayerpropertieswidget.h
• /tmp/buildd/qgis-3.2.0+99unstable/src/gui/symbology/qgslayerpropertieswidget.cpp