QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Member Functions | Protected Member Functions | List of all members
QgsNewVectorTableDialog Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 QgsNewVectorTableDialog (QgsAbstractDatabaseProviderConnection *conn, QWidget *parent=nullptr)
 QgsNewVectorTableDialog constructor. More...
 
bool createSpatialIndex ()
 Returns true if spatialindex checkbox is cheched. More...
 
QgsCoordinateReferenceSystem crs () const
 Returns the CRS. More...
 
QgsFields fields () const
 Returns the fields. More...
 
QString geometryColumnName () const
 Returns the geometry column name. More...
 
QgsWkbTypes::Type geometryType () const
 Returns the geometry type. More...
 
QString schemaName () const
 Returns the schema name. More...
 
void setCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the CRS to crs. More...
 
void setFields (const QgsFields &fields)
 Sets the fields to fields. More...
 
void setGeometryType (QgsWkbTypes::Type type)
 Sets the geometry type. More...
 
void setSchemaName (const QString &name)
 Sets the schema name. More...
 
void setTableName (const QString &name)
 Sets the table name. More...
 
QString tableName () const
 Returns the table name. More...
 
QStringList validationErrors () const
 Returns the validation errors or an empty list if the dialog is valid. More...
 

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
connectionDB connection, ownership is NOT transferred
parentoptional parent

Definition at line 24 of file qgsnewvectortabledialog.cpp.

Member Function Documentation

◆ createSpatialIndex()

bool QgsNewVectorTableDialog::createSpatialIndex ( )

Returns true if spatialindex checkbox is cheched.

Returns

Definition at line 330 of file qgsnewvectortabledialog.cpp.

◆ crs()

QgsCoordinateReferenceSystem QgsNewVectorTableDialog::crs ( ) const

Returns the CRS.

Definition at line 282 of file qgsnewvectortabledialog.cpp.

◆ fields()

QgsFields QgsNewVectorTableDialog::fields ( ) const

Returns the fields.

Definition at line 302 of file qgsnewvectortabledialog.cpp.

◆ geometryColumnName()

QString QgsNewVectorTableDialog::geometryColumnName ( ) const

Returns the geometry column name.

Definition at line 297 of file qgsnewvectortabledialog.cpp.

◆ geometryType()

QgsWkbTypes::Type QgsNewVectorTableDialog::geometryType ( ) const

Returns the geometry type.

Definition at line 307 of file qgsnewvectortabledialog.cpp.

◆ schemaName()

QString QgsNewVectorTableDialog::schemaName ( ) const

Returns the schema name.

Definition at line 292 of file qgsnewvectortabledialog.cpp.

◆ setCrs()

void QgsNewVectorTableDialog::setCrs ( const QgsCoordinateReferenceSystem crs)

Sets the CRS to crs.

Definition at line 277 of file qgsnewvectortabledialog.cpp.

◆ setFields()

void QgsNewVectorTableDialog::setFields ( const QgsFields fields)

Sets the fields to fields.

Definition at line 322 of file qgsnewvectortabledialog.cpp.

◆ setGeometryType()

void QgsNewVectorTableDialog::setGeometryType ( QgsWkbTypes::Type  type)

Sets the geometry type.

Definition at line 272 of file qgsnewvectortabledialog.cpp.

◆ setSchemaName()

void QgsNewVectorTableDialog::setSchemaName ( const QString &  name)

Sets the schema name.

Definition at line 262 of file qgsnewvectortabledialog.cpp.

◆ setTableName()

void QgsNewVectorTableDialog::setTableName ( const QString &  name)

Sets the table name.

Definition at line 267 of file qgsnewvectortabledialog.cpp.

◆ showEvent()

void QgsNewVectorTableDialog::showEvent ( QShowEvent *  event)
overrideprotected

Definition at line 395 of file qgsnewvectortabledialog.cpp.

◆ tableName()

QString QgsNewVectorTableDialog::tableName ( ) const

Returns the table name.

Definition at line 287 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 335 of file qgsnewvectortabledialog.cpp.


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