API reference - Class QSqlRecord

Notation used in Ruby API documentation

Module: QtSql

Description: Binding of QSqlRecord

Public constructors

new QSqlRecordnewConstructor QSqlRecord::QSqlRecord()
new QSqlRecordnew(const QSqlRecord other)Constructor QSqlRecord::QSqlRecord(const QSqlRecord &other)

Public methods

[const]bool!=(const QSqlRecord other)Method bool QSqlRecord::operator!=(const QSqlRecord &other)
[const]bool==(const QSqlRecord other)Method bool QSqlRecord::operator==(const QSqlRecord &other)
void_assign(const QSqlRecord other)Assigns another object to self
[const]QSqlRecord ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidappend(const QSqlField field)Method void QSqlRecord::append(const QSqlField &field)
QSqlRecordassign(const QSqlRecord other)Method QSqlRecord &QSqlRecord::operator=(const QSqlRecord &other)
voidclearMethod void QSqlRecord::clear()
voidclearValuesMethod void QSqlRecord::clearValues()
[const]boolcontains(string name)Method bool QSqlRecord::contains(const QString &name)
[const]intcountMethod int QSqlRecord::count()
[const]new QSqlRecord ptrdupCreates a copy of self
[const]QSqlFieldfield(int i)Method QSqlField QSqlRecord::field(int i)
[const]QSqlFieldfield(string name)Method QSqlField QSqlRecord::field(const QString &name)
[const]stringfieldName(int i)Method QString QSqlRecord::fieldName(int i)
[const]intindexOf(string name)Method int QSqlRecord::indexOf(const QString &name)
voidinsert(int pos,
const QSqlField field)
Method void QSqlRecord::insert(int pos, const QSqlField &field)
[const]boolisEmpty?Method bool QSqlRecord::isEmpty()
[const]boolisGenerated?(int i)Method bool QSqlRecord::isGenerated(int i)
[const]boolisGenerated?(string name)Method bool QSqlRecord::isGenerated(const QString &name)
[const]boolisNull?(int i)Method bool QSqlRecord::isNull(int i)
[const]boolisNull?(string name)Method bool QSqlRecord::isNull(const QString &name)
[const]QSqlRecordkeyValues(const QSqlRecord keyFields)Method QSqlRecord QSqlRecord::keyValues(const QSqlRecord &keyFields)
voidremove(int pos)Method void QSqlRecord::remove(int pos)
voidreplace(int pos,
const QSqlField field)
Method void QSqlRecord::replace(int pos, const QSqlField &field)
voidsetGenerated(string name,
bool generated)
Method void QSqlRecord::setGenerated(const QString &name, bool generated)
voidsetGenerated(int i,
bool generated)
Method void QSqlRecord::setGenerated(int i, bool generated)
voidsetNull(int i)Method void QSqlRecord::setNull(int i)
voidsetNull(string name)Method void QSqlRecord::setNull(const QString &name)
voidsetValue(int i,
variant val)
Method void QSqlRecord::setValue(int i, const QVariant &val)
voidsetValue(string name,
variant val)
Method void QSqlRecord::setValue(const QString &name, const QVariant &val)
[const]variantvalue(int i)Method QVariant QSqlRecord::value(int i)
[const]variantvalue(string name)Method QVariant QSqlRecord::value(const QString &name)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QSqlRecord other)

Description: Method bool QSqlRecord::operator!=(const QSqlRecord &other)

==

Signature: [const] bool == (const QSqlRecord other)

Description: Method bool QSqlRecord::operator==(const QSqlRecord &other)

_assign

Signature: void _assign (const QSqlRecord other)

Description: Assigns another object to self

_const_cast

Signature: [const] QSqlRecord ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

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

_destroyed?

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

_is_const_object?

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

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

append

Signature: void append (const QSqlField field)

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

assign

Signature: QSqlRecord assign (const QSqlRecord other)

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

clear

Signature: void clear

Description: Method void QSqlRecord::clear()

clearValues

Signature: void clearValues

Description: Method void QSqlRecord::clearValues()

contains

Signature: [const] bool contains (string name)

Description: Method bool QSqlRecord::contains(const QString &name)

count

Signature: [const] int count

Description: Method int QSqlRecord::count()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QSqlRecord ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

field

(1) Signature: [const] QSqlField field (int i)

Description: Method QSqlField QSqlRecord::field(int i)

(2) Signature: [const] QSqlField field (string name)

Description: Method QSqlField QSqlRecord::field(const QString &name)

fieldName

Signature: [const] string fieldName (int i)

Description: Method QString QSqlRecord::fieldName(int i)

indexOf

Signature: [const] int indexOf (string name)

Description: Method int QSqlRecord::indexOf(const QString &name)

insert

Signature: void insert (int pos, const QSqlField field)

Description: Method void QSqlRecord::insert(int pos, const QSqlField &field)

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QSqlRecord::isEmpty()

isGenerated?

(1) Signature: [const] bool isGenerated? (int i)

Description: Method bool QSqlRecord::isGenerated(int i)

(2) Signature: [const] bool isGenerated? (string name)

Description: Method bool QSqlRecord::isGenerated(const QString &name)

isNull?

(1) Signature: [const] bool isNull? (int i)

Description: Method bool QSqlRecord::isNull(int i)

(2) Signature: [const] bool isNull? (string name)

Description: Method bool QSqlRecord::isNull(const QString &name)

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

keyValues

Signature: [const] QSqlRecord keyValues (const QSqlRecord keyFields)

Description: Method QSqlRecord QSqlRecord::keyValues(const QSqlRecord &keyFields)

new

(1) Signature: [static] new QSqlRecord new

Description: Constructor QSqlRecord::QSqlRecord()

This method creates an object of class QSqlRecord.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSqlRecord new (const QSqlRecord other)

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

This method creates an object of class QSqlRecord.

Python specific notes:
This method is the default initializer of the object.

remove

Signature: void remove (int pos)

Description: Method void QSqlRecord::remove(int pos)

replace

Signature: void replace (int pos, const QSqlField field)

Description: Method void QSqlRecord::replace(int pos, const QSqlField &field)

setGenerated

(1) Signature: void setGenerated (string name, bool generated)

Description: Method void QSqlRecord::setGenerated(const QString &name, bool generated)

(2) Signature: void setGenerated (int i, bool generated)

Description: Method void QSqlRecord::setGenerated(int i, bool generated)

setNull

(1) Signature: void setNull (int i)

Description: Method void QSqlRecord::setNull(int i)

(2) Signature: void setNull (string name)

Description: Method void QSqlRecord::setNull(const QString &name)

setValue

(1) Signature: void setValue (int i, variant val)

Description: Method void QSqlRecord::setValue(int i, const QVariant &val)

(2) Signature: void setValue (string name, variant val)

Description: Method void QSqlRecord::setValue(const QString &name, const QVariant &val)

value

(1) Signature: [const] variant value (int i)

Description: Method QVariant QSqlRecord::value(int i)

(2) Signature: [const] variant value (string name)

Description: Method QVariant QSqlRecord::value(const QString &name)