QGIS API Documentation 3.43.0-Master (3ee7834ace6)
Static Public Member Functions | List of all members
QgsDataItemGuiProviderUtils Class Reference

Utility functions for QgsDataItemGuiProviders. More...

#include <qgsdataitemguiproviderutils.h>

Static Public Member Functions

template<class T >
static void deleteConnections (const QList< T * > &items, const std::function< void(const QString &)> &deleteConnection, QgsDataItemGuiContext context)
 Handles deletion of a list of connection items.
 
static bool handleDropUriForConnection (std::unique_ptr< QgsAbstractDatabaseProviderConnection > connection, const QgsMimeDataUtils::Uri &sourceUri, const QString &destinationSchema, QgsDataItemGuiContext context, const QString &shortTitle, const QString &longTitle, const QVariantMap &destinationProviderOptions, const std::function< void()> &onSuccessfulCompletion, const std::function< void(Qgis::VectorExportResult error, const QString &errorMessage)> &onError, QObject *connectionContext)
 Handles dropping a vector layer for connection items.
 
static void handleImportVectorLayerForConnection (std::unique_ptr< QgsAbstractDatabaseProviderConnection > connection, const QString &destinationSchema, QgsDataItemGuiContext context, const QString &shortTitle, const QString &longTitle, const QVariantMap &destinationProviderOptions, const std::function< void()> &onSuccessfulCompletion, const std::function< void(Qgis::VectorExportResult error, const QString &errorMessage)> &onError, QObject *connectionContext)
 Handles importing a vector layer for connection items.
 
static const QString uniqueName (const QString &name, const QStringList &connectionNames)
 Check if connection with name exists in connectionNames list and then try to append a number to it to get a unique name.
 

Detailed Description

Utility functions for QgsDataItemGuiProviders.

Since
QGIS 3.38

Definition at line 37 of file qgsdataitemguiproviderutils.h.

Member Function Documentation

◆ deleteConnections()

template<class T >
static void QgsDataItemGuiProviderUtils::deleteConnections ( const QList< T * > &  items,
const std::function< void(const QString &)> &  deleteConnection,
QgsDataItemGuiContext  context 
)
inlinestatic

Handles deletion of a list of connection items.

Note
Not available in Python bindings

Definition at line 48 of file qgsdataitemguiproviderutils.h.

◆ handleDropUriForConnection()

bool QgsDataItemGuiProviderUtils::handleDropUriForConnection ( std::unique_ptr< QgsAbstractDatabaseProviderConnection connection,
const QgsMimeDataUtils::Uri sourceUri,
const QString &  destinationSchema,
QgsDataItemGuiContext  context,
const QString &  shortTitle,
const QString &  longTitle,
const QVariantMap &  destinationProviderOptions,
const std::function< void()> &  onSuccessfulCompletion,
const std::function< void(Qgis::VectorExportResult error, const QString &errorMessage)> &  onError,
QObject *  connectionContext 
)
static

Handles dropping a vector layer for connection items.

Note
Not available in Python bindings

Definition at line 69 of file qgsdataitemguiproviderutils.cpp.

◆ handleImportVectorLayerForConnection()

void QgsDataItemGuiProviderUtils::handleImportVectorLayerForConnection ( std::unique_ptr< QgsAbstractDatabaseProviderConnection connection,
const QString &  destinationSchema,
QgsDataItemGuiContext  context,
const QString &  shortTitle,
const QString &  longTitle,
const QVariantMap &  destinationProviderOptions,
const std::function< void()> &  onSuccessfulCompletion,
const std::function< void(Qgis::VectorExportResult error, const QString &errorMessage)> &  onError,
QObject *  connectionContext 
)
static

Handles importing a vector layer for connection items.

Note
Not available in Python bindings

Definition at line 150 of file qgsdataitemguiproviderutils.cpp.

◆ uniqueName()

const QString QgsDataItemGuiProviderUtils::uniqueName ( const QString &  name,
const QStringList &  connectionNames 
)
static

Check if connection with name exists in connectionNames list and then try to append a number to it to get a unique name.

Note
Not available in Python bindings
Since
QGIS 3.40

Definition at line 56 of file qgsdataitemguiproviderutils.cpp.


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