Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QSQLiteDriver Class Reference

#include <qsql_sqlite_p.h>

+ Inheritance diagram for QSQLiteDriver:
+ Collaboration diagram for QSQLiteDriver:

Public Member Functions

 QSQLiteDriver (QObject *parent=nullptr)
 
 QSQLiteDriver (sqlite3 *connection, QObject *parent=nullptr)
 
 ~QSQLiteDriver ()
 
bool hasFeature (DriverFeature f) const override
 Returns true if the driver supports feature feature; otherwise returns false.
 
bool open (const QString &db, const QString &user, const QString &password, const QString &host, int port, const QString &connOpts) override
 Derived classes must reimplement this pure virtual function to open a database connection on database db, using user name user, password password, host host, port port and connection options options.
 
void close () override
 Derived classes must reimplement this pure virtual function in order to close the database connection.
 
QSqlResultcreateResult () const override
 Creates an empty SQL result on the database.
 
bool beginTransaction () override
 This function is called to begin a transaction.
 
bool commitTransaction () override
 This function is called to commit a transaction.
 
bool rollbackTransaction () override
 This function is called to rollback a transaction.
 
QStringList tables (QSql::TableType) const override
 Returns a list of the names of the tables in the database.
 
QSqlRecord record (const QString &tablename) const override
 Returns a QSqlRecord populated with the names of the fields in table tableName.
 
QSqlIndex primaryIndex (const QString &table) const override
 Returns the primary index for table tableName.
 
QVariant handle () const override
 Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.
 
QString escapeIdentifier (const QString &identifier, IdentifierType) const override
 Returns the identifier escaped according to the database rules.
 
bool subscribeToNotification (const QString &name) override
 This function is called to subscribe to event notifications from the database.
 
bool unsubscribeFromNotification (const QString &name) override
 This function is called to unsubscribe from event notifications from the database.
 
QStringList subscribedToNotifications () const override
 Returns a list of the names of the event notifications that are currently subscribed to.
 
- Public Member Functions inherited from QSqlDriver
 QSqlDriver (QObject *parent=nullptr)
 Constructs a new driver with the given parent.
 
 ~QSqlDriver ()
 Destroys the object and frees any allocated resources.
 
virtual bool isOpen () const
 Returns true if the database connection is open; otherwise returns false.
 
bool isOpenError () const
 Returns true if the there was an error opening the database connection; otherwise returns false.
 
virtual bool beginTransaction ()
 This function is called to begin a transaction.
 
virtual bool commitTransaction ()
 This function is called to commit a transaction.
 
virtual bool rollbackTransaction ()
 This function is called to rollback a transaction.
 
virtual QStringList tables (QSql::TableType tableType) const
 Returns a list of the names of the tables in the database.
 
virtual QSqlIndex primaryIndex (const QString &tableName) const
 Returns the primary index for table tableName.
 
virtual QSqlRecord record (const QString &tableName) const
 Returns a QSqlRecord populated with the names of the fields in table tableName.
 
virtual QString formatValue (const QSqlField &field, bool trimStrings=false) const
 Returns a string representation of the field value for the database.
 
virtual QString escapeIdentifier (const QString &identifier, IdentifierType type) const
 Returns the identifier escaped according to the database rules.
 
virtual QString sqlStatement (StatementType type, const QString &tableName, const QSqlRecord &rec, bool preparedStatement) const
 Returns a SQL statement of type type for the table tableName with the values from rec.
 
QSqlError lastError () const
 Returns a QSqlError object which contains information about the last error that occurred on the database.
 
virtual QVariant handle () const
 Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.
 
virtual bool hasFeature (DriverFeature f) const =0
 Returns true if the driver supports feature feature; otherwise returns false.
 
virtual void close ()=0
 Derived classes must reimplement this pure virtual function in order to close the database connection.
 
virtual QSqlResultcreateResult () const =0
 Creates an empty SQL result on the database.
 
virtual bool open (const QString &db, const QString &user=QString(), const QString &password=QString(), const QString &host=QString(), int port=-1, const QString &connOpts=QString())=0
 Derived classes must reimplement this pure virtual function to open a database connection on database db, using user name user, password password, host host, port port and connection options options.
 
virtual bool subscribeToNotification (const QString &name)
 This function is called to subscribe to event notifications from the database.
 
virtual bool unsubscribeFromNotification (const QString &name)
 This function is called to unsubscribe from event notifications from the database.
 
virtual QStringList subscribedToNotifications () const
 Returns a list of the names of the event notifications that are currently subscribed to.
 
virtual bool isIdentifierEscaped (const QString &identifier, IdentifierType type) const
 Returns whether identifier is escaped according to the database rules.
 
virtual QString stripDelimiters (const QString &identifier, IdentifierType type) const
 Returns the identifier with the leading and trailing delimiters removed, identifier can either be a table name or field name, dependent on type.
 
void setNumericalPrecisionPolicy (QSql::NumericalPrecisionPolicy precisionPolicy)
 
QSql::NumericalPrecisionPolicy numericalPrecisionPolicy () const
 
DbmsType dbmsType () const
 
virtual int maximumIdentifierLength (IdentifierType type) const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Friends

class QSQLiteResultPrivate
 

Additional Inherited Members

- Public Types inherited from QSqlDriver
enum  DriverFeature {
  Transactions , QuerySize , BLOB , Unicode ,
  PreparedQueries , NamedPlaceholders , PositionalPlaceholders , LastInsertId ,
  BatchOperations , SimpleLocking , LowPrecisionNumbers , EventNotifications ,
  FinishQuery , MultipleResultSets , CancelQuery
}
 This enum contains a list of features a driver might support. More...
 
enum  StatementType {
  WhereStatement , SelectStatement , UpdateStatement , InsertStatement ,
  DeleteStatement
}
 This enum contains a list of SQL statement (or clause) types the driver can create. More...
 
enum  IdentifierType { FieldName , TableName }
 This enum contains a list of SQL identifier types. More...
 
enum  NotificationSource { UnknownSource , SelfSource , OtherSource }
 This enum contains a list of SQL notification sources. More...
 
enum  DbmsType {
  UnknownDbms , MSSqlServer , MySqlServer , PostgreSQL ,
  Oracle , Sybase , SQLite , Interbase ,
  DB2 , MimerSQL
}
 
- Public Slots inherited from QSqlDriver
virtual bool cancelQuery ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QSqlDriver
void notification (const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QSqlDriver
 QSqlDriver (QSqlDriverPrivate &dd, QObject *parent=nullptr)
 
virtual void setOpen (bool o)
 This function sets the open state of the database to open.
 
virtual void setOpenError (bool e)
 This function sets the open error state of the database to error.
 
virtual void setLastError (const QSqlError &e)
 This function is used to set the value of the last error, error, that occurred on the database.
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 33 of file qsql_sqlite_p.h.

Constructor & Destructor Documentation

◆ QSQLiteDriver() [1/2]

QSQLiteDriver::QSQLiteDriver ( QObject parent = nullptr)
explicit

Definition at line 652 of file qsql_sqlite.cpp.

◆ QSQLiteDriver() [2/2]

QSQLiteDriver::QSQLiteDriver ( sqlite3 *  connection,
QObject parent = nullptr 
)
explicit

Definition at line 657 of file qsql_sqlite.cpp.

References connection, d, QSqlDriver::setOpen(), and QSqlDriver::setOpenError().

+ Here is the call graph for this function:

◆ ~QSQLiteDriver()

QSQLiteDriver::~QSQLiteDriver ( )

Definition at line 667 of file qsql_sqlite.cpp.

References close().

+ Here is the call graph for this function:

Member Function Documentation

◆ beginTransaction()

bool QSQLiteDriver::beginTransaction ( )
overridevirtual

This function is called to begin a transaction.

If successful, return true, otherwise return false. The default implementation does nothing and returns false.

See also
commitTransaction(), rollbackTransaction()

Reimplemented from QSqlDriver.

Definition at line 838 of file qsql_sqlite.cpp.

References createResult(), QSqlDriver::isOpen(), QSqlDriver::isOpenError(), QSqlDriver::setLastError(), tr, and QSqlError::TransactionError.

+ Here is the call graph for this function:

◆ close()

void QSQLiteDriver::close ( )
overridevirtual

Derived classes must reimplement this pure virtual function in order to close the database connection.

Return true on success, false on failure.

See also
open(), setOpen()

Implements QSqlDriver.

Definition at line 811 of file qsql_sqlite.cpp.

References QSqlError::ConnectionError, d, QSqlDriver::isOpen(), qMakeError(), QSqlDriver::setLastError(), QSqlDriver::setOpen(), QSqlDriver::setOpenError(), and tr.

Referenced by ~QSQLiteDriver(), and open().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ commitTransaction()

bool QSQLiteDriver::commitTransaction ( )
overridevirtual

This function is called to commit a transaction.

If successful, return true, otherwise return false. The default implementation does nothing and returns false.

See also
beginTransaction(), rollbackTransaction()

Reimplemented from QSqlDriver.

Definition at line 853 of file qsql_sqlite.cpp.

References createResult(), QSqlDriver::isOpen(), QSqlDriver::isOpenError(), QSqlDriver::setLastError(), tr, and QSqlError::TransactionError.

+ Here is the call graph for this function:

◆ createResult()

QSqlResult * QSQLiteDriver::createResult ( ) const
overridevirtual

Creates an empty SQL result on the database.

Derived classes must reimplement this function and return a QSqlResult object appropriate for their database to the caller.

Implements QSqlDriver.

Definition at line 833 of file qsql_sqlite.cpp.

Referenced by beginTransaction(), commitTransaction(), primaryIndex(), record(), rollbackTransaction(), and tables().

+ Here is the caller graph for this function:

◆ escapeIdentifier()

QString QSQLiteDriver::escapeIdentifier ( const QString identifier,
IdentifierType  type 
) const
overridevirtual

Returns the identifier escaped according to the database rules.

identifier can either be a table name or field name, dependent on type.

The default implementation does nothing.

See also
isIdentifierEscaped()

Reimplemented from QSqlDriver.

Definition at line 997 of file qsql_sqlite.cpp.

References _q_escapeIdentifier().

+ Here is the call graph for this function:

◆ handle()

QVariant QSQLiteDriver::handle ( ) const
overridevirtual

Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.

Warning
Use this with uttermost care and only if you know what you're doing.
The handle returned here can become a stale pointer if the connection is modified (for example, if you close the connection).
The handle can be NULL if the connection is not open yet.

The handle returned here is database-dependent, you should query the type name of the variant before accessing it.

This example retrieves the handle for a connection to sqlite:

QVariant v = db.driver()->handle();
if (v.isValid() && (qstrcmp(v.typeName(), "sqlite3*") == 0)) {
// v.data() returns a pointer to the handle
sqlite3 *handle = *static_cast<sqlite3 **>(v.data());
if (handle) {
// ...
}
}
The QSqlDatabase class handles a connection to a database.
static QSqlDatabase database(const QString &connectionName=QLatin1StringView(defaultConnection), bool open=true)
\threadsafe
\inmodule QtCore
Definition qvariant.h:64
Q_CORE_EXPORT int qstrcmp(const char *str1, const char *str2)
GLsizei const GLfloat * v
[13]
GLuint64 GLenum void * handle
QMimeDatabase db
[0]

This snippet returns the handle for PostgreSQL or MySQL:

if (qstrcmp(v.typeName(), "PGconn*") == 0) {
PGconn *handle = *static_cast<PGconn **>(v.data());
if (handle) {
// ...
}
}
if (qstrcmp(v.typeName(), "MYSQL*") == 0) {
MYSQL *handle = *static_cast<MYSQL **>(v.data());
if (handle) {
// ...
}
}
struct pg_conn PGconn
Definition qsql_psql_p.h:26
See also
QSqlResult::handle()

Reimplemented from QSqlDriver.

Definition at line 991 of file qsql_sqlite.cpp.

References d, and QVariant::fromValue().

+ Here is the call graph for this function:

◆ hasFeature()

bool QSQLiteDriver::hasFeature ( DriverFeature  feature) const
overridevirtual

◆ open()

bool QSQLiteDriver::open ( const QString db,
const QString user,
const QString password,
const QString host,
int  port,
const QString options 
)
overridevirtual

Derived classes must reimplement this pure virtual function to open a database connection on database db, using user name user, password password, host host, port port and connection options options.

The function must return true on success and false on failure.

See also
setOpen()

Implements QSqlDriver.

Definition at line 706 of file qsql_sqlite.cpp.

References _q_lower(), _q_upper(), cache, cacheSize(), close(), QSqlError::ConnectionError, d, db, QSqlDriver::isOpen(), ok, qMakeError(), QSqlDriver::setLastError(), QSqlDriver::setOpen(), QSqlDriver::setOpenError(), QString::split(), and tr.

+ Here is the call graph for this function:

◆ primaryIndex()

QSqlIndex QSQLiteDriver::primaryIndex ( const QString tableName) const
overridevirtual

Returns the primary index for table tableName.

Returns an empty QSqlIndex if the table doesn't have a primary index. The default implementation returns an empty index.

Reimplemented from QSqlDriver.

Definition at line 963 of file qsql_sqlite.cpp.

References createResult(), QSqlDriver::isIdentifierEscaped(), QSqlDriver::isOpen(), qGetTableInfo(), QSqlDriver::stripDelimiters(), and QSqlDriver::TableName.

+ Here is the call graph for this function:

◆ record()

QSqlRecord QSQLiteDriver::record ( const QString tableName) const
overridevirtual

Returns a QSqlRecord populated with the names of the fields in table tableName.

If no such table exists, an empty record is returned. The default implementation returns an empty record.

Reimplemented from QSqlDriver.

Definition at line 977 of file qsql_sqlite.cpp.

References createResult(), QSqlDriver::isIdentifierEscaped(), QSqlDriver::isOpen(), qGetTableInfo(), QSqlDriver::stripDelimiters(), and QSqlDriver::TableName.

+ Here is the call graph for this function:

◆ rollbackTransaction()

bool QSQLiteDriver::rollbackTransaction ( )
overridevirtual

This function is called to rollback a transaction.

If successful, return true, otherwise return false. The default implementation does nothing and returns false.

See also
beginTransaction(), commitTransaction()

Reimplemented from QSqlDriver.

Definition at line 868 of file qsql_sqlite.cpp.

References createResult(), QSqlDriver::isOpen(), QSqlDriver::isOpenError(), QSqlDriver::setLastError(), tr, and QSqlError::TransactionError.

+ Here is the call graph for this function:

◆ subscribedToNotifications()

QStringList QSQLiteDriver::subscribedToNotifications ( ) const
overridevirtual

Returns a list of the names of the event notifications that are currently subscribed to.

Reimplement this function if you want to provide event notification support in your own QSqlDriver subclass,

Since
4.4
See also
subscribeToNotification(), unsubscribeFromNotification()

Reimplemented from QSqlDriver.

Definition at line 1055 of file qsql_sqlite.cpp.

References d.

◆ subscribeToNotification()

bool QSQLiteDriver::subscribeToNotification ( const QString name)
overridevirtual

This function is called to subscribe to event notifications from the database.

name identifies the event notification.

If successful, return true, otherwise return false.

The database must be open when this function is called. When the database is closed by calling close() all subscribed event notifications are automatically unsubscribed. Note that calling open() on an already open database may implicitly cause close() to be called, which will cause the driver to unsubscribe from all event notifications.

When an event notification identified by name is posted by the database the notification() signal is emitted.

Reimplement this function if you want to provide event notification support in your own QSqlDriver subclass,

Since
4.4
See also
unsubscribeFromNotification(), subscribedToNotifications(), QSqlDriver::hasFeature()

Reimplemented from QSqlDriver.

Definition at line 1014 of file qsql_sqlite.cpp.

References d, handle_sqlite_callback(), QSqlDriver::isOpen(), qUtf16Printable, and qWarning.

+ Here is the call graph for this function:

◆ tables()

QStringList QSQLiteDriver::tables ( QSql::TableType  tableType) const
overridevirtual

Returns a list of the names of the tables in the database.

The default implementation returns an empty list.

The tableType argument describes what types of tables should be returned. Due to binary compatibility, the string contains the value of the enum QSql::TableTypes as text. An empty string should be treated as QSql::Tables for backward compatibility.

Reimplemented from QSqlDriver.

Definition at line 883 of file qsql_sqlite.cpp.

References QString::arg(), QString::clear(), createResult(), QString::isEmpty(), QSqlDriver::isOpen(), QSql::SystemTables, QSql::Tables, and QSql::Views.

+ Here is the call graph for this function:

◆ unsubscribeFromNotification()

bool QSQLiteDriver::unsubscribeFromNotification ( const QString name)
overridevirtual

This function is called to unsubscribe from event notifications from the database.

name identifies the event notification.

If successful, return true, otherwise return false.

The database must be open when this function is called. All subscribed event notifications are automatically unsubscribed from when the close() function is called.

After calling this function the notification() signal will no longer be emitted when an event notification identified by name is posted by the database.

Reimplement this function if you want to provide event notification support in your own QSqlDriver subclass,

Since
4.4
See also
subscribeToNotification(), subscribedToNotifications()

Reimplemented from QSqlDriver.

Definition at line 1035 of file qsql_sqlite.cpp.

References d, QSqlDriver::isOpen(), qUtf16Printable, and qWarning.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QSQLiteResultPrivate

friend class QSQLiteResultPrivate
friend

Definition at line 37 of file qsql_sqlite_p.h.


The documentation for this class was generated from the following files: