QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Member Functions | List of all members
QgsNewDatabaseTableNameDialog Class Reference

QgsNewDatabaseTableNameDialog is a dialog which allows selection of a DB schema and a new table name. More...

#include <qgsnewdatabasetablenamewidget.h>

Inheritance diagram for QgsNewDatabaseTableNameDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsNewDatabaseTableNameDialog (QgsBrowserGuiModel *browserModel=nullptr, const QStringList &providersFilter=QStringList(), QWidget *parent=nullptr)
 Constructs a new QgsNewDatabaseTableNameDialog. More...
 
QString dataProviderKey () const
 Returns the currently selected data item provider key. More...
 
bool isValid () const
 Returns true if the widget contains a valid new table name. More...
 
QString schema () const
 Returns the currently selected schema or file path (in case of filesystem-based DBs like spatialite or GPKG) for the new table. More...
 
QString table () const
 Returns the current name of the new table. More...
 
QString uri () const
 Returns the (possibly blank) string representation of the new table data source URI. More...
 
QString validationError () const
 Returns the validation error or an empty string is the widget status is valid. More...
 

Detailed Description

QgsNewDatabaseTableNameDialog is a dialog which allows selection of a DB schema and a new table name.

The table name is validated for uniqueness and the selected data item provider, schema and table names can be retrieved with getters.

Warning
The data provider that originated the data item provider must support the connections API
Since
QGIS 3.14

Definition at line 190 of file qgsnewdatabasetablenamewidget.h.

Constructor & Destructor Documentation

◆ QgsNewDatabaseTableNameDialog()

QgsNewDatabaseTableNameDialog::QgsNewDatabaseTableNameDialog ( QgsBrowserGuiModel browserModel = nullptr,
const QStringList &  providersFilter = QStringList(),
QWidget *  parent = nullptr 
)
explicit

Constructs a new QgsNewDatabaseTableNameDialog.

Parameters
browserModelan existing browser model (typically from app), if NULL an instance will be created
providersFilteroptional white list of data provider keys that should be shown in the widget, if not specified all providers data items with database capabilities will be shown
parentoptional parent for this widget

Definition at line 394 of file qgsnewdatabasetablenamewidget.cpp.

Member Function Documentation

◆ dataProviderKey()

QString QgsNewDatabaseTableNameDialog::dataProviderKey ( ) const

Returns the currently selected data item provider key.

Definition at line 424 of file qgsnewdatabasetablenamewidget.cpp.

◆ isValid()

bool QgsNewDatabaseTableNameDialog::isValid ( ) const

Returns true if the widget contains a valid new table name.

Definition at line 429 of file qgsnewdatabasetablenamewidget.cpp.

◆ schema()

QString QgsNewDatabaseTableNameDialog::schema ( ) const

Returns the currently selected schema or file path (in case of filesystem-based DBs like spatialite or GPKG) for the new table.

Definition at line 409 of file qgsnewdatabasetablenamewidget.cpp.

◆ table()

QString QgsNewDatabaseTableNameDialog::table ( ) const

Returns the current name of the new table.

Definition at line 419 of file qgsnewdatabasetablenamewidget.cpp.

◆ uri()

QString QgsNewDatabaseTableNameDialog::uri ( ) const

Returns the (possibly blank) string representation of the new table data source URI.

The URI might be invalid in case the widget is not in a valid state.

Definition at line 414 of file qgsnewdatabasetablenamewidget.cpp.

◆ validationError()

QString QgsNewDatabaseTableNameDialog::validationError ( ) const

Returns the validation error or an empty string is the widget status is valid.

Definition at line 434 of file qgsnewdatabasetablenamewidget.cpp.


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