The QgsDatabaseTableComboBox class is a combo box which displays the list of tables for a specific database connection. More...

Inheritance diagram for QgsDatabaseTableComboBox:

[legend]

Public Slots
void	refreshTables ()
	Refreshes the list of available tables.

void	setConnectionName (const QString &connection, const QString &provider=QString())
	Sets the database connection name from which to retrieve the available tables.

void	setSchema (const QString &schema)
	Sets the schema from which to retrieve the available tables.

void	setTable (const QString &table, const QString &schema=QString())
	Sets the current table selected in the combo box.

Signals
void	tableChanged (const QString &table, const QString &schema=QString())
	Emitted whenever the currently selected table changes.

Public Member Functions
	QgsDatabaseTableComboBox (const QString &provider, const QString &connection, const QString &schema=QString(), QWidget *parent=nullptr)
	Constructor for QgsDatabaseTableComboBox, for the specified provider and connection.

	QgsDatabaseTableComboBox (QgsAbstractDatabaseProviderConnection connection, const QString &schema=QString(), QWidget parent=nullptr)
	Constructor for QgsDatabaseTableComboBox, for the specified connection.

bool	allowEmptyTable () const
	Returns `true` if the combobox allows the empty table ("not set") choice.

QComboBox *	comboBox ()
	Returns the combobox portion of the widget.

QString	currentSchema () const
	Returns the schema of the current table selected in the combo box.

QString	currentTable () const
	Returns the name of the current table selected in the combo box.

void	setAllowEmptyTable (bool allowEmpty)
	Sets whether an optional empty table ("not set") option is present in the combobox.

Detailed Description

The QgsDatabaseTableComboBox class is a combo box which displays the list of tables for a specific database connection.

Warning: The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the combobox to work correctly.

Definition at line 51 of file qgsdatabasetablecombobox.h.

Constructor & Destructor Documentation

QgsDatabaseTableComboBox::QgsDatabaseTableComboBox	(	const QString &	provider,
		const QString &	connection,
		const QString &	schema = `QString()`,
		QWidget *	parent = `nullptr`
	)

explicit

Constructor for QgsDatabaseTableComboBox, for the specified provider and connection.

The optional schema argument can be used to restrict the listed tables to a specific schema.

Warning: The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly.

QgsDatabaseTableComboBox::QgsDatabaseTableComboBox	(	QgsAbstractDatabaseProviderConnection *	connection,
		const QString &	schema = `QString()`,
		QWidget *	parent = `nullptr`
	)