QSqlRelation Class
The QSqlRelation class stores information about an SQL foreign key. More...
| Header: | #include <QSqlRelation> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Sql)target_link_libraries(mytarget PRIVATE Qt6::Sql) |
| qmake: | QT += sql |
Public Functions
| QSqlRelation() | |
| QSqlRelation(const QString &tableName, const QString &indexColumn, const QString &displayColumn) | |
| QString | displayColumn() const |
| QString | indexColumn() const |
| bool | isValid() const |
| void | swap(QSqlRelation &other) |
| QString | tableName() const |
Detailed Description
QSqlRelation is a helper class for QSqlRelationalTableModel. See QSqlRelationalTableModel::setRelation() and QSqlRelationalTableModel::relation() for details.
See also QSqlRelationalTableModel, QSqlRelationalDelegate, and Relational Table Model Example.
Member Function Documentation
QSqlRelation::QSqlRelation()
Constructs an invalid QSqlRelation object.
For such an object, the tableName(), indexColumn(), and displayColumn() functions return an empty string.
See also isValid().
QSqlRelation::QSqlRelation(const QString &tableName, const QString &indexColumn, const QString &displayColumn)
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(), and displayColumn().
QString QSqlRelation::displayColumn() const
Returns the column from table tableName() that should be presented to the user instead of a foreign key.
QString QSqlRelation::indexColumn() const
Returns the index column from table tableName() to which a foreign key refers.
[noexcept] bool QSqlRelation::isValid() const
Returns true if the QSqlRelation object is valid; otherwise returns false.
[noexcept] void QSqlRelation::swap(QSqlRelation &other)
Swaps this relation with other. This operation is very fast and never fails.
QString QSqlRelation::tableName() const
Returns the name of the table to which a foreign key refers.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
