SqlDatabaseWidget Class Reference

Widget for viewing and editing data in a SQL database.

#include <DataAnalysis/Widgets/sqldatabasewidget.h>

Inherits QWidget.

Public Types
enum	EditStrategy { OnFieldChange = QSqlTableModel::OnFieldChange , OnRowChange = QSqlTableModel::OnRowChange , OnManualSubmit = QSqlTableModel::OnManualSubmit }

Public Slots
void	appendRow ()
void	removeSelectedRow ()
void	revertChanges ()
void	select ()
void	setEditStrategy (EditStrategy editStrategy)
void	setFilter (const QString &filter)
void	setReadOnly (bool b)
void	setShowConfirmButtons (bool show)
void	setShowFilter (bool show)
void	setShowTableComboBox (bool show)
void	setTableSelectionOverride (const QString &table)
void	submitChanges ()

Signals
void	unsubmittedChangeMade ()
void	widgetUpdated ()

Public Member Functions
	SqlDatabaseWidget (QWidget *parent=nullptr)
	~SqlDatabaseWidget () override
EditStrategy	getEditStrategy () const
QString	getFilter () const
QSqlTableModel *	getModel () const
bool	getReadOnly () const
QItemSelectionModel *	getSelectionModel () const
bool	getShowConfirmButtons () const
bool	getShowFilter () const
bool	getShowTableComboBox () const
QString	getTableSelectionOverride () const
TableWidget *	getTableWidget ()
void	setModel (QSqlTableModel *model)
bool	updateWidget (QSqlDatabase &data)

Properties
EditStrategy	editStrategy
QString	filter
bool	readOnly
bool	showConfirmButtons
bool	showFilter
bool	showTableComboBox
QString	tableSelectionOverride

Member Enumeration Documentation

EditStrategy

enum EditStrategy

Enumerator
OnFieldChange
OnRowChange
OnManualSubmit

Constructor & Destructor Documentation

SqlDatabaseWidget()

SqlDatabaseWidget

(

QWidget *

parent = nullptr

)

~SqlDatabaseWidget()

~SqlDatabaseWidget ( )

overridedefault

Member Function Documentation

appendRow

void appendRow ( )

slot

getEditStrategy()

SqlDatabaseWidget::EditStrategy getEditStrategy

(

)

const

See also

setEditStrategy

getFilter()

QString getFilter

(

)

const

See also

setFilter

getModel()

QSqlTableModel * getModel

(

)

const

Returns

The table widget's data model

getReadOnly()

bool getReadOnly

(

)

const

See also

setReadOnly

getSelectionModel()

QItemSelectionModel * getSelectionModel

(

)

const

Returns

The table widget's selection model

getShowConfirmButtons()

bool getShowConfirmButtons

(

)

const

See also

setShowConfirmButtons

getShowFilter()

bool getShowFilter

(

)

const

See also

setShowFilter

getShowTableComboBox()

bool getShowTableComboBox

(

)

const

See also

setShowTableComboBox

getTableSelectionOverride()

QString getTableSelectionOverride

(

)

const

See also

setTableSelectionOverride

getTableWidget()

TableWidget * getTableWidget

(

)

removeSelectedRow

void removeSelectedRow ( )

slot

revertChanges

void revertChanges ( )

slot

When the table model is set to QSqlTableModel::OnManualSubmit, this method can be used to revert changes to the model.

select

void select ( )

slot

Calls QSqlTableModel::select on the table's QSqlTableModel. This can be useful for refreshing the the table view.

setEditStrategy

void setEditStrategy ( EditStrategy  editStrategy )

slot

Parameters

editStrategy

Set the desired edit strategy for when this widget is in read/write mode. See Qt documentation page for QSqlTableModel for more information.

setFilter

void setFilter ( const QString &  filter )

slot

Parameters

filter

Set data filtering by specifying contents of SQL WHERE statement

setModel()

void setModel

(

QSqlTableModel *

model

)

Parameters

model

Custom QSqlTableModel

Use this function to supply a custom data model.

setReadOnly

void setReadOnly ( bool  b )

slot

Parameters

b	Set to true to toggle widget into read only mode.

See also

getReadOnly

setShowConfirmButtons

void setShowConfirmButtons ( bool  show )

slot

Parameters

show	Toggle visibility of confirm data change buttons.

setShowFilter

void setShowFilter ( bool  show )

slot

Parameters

show	Set to true to toggle display of filter widget.

See also

getShowFilter

setShowTableComboBox

void setShowTableComboBox ( bool  show )

slot

Parameters

show	Toggle visibility of table selection combo box.

See also

setTableSelectionOverride

setTableSelectionOverride

void setTableSelectionOverride ( const QString &  table )

slot

Parameters

table

Name of the table that this widget will be locked to.

The table selection combo box will be ignored when an override table is set.

See also

setShowTableComboBox

submitChanges

void submitChanges ( )

slot

When the table model is set to QSqlTableModel::OnManualSubmit, this method can be used to submit changes to the model to be applied to the database.

unsubmittedChangeMade

void unsubmittedChangeMade ( )

signal

updateWidget()

bool updateWidget

(

QSqlDatabase &

data

)

widgetUpdated

void widgetUpdated ( )

signal

Property Documentation

editStrategy

EditStrategy editStrategy

readwrite

filter

QString filter

readwrite

readOnly

bool readOnly

readwrite

showConfirmButtons

bool showConfirmButtons

readwrite

showFilter

bool showFilter

readwrite

showTableComboBox

bool showTableComboBox

readwrite

tableSelectionOverride

QString tableSelectionOverride

readwrite