QgsSymbolLevelsWidget Class Reference

A widget which allows the user to modify the rendering order of symbol layers. More...

#include <qgssymbollevelsdialog.h>

Inheritance diagram for QgsSymbolLevelsWidget:

Public Slots
Q_DECL_DEPRECATED void	apply ()
	Apply button.
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.

Public Member Functions
	QgsSymbolLevelsWidget (const QgsLegendSymbolList &symbols, bool usingSymbolLevels, QWidget *parent=nullptr)
	Constructor for QgsSymbolLevelsWidget, which takes a list of symbols to show in the dialog.
	QgsSymbolLevelsWidget (QgsFeatureRenderer *renderer, bool usingSymbolLevels, QWidget *parent=nullptr)
	Constructor for QgsSymbolLevelsWidget.
void	setForceOrderingEnabled (bool enabled)
	Sets whether the level ordering is always forced on and hide the checkbox (used by rule-based renderer)
QgsLegendSymbolList	symbolLevels () const
	Returns the current legend symbols with rendering passes set, as defined in the widget.
bool	usingLevels () const
	Returns whether the level ordering is enabled.
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.

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

See also

QgsSymbolLevelsDialog

Since

QGIS 3.0

Definition at line 37 of file qgssymbollevelsdialog.h.

Constructor & Destructor Documentation

QgsSymbolLevelsWidget() [1/2]

QgsSymbolLevelsWidget::QgsSymbolLevelsWidget	(	QgsFeatureRenderer *	renderer,
		bool	usingSymbolLevels,
		QWidget *	parent = nullptr
	)

Constructor for QgsSymbolLevelsWidget.

Definition at line 31 of file qgssymbollevelsdialog.cpp.

QgsSymbolLevelsWidget() [2/2]

QgsSymbolLevelsWidget::QgsSymbolLevelsWidget	(	const QgsLegendSymbolList &	symbols,
		bool	usingSymbolLevels,
		QWidget *	parent = nullptr
	)

Constructor for QgsSymbolLevelsWidget, which takes a list of symbols to show in the dialog.

Since

QGIS 3.20

Definition at line 37 of file qgssymbollevelsdialog.cpp.

Member Function Documentation

apply

void QgsSymbolLevelsWidget::apply ( )

slot

Apply button.

Deprecated:

since QGIS 3.20. Use symbolLevels() and manually apply the changes to the renderer as appropriate.

Definition at line 129 of file qgssymbollevelsdialog.cpp.

setForceOrderingEnabled()

void QgsSymbolLevelsWidget::setForceOrderingEnabled

(

bool

enabled

)

Sets whether the level ordering is always forced on and hide the checkbox (used by rule-based renderer)

Parameters

enabled

toggle level ordering

Definition at line 180 of file qgssymbollevelsdialog.cpp.

symbolLevels()

QgsLegendSymbolList QgsSymbolLevelsWidget::symbolLevels

(

)

const

Returns the current legend symbols with rendering passes set, as defined in the widget.

Since

QGIS 3.20

Definition at line 163 of file qgssymbollevelsdialog.cpp.

usingLevels()

bool QgsSymbolLevelsWidget::usingLevels

(

)

const

Returns whether the level ordering is enabled.

Definition at line 158 of file qgssymbollevelsdialog.cpp.

---

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

• /build/qgis-3.34.0+99sid/src/gui/symbology/qgssymbollevelsdialog.h
• /build/qgis-3.34.0+99sid/src/gui/symbology/qgssymbollevelsdialog.cpp