QGIS API Documentation 3.41.0-Master (57ec4277f5e)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsLabelingEngineRulesDialog Class Reference

A dialog which allows configuration of a list of labeling engine rules. More...

#include <qgslabelingengineruleswidget.h>

Inheritance diagram for QgsLabelingEngineRulesDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsLabelingEngineRulesDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=QgsGuiUtils::ModalDialogFlags)
 Constructor for QgsLabelingEngineRulesDialog.
 
QList< QgsAbstractLabelingEngineRule * > rules () const
 Returns the rules shown in the dialog.
 
void setRules (const QList< QgsAbstractLabelingEngineRule * > &rules)
 Sets the rules to show in the dialog.
 

Detailed Description

A dialog which allows configuration of a list of labeling engine rules.

This dialog allows users to add, remove, and edit the properties of a list of QgsAbstractLabelingEngineRule objects.

See also
QgsLabelingEngineRulesWidget()
Since
QGIS 3.40

Definition at line 164 of file qgslabelingengineruleswidget.h.

Constructor & Destructor Documentation

◆ QgsLabelingEngineRulesDialog()

QgsLabelingEngineRulesDialog::QgsLabelingEngineRulesDialog ( QWidget *  parent = nullptr,
Qt::WindowFlags  flags = QgsGuiUtils::ModalDialogFlags 
)

Constructor for QgsLabelingEngineRulesDialog.

Parameters
parentparent widget
flagswindow flags for dialog

Definition at line 401 of file qgslabelingengineruleswidget.cpp.

Member Function Documentation

◆ rules()

QList< QgsAbstractLabelingEngineRule * > QgsLabelingEngineRulesDialog::rules ( ) const

Returns the rules shown in the dialog.

The caller takes ownership of all returned rules.

Definition at line 430 of file qgslabelingengineruleswidget.cpp.

◆ setRules()

void QgsLabelingEngineRulesDialog::setRules ( const QList< QgsAbstractLabelingEngineRule * > &  rules)

Sets the rules to show in the dialog.

Ownership is not transferred, an internal copy will be made.

Definition at line 425 of file qgslabelingengineruleswidget.cpp.


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