API reference - Class QSqlIndex

Notation used in Ruby API documentation

Description: Binding of QSqlIndex

Class hierarchy: QSqlIndex » QSqlRecord

Public constructors

new QSqlIndexnew(string cursorName = QString(),
string name = QString())
Constructor QSqlIndex::QSqlIndex(const QString &cursorName, const QString &name)
new QSqlIndexnew(const QSqlIndex other)Constructor QSqlIndex::QSqlIndex(const QSqlIndex &other)

Public methods

voidappend(const QSqlField field)Method void QSqlIndex::append(const QSqlField &field)
voidappend(const QSqlField field,
bool desc)
Method void QSqlIndex::append(const QSqlField &field, bool desc)
QSqlIndexassign(const QSqlIndex other)Method QSqlIndex &QSqlIndex::operator=(const QSqlIndex &other)
[const]voidassign(const QSqlIndex other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
[const]stringcursorNameMethod QString QSqlIndex::cursorName()
voidcursorName=(string cursorName)Method void QSqlIndex::setCursorName(const QString &cursorName)
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QSqlIndexdupCreates a copy of self
[const]boolisDescending(int i)Method bool QSqlIndex::isDescending(int i)
[const]boolisDescending?(int i)Method bool QSqlIndex::isDescending(int i)
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]stringnameMethod QString QSqlIndex::name()
voidname=(string name)Method void QSqlIndex::setName(const QString &name)
voidsetCursorName(string cursorName)Method void QSqlIndex::setCursorName(const QString &cursorName)
voidsetDescending(int i,
bool desc)
Method void QSqlIndex::setDescending(int i, bool desc)
voidsetName(string name)Method void QSqlIndex::setName(const QString &name)

Detailed description

void append(const QSqlField field)

Description: Method void QSqlIndex::append(const QSqlField &field)

void append(const QSqlField field,bool desc)

Description: Method void QSqlIndex::append(const QSqlField &field, bool desc)

QSqlIndex assign(const QSqlIndex other)

Description: Method QSqlIndex &QSqlIndex::operator=(const QSqlIndex &other)

[const] void assign(const QSqlIndex 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.

[const] string cursorName

Description: Method QString QSqlIndex::cursorName()

void cursorName=(string cursorName)

Description: Method void QSqlIndex::setCursorName(const QString &cursorName)

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] QSqlIndex dup

Description: Creates a copy of self

[const] bool isDescending(int i)

Description: Method bool QSqlIndex::isDescending(int i)

[const] bool isDescending?(int i)

Description: Method bool QSqlIndex::isDescending(int i)

[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.

[const] string name

Description: Method QString QSqlIndex::name()

void name=(string name)

Description: Method void QSqlIndex::setName(const QString &name)

[static] new QSqlIndex new(string cursorName = QString(),string name = QString())

Description: Constructor QSqlIndex::QSqlIndex(const QString &cursorName, const QString &name)

This method creates an object of class QSqlIndex.

[static] new QSqlIndex new(const QSqlIndex other)

Description: Constructor QSqlIndex::QSqlIndex(const QSqlIndex &other)

This method creates an object of class QSqlIndex.

void setCursorName(string cursorName)

Description: Method void QSqlIndex::setCursorName(const QString &cursorName)

void setDescending(int i,bool desc)

Description: Method void QSqlIndex::setDescending(int i, bool desc)

void setName(string name)

Description: Method void QSqlIndex::setName(const QString &name)