QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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:
Inheritance graph
[legend]

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...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. 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 mLegendSymbols
 
int mMaxLayers
 maximal number of layers from all symbols More...
 
QgsFeatureRenderermRenderer = 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 QgsPanelWidgetfindParentPanel (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::QgsSymbolLevelsWidget ( QgsFeatureRenderer renderer,
bool  usingSymbolLevels,
QWidget *  parent = nullptr 
)

Constructor for QgsSymbolLevelsWidget.

Definition at line 32 of file qgssymbollevelsdialog.cpp.

Member Function Documentation

◆ apply

void QgsSymbolLevelsWidget::apply ( )
slot

Apply button.

Definition at line 130 of file qgssymbollevelsdialog.cpp.

◆ populateTable()

void QgsSymbolLevelsWidget::populateTable ( )
protected
Note
not available in Python bindings

Definition at line 93 of file qgssymbollevelsdialog.cpp.

◆ setDefaultLevels()

void QgsSymbolLevelsWidget::setDefaultLevels ( )
protected
Note
not available in Python bindings

Definition at line 144 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
enabledtoggle level ordering

Definition at line 173 of file qgssymbollevelsdialog.cpp.

◆ usingLevels()

bool QgsSymbolLevelsWidget::usingLevels ( ) const

Returns whether the level ordering is enabled.

Definition at line 156 of file qgssymbollevelsdialog.cpp.

Member Data Documentation

◆ mForceOrderingEnabled

bool QgsSymbolLevelsWidget::mForceOrderingEnabled
protected

whether symbol layers always should be used (default false)

Definition at line 75 of file qgssymbollevelsdialog.h.

◆ mLegendSymbols

QgsLegendSymbolList QgsSymbolLevelsWidget::mLegendSymbols
protected

Definition at line 72 of file qgssymbollevelsdialog.h.

◆ mMaxLayers

int QgsSymbolLevelsWidget::mMaxLayers
protected

maximal number of layers from all symbols

Definition at line 69 of file qgssymbollevelsdialog.h.

◆ mRenderer

QgsFeatureRenderer* QgsSymbolLevelsWidget::mRenderer = nullptr
protected

Definition at line 71 of file qgssymbollevelsdialog.h.


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