QgsDataItemGuiProviderUtils Class Reference

Utility functions for QgsDataItemGuiProviders. More...

#include <qgsdataitemguiproviderutils.h>

Static Public Member Functions
static void	addToSubMenu (QMenu *mainMenu, QAction *actionToAdd, const QString &subMenuName)
	Add an actionToAdd to the sub menu with subMenuName in mainMenu.
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 void	refreshChildWithName (QgsDataItem *item, const QString &name)
	Refresh child of item that has give name.
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 39 of file qgsdataitemguiproviderutils.h.

Member Function Documentation

addToSubMenu()

void QgsDataItemGuiProviderUtils::addToSubMenu ( QMenu * mainMenu, QAction * actionToAdd, const QString & subMenuName )

static

Add an actionToAdd to the sub menu with subMenuName in mainMenu.

If the sub menu with given name does not exist it will be created.

Parameters

mainMenu	The menu in which sub menu is search for or created.
actionToAdd	The action to add.
subMenuName	Translated name of the sub menu that is searched for or created.

Since

QGIS 4.0

Definition at line 230 of file qgsdataitemguiproviderutils.cpp.

deleteConnections()

template<class T>

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 50 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 70 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 151 of file qgsdataitemguiproviderutils.cpp.

refreshChildWithName()

void QgsDataItemGuiProviderUtils::refreshChildWithName ( QgsDataItem * item, const QString & name )

static

Refresh child of item that has give name.

Since

QGIS 4.0

Definition at line 252 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 57 of file qgsdataitemguiproviderutils.cpp.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/qgsdataitemguiproviderutils.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/qgsdataitemguiproviderutils.cpp