QGIS/python/gui/auto_generated/qgsnewdatabasetablenamewidget.sip.in

101 lines
3.2 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsnewdatabasetablenamewidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsNewDatabaseTableNameWidget : QWidget
{
%Docstring
The QgsNewDatabaseTableNameWidget class embeds the browser view to
select 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.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsnewdatabasetablenamewidget.h"
%End
public:
explicit QgsNewDatabaseTableNameWidget( QgsBrowserGuiModel *browserModel = 0,
const QStringList &providersFilter = QStringList(),
QWidget *parent = 0 );
%Docstring
Constructs a new QgsNewDatabaseTableNameWidget
:param browserModel: an existing browser model (typically from app), if NULL an instance will be created
:param providersFilter: optional white list of item provider names (not data providers!) that should be
shown in the widget, if not specified all providers data items with database capabilities will be shown
:param parent: optional parent for this widget
%End
QString schema();
%Docstring
Returns the currently selected schema for the new table
%End
QString table();
%Docstring
Returns the current name of the new table
%End
QString dataItemProviderName();
%Docstring
Returns the currently selected data item provider name (which is NOT the data provider key!) for the new table
%End
bool isValid() const;
%Docstring
Returns ``True`` if the widget contains a valid new table name
%End
QString validationError();
%Docstring
Returns the validation error or an empty string is the widget status is valid
%End
signals:
void validationChanged( bool isValid );
%Docstring
This signal is emitted whenever the validation status of the widget changes.
:param isValid: ``True`` if the current status of the widget is valid
%End
void schemaNameChanged( const QString &schemaName );
%Docstring
This signal is emitted when the user selects a schema.
:param schemaName: the name of the selected schema
%End
void tableNameChanged( const QString &tableName );
%Docstring
This signal is emitted when the user enters a table name
:param tableName: the name of the new table
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsnewdatabasetablenamewidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/