QGIS API Documentation  3.21.0-Master (402cf1129e)
Public Member Functions | Public Attributes | List of all members
QgsStyleEntityVisitorInterface::StyleLeaf Struct Reference

Contains information relating to the style entity currently being visited. More...

#include <qgsstyleentityvisitor.h>

Public Member Functions

 StyleLeaf (const QgsStyleEntityInterface *entity, const QString &identifier=QString(), const QString &description=QString())
 Constructor for StyleLeaf, visiting the given style entity with the specified identifier and description. More...
 

Public Attributes

QString description
 A string describing the style entity. More...
 
const QgsStyleEntityInterfaceentity = nullptr
 Reference to style entity being visited. More...
 
QString identifier
 A string identifying the style entity. More...
 

Detailed Description

Contains information relating to the style entity currently being visited.

Definition at line 60 of file qgsstyleentityvisitor.h.

Constructor & Destructor Documentation

◆ StyleLeaf()

QgsStyleEntityVisitorInterface::StyleLeaf::StyleLeaf ( const QgsStyleEntityInterface entity,
const QString &  identifier = QString(),
const QString &  description = QString() 
)
inline

Constructor for StyleLeaf, visiting the given style entity with the specified identifier and description.

Ownership of entity is not transferred.

Definition at line 68 of file qgsstyleentityvisitor.h.

Member Data Documentation

◆ description

QString QgsStyleEntityVisitorInterface::StyleLeaf::description

A string describing the style entity.

The actual value of description will vary depending on the class being visited. E.g for a categorized renderer, the description will be the category label associated with the symbol, for a print layout, it will be the name of the layout in the project.

This may be blank if no description is associated with a style entity, e.g. when a renderer has a single symbol only.

This value may be a generic, translated value in some cases, e.g. "Grid" or "Overview".

Definition at line 98 of file qgsstyleentityvisitor.h.

◆ entity

const QgsStyleEntityInterface* QgsStyleEntityVisitorInterface::StyleLeaf::entity = nullptr

Reference to style entity being visited.

Definition at line 103 of file qgsstyleentityvisitor.h.

◆ identifier

QString QgsStyleEntityVisitorInterface::StyleLeaf::identifier

A string identifying the style entity.

The actual value of identifier will vary depending on the class being visited. E.g for a categorized renderer, the identifier will be the category ID associated with the symbol.

This may be blank if no identifier is required, e.g. when a renderer has a single symbol only.

Note that in some cases where a specific identifier is not available, a generic, untranslated one may be used (e.g. "overview", "grid").

Definition at line 85 of file qgsstyleentityvisitor.h.


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