QGIS/python/gui/auto_generated/qgsnewvectortabledialog.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

126 lines
3.2 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsnewvectortabledialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsNewVectorTableDialog : QDialog
{
%Docstring(signature="appended")
A dialog for customising new tables created on a database.
The :py:class:`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
:py:class:`QgsFields`, the optional geometry type and SRID.
The actual creation of the table is delegated to the connections API
method
:py:func:`QgsAbstractDatabaseProviderConnection.createVectorTable()`
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsnewvectortabledialog.h"
%End
public:
QgsNewVectorTableDialog( QgsAbstractDatabaseProviderConnection *conn, QWidget *parent /TransferThis/ = 0 );
%Docstring
QgsNewVectorTableDialog constructor
:param conn: DB connection, ownership is NOT transferred
:param parent: optional parent
%End
void setSchemaName( const QString &name );
%Docstring
Sets the schema ``name``
%End
void setTableName( const QString &name );
%Docstring
Sets the table ``name``
%End
void setGeometryType( Qgis::WkbType type );
%Docstring
Sets the geometry ``type``
%End
void setCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the CRS to ``crs``
%End
QgsCoordinateReferenceSystem crs() const;
%Docstring
Returns the CRS
%End
QString tableName() const;
%Docstring
Returns the table name
%End
QString schemaName() const;
%Docstring
Returns the schema name
%End
QString geometryColumnName() const;
%Docstring
Returns the geometry column name
%End
QgsFields fields() const;
%Docstring
Returns the fields
%End
Qgis::WkbType geometryType() const;
%Docstring
Returns the geometry type
%End
void setFields( const QgsFields &fields );
%Docstring
Sets the fields to ``fields``
%End
bool createSpatialIndex();
%Docstring
Returns ``True`` if spatialindex checkbox is checked.
%End
QStringList validationErrors() const;
%Docstring
Returns the validation errors or an empty list if the dialog is valid
%End
protected:
virtual void showEvent( QShowEvent *event );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsnewvectortabledialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/