QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Member Functions | Public Attributes | List of all members
QgsLayoutItemGuiGroup Class Reference

Stores GUI metadata about a group of layout item classes. More...

#include <qgslayoutitemguiregistry.h>

Public Member Functions

 QgsLayoutItemGuiGroup (const QString &id=QString(), const QString &name=QString(), const QIcon &icon=QIcon())
 Constructor for QgsLayoutItemGuiGroup. More...
 

Public Attributes

QIcon icon
 Icon for group. More...
 
QString id
 Unique (untranslated) group ID string. More...
 
QString name
 Translated group name. More...
 

Detailed Description

Stores GUI metadata about a group of layout item classes.

QgsLayoutItemGuiGroup stores settings about groups of related layout item classes which should be presented to users grouped together.

For instance, the various basic shape creation tools would use QgsLayoutItemGuiGroup to display grouped within designer dialogs.

Since
QGIS 3.0

Definition at line 316 of file qgslayoutitemguiregistry.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemGuiGroup()

QgsLayoutItemGuiGroup::QgsLayoutItemGuiGroup ( const QString &  id = QString(),
const QString &  name = QString(),
const QIcon &  icon = QIcon() 
)
inline

Constructor for QgsLayoutItemGuiGroup.

Definition at line 323 of file qgslayoutitemguiregistry.h.

Member Data Documentation

◆ icon

QIcon QgsLayoutItemGuiGroup::icon

Icon for group.

Definition at line 342 of file qgslayoutitemguiregistry.h.

◆ id

QString QgsLayoutItemGuiGroup::id

Unique (untranslated) group ID string.

Definition at line 332 of file qgslayoutitemguiregistry.h.

◆ name

QString QgsLayoutItemGuiGroup::name

Translated group name.

Definition at line 337 of file qgslayoutitemguiregistry.h.


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