QGIS API Documentation 3.27.0-Master (75dc696944)
Public Member Functions | List of all members
QgsMapToolShapeMetadata Class Referenceabstract

QgsMapToolShapeMetadata is a base class for shape map tools metadata to be used in QgsMapToolShapeRegistry. More...

#include <qgsmaptoolshaperegistry.h>

Public Member Functions

 QgsMapToolShapeMetadata ()=default
 Constructor. More...
 
virtual ~QgsMapToolShapeMetadata ()=default
 
virtual QgsMapToolShapeAbstract::ShapeCategory category () const =0
 Returns the shape category of the tool. More...
 
virtual QgsMapToolShapeAbstractfactory (QgsMapToolCapture *parentlTool) const SIP_FACTORY=0
 Creates the shape map tool for the given parentTool Caller takes ownership of the returned object. More...
 
virtual QIcon icon () const =0
 Icon to be displayed in the toolbar. More...
 
virtual QString id () const =0
 Unique ID for the shape map tool. More...
 
virtual QString name () const =0
 Translated readable name. More...
 

Detailed Description

QgsMapToolShapeMetadata is a base class for shape map tools metadata to be used in QgsMapToolShapeRegistry.

Since
QGIS 3.26

Definition at line 81 of file qgsmaptoolshaperegistry.h.

Constructor & Destructor Documentation

◆ QgsMapToolShapeMetadata()

QgsMapToolShapeMetadata::QgsMapToolShapeMetadata ( )
default

Constructor.

◆ ~QgsMapToolShapeMetadata()

virtual QgsMapToolShapeMetadata::~QgsMapToolShapeMetadata ( )
virtualdefault

Member Function Documentation

◆ category()

virtual QgsMapToolShapeAbstract::ShapeCategory QgsMapToolShapeMetadata::category ( ) const
pure virtual

Returns the shape category of the tool.

◆ factory()

virtual QgsMapToolShapeAbstract * QgsMapToolShapeMetadata::factory ( QgsMapToolCapture parentlTool) const
pure virtual

Creates the shape map tool for the given parentTool Caller takes ownership of the returned object.

◆ icon()

virtual QIcon QgsMapToolShapeMetadata::icon ( ) const
pure virtual

Icon to be displayed in the toolbar.

◆ id()

virtual QString QgsMapToolShapeMetadata::id ( ) const
pure virtual

Unique ID for the shape map tool.

◆ name()

virtual QString QgsMapToolShapeMetadata::name ( ) const
pure virtual

Translated readable name.


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