API reference - Class QSqlError

Notation used in Ruby API documentation

Module: QtSql

Description: Binding of QSqlError

Sub-classes: ErrorType, QFlags_ErrorType

Public constructors

new QSqlErrornew(string driverText,
string databaseText,
const QSqlError_ErrorType type,
int number)
Constructor QSqlError::QSqlError(const QString &driverText, const QString &databaseText, QSqlError::ErrorType type, int number)
new QSqlErrornew(string driverText = QString(),
string databaseText = QString(),
const QSqlError_ErrorType type = QSqlError::NoError,
string errorCode = QString())
Constructor QSqlError::QSqlError(const QString &driverText, const QString &databaseText, QSqlError::ErrorType type, const QString &errorCode)
new QSqlErrornew(const QSqlError other)Constructor QSqlError::QSqlError(const QSqlError &other)

Public methods

[const]bool!=(const QSqlError other)Method bool QSqlError::operator!=(const QSqlError &other)
[const]bool==(const QSqlError other)Method bool QSqlError::operator==(const QSqlError &other)
void_assign(const QSqlError other)Assigns another object to self
[const]QSqlError 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.
QSqlErrorassign(const QSqlError other)Method QSqlError &QSqlError::operator=(const QSqlError &other)
[const]stringdatabaseTextMethod QString QSqlError::databaseText()
voiddatabaseText=(string databaseText)Method void QSqlError::setDatabaseText(const QString &databaseText)
[const]stringdriverTextMethod QString QSqlError::driverText()
voiddriverText=(string driverText)Method void QSqlError::setDriverText(const QString &driverText)
[const]new QSqlError ptrdupCreates a copy of self
[const]boolisValid?Method bool QSqlError::isValid()
[const]stringnativeErrorCodeMethod QString QSqlError::nativeErrorCode()
[const]intnumberMethod int QSqlError::number()
voidnumber=(int number)Method void QSqlError::setNumber(int number)
voidsetDatabaseText(string databaseText)Method void QSqlError::setDatabaseText(const QString &databaseText)
voidsetDriverText(string driverText)Method void QSqlError::setDriverText(const QString &driverText)
voidsetNumber(int number)Method void QSqlError::setNumber(int number)
voidsetType(const QSqlError_ErrorType type)Method void QSqlError::setType(QSqlError::ErrorType type)
voidswap(QSqlError other)Method void QSqlError::swap(QSqlError &other)
[const]stringtextMethod QString QSqlError::text()
[const]QSqlError_ErrorTypetypeMethod QSqlError::ErrorType QSqlError::type()
voidtype=(const QSqlError_ErrorType type)Method void QSqlError::setType(QSqlError::ErrorType type)

Public static methods and constants

[static,const]QSqlError_ErrorTypeConnectionErrorEnum constant QSqlError::ConnectionError
[static,const]QSqlError_ErrorTypeNoErrorEnum constant QSqlError::NoError
[static,const]QSqlError_ErrorTypeStatementErrorEnum constant QSqlError::StatementError
[static,const]QSqlError_ErrorTypeTransactionErrorEnum constant QSqlError::TransactionError
[static,const]QSqlError_ErrorTypeUnknownErrorEnum constant QSqlError::UnknownError

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 QSqlError other)

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

==

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

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

ConnectionError

Signature: [static,const] QSqlError_ErrorType ConnectionError

Description: Enum constant QSqlError::ConnectionError

Python specific notes:
The object exposes a readable attribute 'ConnectionError'. This is the getter.

NoError

Signature: [static,const] QSqlError_ErrorType NoError

Description: Enum constant QSqlError::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. This is the getter.

StatementError

Signature: [static,const] QSqlError_ErrorType StatementError

Description: Enum constant QSqlError::StatementError

Python specific notes:
The object exposes a readable attribute 'StatementError'. This is the getter.

TransactionError

Signature: [static,const] QSqlError_ErrorType TransactionError

Description: Enum constant QSqlError::TransactionError

Python specific notes:
The object exposes a readable attribute 'TransactionError'. This is the getter.

UnknownError

Signature: [static,const] QSqlError_ErrorType UnknownError

Description: Enum constant QSqlError::UnknownError

Python specific notes:
The object exposes a readable attribute 'UnknownError'. This is the getter.

_assign

Signature: void _assign (const QSqlError other)

Description: Assigns another object to self

_const_cast

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

assign

Signature: QSqlError assign (const QSqlError other)

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

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.

databaseText

Signature: [const] string databaseText

Description: Method QString QSqlError::databaseText()

Python specific notes:
The object exposes a readable attribute 'databaseText'. This is the getter.

databaseText=

Signature: void databaseText= (string databaseText)

Description: Method void QSqlError::setDatabaseText(const QString &databaseText)

Python specific notes:
The object exposes a writable attribute 'databaseText'. This is the setter.

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.

driverText

Signature: [const] string driverText

Description: Method QString QSqlError::driverText()

Python specific notes:
The object exposes a readable attribute 'driverText'. This is the getter.

driverText=

Signature: void driverText= (string driverText)

Description: Method void QSqlError::setDriverText(const QString &driverText)

Python specific notes:
The object exposes a writable attribute 'driverText'. This is the setter.

dup

Signature: [const] new QSqlError ptr dup

Description: Creates a copy of self

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QSqlError::isValid()

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.

nativeErrorCode

Signature: [const] string nativeErrorCode

Description: Method QString QSqlError::nativeErrorCode()

new

(1) Signature: [static] new QSqlError new (string driverText, string databaseText, const QSqlError_ErrorType type, int number)

Description: Constructor QSqlError::QSqlError(const QString &driverText, const QString &databaseText, QSqlError::ErrorType type, int number)

This method creates an object of class QSqlError.

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

(2) Signature: [static] new QSqlError new (string driverText = QString(), string databaseText = QString(), const QSqlError_ErrorType type = QSqlError::NoError, string errorCode = QString())

Description: Constructor QSqlError::QSqlError(const QString &driverText, const QString &databaseText, QSqlError::ErrorType type, const QString &errorCode)

This method creates an object of class QSqlError.

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

(3) Signature: [static] new QSqlError new (const QSqlError other)

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

This method creates an object of class QSqlError.

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

number

Signature: [const] int number

Description: Method int QSqlError::number()

Python specific notes:
The object exposes a readable attribute 'number'. This is the getter.

number=

Signature: void number= (int number)

Description: Method void QSqlError::setNumber(int number)

Python specific notes:
The object exposes a writable attribute 'number'. This is the setter.

setDatabaseText

Signature: void setDatabaseText (string databaseText)

Description: Method void QSqlError::setDatabaseText(const QString &databaseText)

Python specific notes:
The object exposes a writable attribute 'databaseText'. This is the setter.

setDriverText

Signature: void setDriverText (string driverText)

Description: Method void QSqlError::setDriverText(const QString &driverText)

Python specific notes:
The object exposes a writable attribute 'driverText'. This is the setter.

setNumber

Signature: void setNumber (int number)

Description: Method void QSqlError::setNumber(int number)

Python specific notes:
The object exposes a writable attribute 'number'. This is the setter.

setType

Signature: void setType (const QSqlError_ErrorType type)

Description: Method void QSqlError::setType(QSqlError::ErrorType type)

Python specific notes:
The object exposes a writable attribute 'type'. This is the setter.

swap

Signature: void swap (QSqlError other)

Description: Method void QSqlError::swap(QSqlError &other)

text

Signature: [const] string text

Description: Method QString QSqlError::text()

type

Signature: [const] QSqlError_ErrorType type

Description: Method QSqlError::ErrorType QSqlError::type()

Python specific notes:
The object exposes a readable attribute 'type'. This is the getter.

type=

Signature: void type= (const QSqlError_ErrorType type)

Description: Method void QSqlError::setType(QSqlError::ErrorType type)

Python specific notes:
The object exposes a writable attribute 'type'. This is the setter.