The QgsNewVectorTableDialog class is a provider-agnostic database vector and aspatial table designer dialog based on the connections API. More...

#include <qgsnewvectortabledialog.h>

Inheritance diagram for QgsNewVectorTableDialog:

[legend]

Public Member Functions
	QgsNewVectorTableDialog (QgsAbstractDatabaseProviderConnection conn, QWidget parent=nullptr)
	QgsNewVectorTableDialog constructor.

bool	createSpatialIndex ()
	Returns `true` if spatialindex checkbox is checked.

QgsCoordinateReferenceSystem	crs () const
	Returns the CRS.

QgsFields	fields () const
	Returns the fields.

QString	geometryColumnName () const
	Returns the geometry column name.

Qgis::WkbType	geometryType () const
	Returns the geometry type.

QString	schemaName () const
	Returns the schema name.

void	setCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the CRS to crs.

void	setFields (const QgsFields &fields)
	Sets the fields to fields.

void	setGeometryType (Qgis::WkbType type)
	Sets the geometry type.

void	setSchemaName (const QString &name)
	Sets the schema name.

void	setTableName (const QString &name)
	Sets the table name.

QString	tableName () const
	Returns the table name.

QStringList	validationErrors () const
	Returns the validation errors or an empty list if the dialog is valid.

Protected Member Functions
void	showEvent (QShowEvent *event) override

Detailed Description

The QgsNewVectorTableDialog class is a provider-agnostic database vector and aspatial table designer dialog based on the connections API.

It allows designing a new vector or aspatial database table by defining the schema (if supported by the provider) and table name, the list of QgsFields, the optional geometry type and SRID.

The actual creation of the table is delegated to the connections API method QgsAbstractDatabaseProviderConnection::createVectorTable()

Since: QGIS 3.16

Definition at line 47 of file qgsnewvectortabledialog.h.

Constructor & Destructor Documentation

◆ QgsNewVectorTableDialog()

QgsNewVectorTableDialog::QgsNewVectorTableDialog	(	QgsAbstractDatabaseProviderConnection *	conn,
		QWidget *	parent = `nullptr`
	)

QgsNewVectorTableDialog constructor.

Parameters

conn	DB connection, ownership is NOT transferred
parent	optional parent

Definition at line 26 of file qgsnewvectortabledialog.cpp.

Member Function Documentation

◆ createSpatialIndex()

bool QgsNewVectorTableDialog::createSpatialIndex ( )

Returns true if spatialindex checkbox is checked.

Definition at line 351 of file qgsnewvectortabledialog.cpp.

◆ crs()

QgsCoordinateReferenceSystem QgsNewVectorTableDialog::crs ( ) const

Returns the CRS.

Definition at line 303 of file qgsnewvectortabledialog.cpp.

◆ fields()

QgsFields QgsNewVectorTableDialog::fields ( ) const

Returns the fields.

Definition at line 323 of file qgsnewvectortabledialog.cpp.

◆ geometryColumnName()

QString QgsNewVectorTableDialog::geometryColumnName ( ) const

Returns the geometry column name.

Definition at line 318 of file qgsnewvectortabledialog.cpp.

◆ geometryType()

Qgis::WkbType QgsNewVectorTableDialog::geometryType ( ) const

Returns the geometry type.

Definition at line 328 of file qgsnewvectortabledialog.cpp.

◆ schemaName()

QString QgsNewVectorTableDialog::schemaName ( ) const

Returns the schema name.

Definition at line 313 of file qgsnewvectortabledialog.cpp.

◆ setCrs()

void QgsNewVectorTableDialog::setCrs ( const QgsCoordinateReferenceSystem & crs )

Sets the CRS to crs.

Definition at line 298 of file qgsnewvectortabledialog.cpp.

◆ setFields()

void QgsNewVectorTableDialog::setFields ( const QgsFields & fields )

Sets the fields to fields.

Definition at line 343 of file qgsnewvectortabledialog.cpp.

◆ setGeometryType()

void QgsNewVectorTableDialog::setGeometryType ( Qgis::WkbType type )

Sets the geometry type.

Definition at line 293 of file qgsnewvectortabledialog.cpp.

◆ setSchemaName()

void QgsNewVectorTableDialog::setSchemaName ( const QString & name )

Sets the schema name.

Definition at line 283 of file qgsnewvectortabledialog.cpp.

◆ setTableName()

void QgsNewVectorTableDialog::setTableName ( const QString & name )

Sets the table name.

Definition at line 288 of file qgsnewvectortabledialog.cpp.

◆ showEvent()

void QgsNewVectorTableDialog::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 435 of file qgsnewvectortabledialog.cpp.

◆ tableName()

QString QgsNewVectorTableDialog::tableName ( ) const

Returns the table name.

Definition at line 308 of file qgsnewvectortabledialog.cpp.

◆ validationErrors()

QStringList QgsNewVectorTableDialog::validationErrors ( ) const

Returns the validation errors or an empty list if the dialog is valid.

Definition at line 356 of file qgsnewvectortabledialog.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgsnewvectortabledialog.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgsnewvectortabledialog.cpp

Public Member Functions

Protected Member Functions