QGIS API Documentation 3.39.0-Master (699c004a5df)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsAdvancedDigitizingToolsRegistry Class Reference

Registry of available advanced digitizing tools. More...

#include <qgsadvanceddigitizingtoolsregistry.h>

Public Member Functions

 QgsAdvancedDigitizingToolsRegistry ()=default
 
 QgsAdvancedDigitizingToolsRegistry (const QgsAdvancedDigitizingToolsRegistry &rh)=delete
 
 ~QgsAdvancedDigitizingToolsRegistry ()
 
void addDefaultTools ()
 Adds the default tools shipped in QGIS.
 
bool addTool (QgsAdvancedDigitizingToolAbstractMetadata *toolMetaData)
 Adds an advanced digitizing tool (take ownership) and return true on success.
 
QgsAdvancedDigitizingToolsRegistryoperator= (const QgsAdvancedDigitizingToolsRegistry &rh)=delete
 
bool removeTool (const QString &name)
 Removes the advanced digitizing tool matching the provided name and return true on success.
 
QgsAdvancedDigitizingToolAbstractMetadatatoolMetadata (const QString &name)
 Returns the advanced digitizing tool matching the provided name or nullptr when no match available.
 
const QStringList toolMetadataNames () const
 Returns the list of registered tool names.
 

Detailed Description

Registry of available advanced digitizing tools.

QgsAdvancedDigitizingToolsRegistry is not usually directly created, but rather accessed through QgsGui::advancedDigitizingToolsRegistry().

Since
QGIS 3.40

Definition at line 123 of file qgsadvanceddigitizingtoolsregistry.h.

Constructor & Destructor Documentation

◆ QgsAdvancedDigitizingToolsRegistry() [1/2]

QgsAdvancedDigitizingToolsRegistry::QgsAdvancedDigitizingToolsRegistry ( )
default

◆ ~QgsAdvancedDigitizingToolsRegistry()

QgsAdvancedDigitizingToolsRegistry::~QgsAdvancedDigitizingToolsRegistry ( )

Definition at line 30 of file qgsadvanceddigitizingtoolsregistry.cpp.

◆ QgsAdvancedDigitizingToolsRegistry() [2/2]

QgsAdvancedDigitizingToolsRegistry::QgsAdvancedDigitizingToolsRegistry ( const QgsAdvancedDigitizingToolsRegistry rh)
delete

Member Function Documentation

◆ addDefaultTools()

void QgsAdvancedDigitizingToolsRegistry::addDefaultTools ( )

Adds the default tools shipped in QGIS.

Definition at line 35 of file qgsadvanceddigitizingtoolsregistry.cpp.

◆ addTool()

bool QgsAdvancedDigitizingToolsRegistry::addTool ( QgsAdvancedDigitizingToolAbstractMetadata toolMetaData)

Adds an advanced digitizing tool (take ownership) and return true on success.

Definition at line 46 of file qgsadvanceddigitizingtoolsregistry.cpp.

◆ operator=()

QgsAdvancedDigitizingToolsRegistry & QgsAdvancedDigitizingToolsRegistry::operator= ( const QgsAdvancedDigitizingToolsRegistry rh)
delete

◆ removeTool()

bool QgsAdvancedDigitizingToolsRegistry::removeTool ( const QString &  name)

Removes the advanced digitizing tool matching the provided name and return true on success.

Definition at line 57 of file qgsadvanceddigitizingtoolsregistry.cpp.

◆ toolMetadata()

QgsAdvancedDigitizingToolAbstractMetadata * QgsAdvancedDigitizingToolsRegistry::toolMetadata ( const QString &  name)

Returns the advanced digitizing tool matching the provided name or nullptr when no match available.

Definition at line 67 of file qgsadvanceddigitizingtoolsregistry.cpp.

◆ toolMetadataNames()

const QStringList QgsAdvancedDigitizingToolsRegistry::toolMetadataNames ( ) const

Returns the list of registered tool names.

Definition at line 75 of file qgsadvanceddigitizingtoolsregistry.cpp.


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