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
void	apply ()
	Apply button. More...
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...

Public Member Functions
	QgsSymbolLevelsWidget (QgsFeatureRenderer *renderer, bool usingSymbolLevels, QWidget *parent=nullptr)
	Constructor for QgsSymbolLevelsWidget. More...
void	setForceOrderingEnabled (bool enabled)
	Sets whether the level ordering is always forced on and hide the checkbox (used by rule-based renderer) More...
bool	usingLevels () const
	Returns whether the level ordering is enabled. 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...
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface. More...

Protected Member Functions
void	populateTable ()
void	setDefaultLevels ()
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
bool	mForceOrderingEnabled
	whether symbol layers always should be used (default false) More...
QgsLegendSymbolList	mList
int	mMaxLayers
	maximal number of layers from all symbols More...
QgsFeatureRenderer *	mRenderer = nullptr

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

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::QgsSymbolLevelsWidget	(	QgsFeatureRenderer *	renderer,
		bool	usingSymbolLevels,
		QWidget *	parent = nullptr
	)

Constructor for QgsSymbolLevelsWidget.

Definition at line 32 of file qgssymbollevelsdialog.cpp.

Member Function Documentation

void QgsSymbolLevelsWidget::apply ( )

slot

Apply button.

Definition at line 129 of file qgssymbollevelsdialog.cpp.

void QgsSymbolLevelsWidget::populateTable ( )

protected

Note

not available in Python bindings

Definition at line 92 of file qgssymbollevelsdialog.cpp.

void QgsSymbolLevelsWidget::setDefaultLevels ( )

protected

Note

not available in Python bindings

Definition at line 143 of file qgssymbollevelsdialog.cpp.

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 172 of file qgssymbollevelsdialog.cpp.

bool QgsSymbolLevelsWidget::usingLevels

(

)

const

Returns whether the level ordering is enabled.

Definition at line 155 of file qgssymbollevelsdialog.cpp.

Member Data Documentation

bool QgsSymbolLevelsWidget::mForceOrderingEnabled

protected

whether symbol layers always should be used (default false)

Definition at line 75 of file qgssymbollevelsdialog.h.

QgsLegendSymbolList QgsSymbolLevelsWidget::mList

protected

Definition at line 72 of file qgssymbollevelsdialog.h.

int QgsSymbolLevelsWidget::mMaxLayers

protected

maximal number of layers from all symbols

Definition at line 69 of file qgssymbollevelsdialog.h.

QgsFeatureRenderer* QgsSymbolLevelsWidget::mRenderer = nullptr

protected

Definition at line 71 of file qgssymbollevelsdialog.h.

---

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

• /build/qgis-3.4.15+24xenial/src/gui/symbology/qgssymbollevelsdialog.h
• /build/qgis-3.4.15+24xenial/src/gui/symbology/qgssymbollevelsdialog.cpp