A widget which allows the user to modify the rendering order of extent buffers. More...

#include <qgsextentbufferdialog.h>

Inheritance diagram for QgsExtentBufferWidget:

[legend]

Public Member Functions
	QgsExtentBufferWidget (QgsSymbol symbol, QgsVectorLayer layer, QWidget *parent=nullptr)
	Constructor for QgsExtentBufferWidget.

QgsSymbolWidgetContext	context () const
	Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

QgsProperty	dataDefinedProperty () const
	Returns the data defined property currently set in the widget.

double	extentBuffer () const
	Returns the extent buffer value currently set in the widget.

void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which widget is shown, e.g., the associated map canvas and expression contexts.

Qgis::RenderUnit	sizeUnit () const
	Returns the extent buffer unit currently set in the widget.

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.

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

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

Additional Inherited Members
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 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.

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.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

A widget which allows the user to modify the rendering order of extent buffers.

See also: QgsExtentBufferDialog

Since: QGIS 3.42

Definition at line 37 of file qgsextentbufferdialog.h.

Constructor & Destructor Documentation

◆ QgsExtentBufferWidget()

QgsExtentBufferWidget::QgsExtentBufferWidget	(	QgsSymbol *	symbol,
		QgsVectorLayer *	layer,
		QWidget *	parent = `nullptr`
	)

Constructor for QgsExtentBufferWidget.

Definition at line 30 of file qgsextentbufferdialog.cpp.

Member Function Documentation

◆ context()

QgsSymbolWidgetContext QgsExtentBufferWidget::context ( ) const

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

See also: setContext()

Definition at line 52 of file qgsextentbufferdialog.cpp.

◆ dataDefinedProperty()

QgsProperty QgsExtentBufferWidget::dataDefinedProperty ( ) const

Returns the data defined property currently set in the widget.

Returns: property

Definition at line 107 of file qgsextentbufferdialog.cpp.

◆ extentBuffer()

double QgsExtentBufferWidget::extentBuffer ( ) const

Returns the extent buffer value currently set in the widget.

Returns: extent buffer value

Definition at line 102 of file qgsextentbufferdialog.cpp.

◆ setContext()

void QgsExtentBufferWidget::setContext ( const QgsSymbolWidgetContext & context )

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

Parameters

context symbol widget context

See also: context()

Definition at line 57 of file qgsextentbufferdialog.cpp.

◆ sizeUnit()

Qgis::RenderUnit QgsExtentBufferWidget::sizeUnit ( ) const

Returns the extent buffer unit currently set in the widget.

See also: setContext()

Definition at line 141 of file qgsextentbufferdialog.cpp.

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

/build/qgis-3.42.0+99sid/src/gui/symbology/qgsextentbufferdialog.h
/build/qgis-3.42.0+99sid/src/gui/symbology/qgsextentbufferdialog.cpp

Public Member Functions

Additional Inherited Members