QSqlRelation Class Reference

\inmodule QtSql More...

#include <qsqlrelationaltablemodel.h>

Collaboration diagram for QSqlRelation:

Public Member Functions
	QSqlRelation ()
	Constructs an invalid QSqlRelation object.
	QSqlRelation (const QString &aTableName, const QString &indexCol, const QString &displayCol)
	Constructs a QSqlRelation object, where tableName is the SQL table name to which a foreign key refers, indexColumn is the foreign key, and displayColumn is the field that should be presented to the user.
void	swap (QSqlRelation &other) noexcept
	\memberswap{relation}
QString	tableName () const
	Returns the name of the table to which a foreign key refers.
QString	indexColumn () const
	Returns the index column from table tableName() to which a foreign key refers.
QString	displayColumn () const
	Returns the column from table tableName() that should be presented to the user instead of a foreign key.
bool	isValid () const noexcept
	Returns true if the QSqlRelation object is valid; otherwise returns false.

Detailed Description

\inmodule QtSql

The QSqlRelation class stores information about an SQL foreign key.

QSqlRelation is a helper class for QSqlRelationalTableModel. See QSqlRelationalTableModel::setRelation() and QSqlRelationalTableModel::relation() for details.

See also

QSqlRelationalTableModel, QSqlRelationalDelegate, {Relational Table Model Example}

Definition at line 18 of file qsqlrelationaltablemodel.h.

Constructor & Destructor Documentation

QSqlRelation() [1/2]

QSqlRelation::QSqlRelation ( )

inline

Constructs an invalid QSqlRelation object.

For such an object, the tableName(), indexColumn(), and displayColumn() functions return an empty string.

See also

isValid()

Definition at line 21 of file qsqlrelationaltablemodel.h.

QSqlRelation() [2/2]

QSqlRelation::QSqlRelation ( const QString & tableName, const QString & indexColumn, const QString & displayColumn )

inline

Constructs a QSqlRelation object, where tableName is the SQL table name to which a foreign key refers, indexColumn is the foreign key, and displayColumn is the field that should be presented to the user.

See also

tableName(), indexColumn(), displayColumn()

Definition at line 22 of file qsqlrelationaltablemodel.h.

Member Function Documentation

displayColumn()

QString QSqlRelation::displayColumn ( ) const

inline

Returns the column from table tableName() that should be presented to the user instead of a foreign key.

Definition at line 37 of file qsqlrelationaltablemodel.h.

indexColumn()

QString QSqlRelation::indexColumn ( ) const

inline

Returns the index column from table tableName() to which a foreign key refers.

Definition at line 35 of file qsqlrelationaltablemodel.h.

isValid()

bool QSqlRelation::isValid ( ) const

inlinenoexcept

Returns true if the QSqlRelation object is valid; otherwise returns false.

Definition at line 39 of file qsqlrelationaltablemodel.h.

swap()

void QSqlRelation::swap ( QSqlRelation & other )

inlinenoexcept

\memberswap{relation}

Definition at line 26 of file qsqlrelationaltablemodel.h.

tableName()

QString QSqlRelation::tableName ( ) const

inline

Returns the name of the table to which a foreign key refers.

Definition at line 33 of file qsqlrelationaltablemodel.h.

---

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

• qtbase/src/sql/models/qsqlrelationaltablemodel.h (55f46569f3e9688c2a07973923bfda68aa2b0c3e)
• qtbase/src/sql/models/qsqlrelationaltablemodel.cpp (55f46569f3e9688c2a07973923bfda68aa2b0c3e)