KLayout Manual: Main Index » Class Index » API reference - Class QSqlRelation

API reference - Class QSqlRelation

Notation used in Ruby API documentation

Description: Binding of QSqlRelation

Public constructors

new QSqlRelationnewConstructor QSqlRelation::QSqlRelation()
new QSqlRelationnew(string aTableName,
string indexCol,
string displayCol)
Constructor QSqlRelation::QSqlRelation(const QString &aTableName, const QString &indexCol, const QString &displayCol)

Public methods

[const]voidassign(const QSqlRelation other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]stringdisplayColumnMethod QString QSqlRelation::displayColumn()
[const]QSqlRelationdupCreates a copy of self
[const]stringindexColumnMethod QString QSqlRelation::indexColumn()
[const]boolisValidMethod bool QSqlRelation::isValid()
[const]boolisValid?Method bool QSqlRelation::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]stringtableNameMethod QString QSqlRelation::tableName()

Detailed description

[const] void assign(const QSqlRelation other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] string displayColumn

Description: Method QString QSqlRelation::displayColumn()

[const] QSqlRelation dup

Description: Creates a copy of self

[const] string indexColumn

Description: Method QString QSqlRelation::indexColumn()

[const] bool isValid

Description: Method bool QSqlRelation::isValid()

[const] bool isValid?

Description: Method bool QSqlRelation::isValid()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QSqlRelation new

Description: Constructor QSqlRelation::QSqlRelation()

This method creates an object of class QSqlRelation.

[static] new QSqlRelation new(string aTableName,string indexCol,string displayCol)

Description: Constructor QSqlRelation::QSqlRelation(const QString &aTableName, const QString &indexCol, const QString &displayCol)

This method creates an object of class QSqlRelation.

[const] string tableName

Description: Method QString QSqlRelation::tableName()