QgsDbImportVectorLayerDialog Class Reference

A generic dialog for customising vector layer import options for database connections. More...

#include <qgsdbimportvectorlayerdialog.h>

Inheritance diagram for QgsDbImportVectorLayerDialog:

Public Member Functions
	QgsDbImportVectorLayerDialog (QgsAbstractDatabaseProviderConnection *connection, QWidget *parent=nullptr)
	Constructor for QgsDbImportVectorLayerDialog.
	~QgsDbImportVectorLayerDialog () override
std::unique_ptr< QgsVectorLayerExporterTask >	createExporterTask (const QVariantMap &extraProviderOptions=QVariantMap())
	Creates a new exporter task to match the settings defined in the dialog.
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
QString	schema () const
	Returns the destination schema.
void	setDestinationSchema (const QString &schema)
	Sets the destination schema for the new table.
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets a map canvas to associate with the dialog.
void	setSourceUri (const QgsMimeDataUtils::Uri &uri)
	Sets the source table uri.
QString	tableComment () const
	Returns the optional comment to use for the new table.
QString	tableName () const
	Returns the destination table name.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Detailed Description

A generic dialog for customising vector layer import options for database connections.

Note

Not available in Python bindings

Since

QGIS 3.44

Definition at line 40 of file qgsdbimportvectorlayerdialog.h.

Constructor & Destructor Documentation

QgsDbImportVectorLayerDialog()

QgsDbImportVectorLayerDialog::QgsDbImportVectorLayerDialog	(	QgsAbstractDatabaseProviderConnection *	connection,
		QWidget *	parent = nullptr
	)

Constructor for QgsDbImportVectorLayerDialog.

Ownership of connection is transferred to the dialog.

Definition at line 27 of file qgsdbimportvectorlayerdialog.cpp.

~QgsDbImportVectorLayerDialog()

QgsDbImportVectorLayerDialog::~QgsDbImportVectorLayerDialog ( )

overridedefault

Member Function Documentation

createExporterTask()

std::unique_ptr< QgsVectorLayerExporterTask > QgsDbImportVectorLayerDialog::createExporterTask

(

const QVariantMap &

extraProviderOptions = QVariantMap()

)

Creates a new exporter task to match the settings defined in the dialog.

Definition at line 272 of file qgsdbimportvectorlayerdialog.cpp.

createExpressionContext()

QgsExpressionContext QgsDbImportVectorLayerDialog::createExpressionContext ( ) const

overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 341 of file qgsdbimportvectorlayerdialog.cpp.

schema()

QString QgsDbImportVectorLayerDialog::schema

(

)

const

Returns the destination schema.

Definition at line 241 of file qgsdbimportvectorlayerdialog.cpp.

setDestinationSchema()

void QgsDbImportVectorLayerDialog::setDestinationSchema

(

const QString &

schema

)

Sets the destination schema for the new table.

Definition at line 108 of file qgsdbimportvectorlayerdialog.cpp.

setMapCanvas()

void QgsDbImportVectorLayerDialog::setMapCanvas

(

QgsMapCanvas *

canvas

)

Sets a map canvas to associate with the dialog.

Definition at line 256 of file qgsdbimportvectorlayerdialog.cpp.

setSourceUri()

void QgsDbImportVectorLayerDialog::setSourceUri

(

const QgsMimeDataUtils::Uri &

uri

)

Sets the source table uri.

Definition at line 114 of file qgsdbimportvectorlayerdialog.cpp.

tableComment()

QString QgsDbImportVectorLayerDialog::tableComment

(

)

const

Returns the optional comment to use for the new table.

Definition at line 251 of file qgsdbimportvectorlayerdialog.cpp.

tableName()

QString QgsDbImportVectorLayerDialog::tableName

(

)

const

Returns the destination table name.

Definition at line 246 of file qgsdbimportvectorlayerdialog.cpp.

---

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

• /build/qgis-3.43.0+git20250312+9e873c7bc91+99sid/src/gui/qgsdbimportvectorlayerdialog.h
• /build/qgis-3.43.0+git20250312+9e873c7bc91+99sid/src/gui/qgsdbimportvectorlayerdialog.cpp