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

Keeps track of the registered shape map tools. More...

#include <qgsmaptoolshaperegistry.h>

Public Member Functions

 QgsMapToolShapeRegistry ()
 Constructor. More...
 
 ~QgsMapToolShapeRegistry ()
 
void addMapTool (QgsMapToolShapeMetadata *mapTool SIP_TRANSFER)
 Adds a new shape map tool. More...
 
QgsMapToolShapeAbstractmapTool (const QString &id, QgsMapToolCapture *parentTool) const SIP_FACTORY
 Constructs the map tool at the given id for the given parentTool Caller takes ownership of the returned tool. More...
 
QgsMapToolShapeMetadatamapToolMetadata (const QString &id) const
 Returns the map tool metadata for the given id. More...
 
QList< QgsMapToolShapeMetadata * > mapToolMetadatas () const
 Returns the list of map tools. More...
 
void removeMapTool (const QString &id)
 Removes a registered map tool at the given id The tool will be deleted. More...
 

Detailed Description

Keeps track of the registered shape map tools.

Since
QGIS 3.26

Definition at line 35 of file qgsmaptoolshaperegistry.h.

Constructor & Destructor Documentation

◆ QgsMapToolShapeRegistry()

QgsMapToolShapeRegistry::QgsMapToolShapeRegistry ( )

Constructor.

Definition at line 21 of file qgsmaptoolshaperegistry.cpp.

◆ ~QgsMapToolShapeRegistry()

QgsMapToolShapeRegistry::~QgsMapToolShapeRegistry ( )

Definition at line 25 of file qgsmaptoolshaperegistry.cpp.

Member Function Documentation

◆ addMapTool()

void QgsMapToolShapeRegistry::addMapTool ( QgsMapToolShapeMetadata *mapTool  SIP_TRANSFER)

Adds a new shape map tool.

Definition at line 31 of file qgsmaptoolshaperegistry.cpp.

◆ mapTool()

QgsMapToolShapeAbstract * QgsMapToolShapeRegistry::mapTool ( const QString &  id,
QgsMapToolCapture parentTool 
) const

Constructs the map tool at the given id for the given parentTool Caller takes ownership of the returned tool.

Definition at line 70 of file qgsmaptoolshaperegistry.cpp.

◆ mapToolMetadata()

QgsMapToolShapeMetadata * QgsMapToolShapeRegistry::mapToolMetadata ( const QString &  id) const

Returns the map tool metadata for the given id.

Definition at line 59 of file qgsmaptoolshaperegistry.cpp.

◆ mapToolMetadatas()

QList< QgsMapToolShapeMetadata * > QgsMapToolShapeRegistry::mapToolMetadatas ( ) const
inline

Returns the list of map tools.

Definition at line 59 of file qgsmaptoolshaperegistry.h.

◆ removeMapTool()

void QgsMapToolShapeRegistry::removeMapTool ( const QString &  id)

Removes a registered map tool at the given id The tool will be deleted.

Definition at line 42 of file qgsmaptoolshaperegistry.cpp.


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