#include <connectiondata.h>
Public Attributes | |
| TQString | caption |
| TQString | description |
| int | id |
| TQString | driverName |
| TQString | hostName |
| unsigned short int | port |
| bool | useLocalSocketFile |
| TQString | localSocketFileName |
| TQString | password |
| bool | savePassword |
| TQString | userName |
Protected Attributes | |
| TQString | m_fileName |
| TQString | m_dbPath |
| TQString | m_dbFileName |
Detailed Description
ConnectionDataBase is a helper class for ConnectionData. It is not intended to be instantiated explicitly. Instead, use the ConnectionData class.
Definition at line 38 of file connectiondata.h.
Constructor & Destructor Documentation
◆ ConnectionDataBase()
| ConnectionDataBase::ConnectionDataBase | ( | ) |
Definition at line 45 of file connectiondata.cpp.
Member Data Documentation
◆ caption
| TQString KexiDB::ConnectionDataBase::caption |
The caption of the connection.
Captions are optional for identyfying given connection by name eg. for users.
Definition at line 49 of file connectiondata.h.
◆ description
| TQString KexiDB::ConnectionDataBase::description |
The additional description for the connection.
Definition at line 54 of file connectiondata.h.
◆ driverName
| TQString KexiDB::ConnectionDataBase::driverName |
the name of the driver that should be used to create a connection
Name (unique, not i18n'd) of driver that is used (or should be used) to create a connection. If you pass this ConnectionData object to KexiDB::Driver::createConnection() to create connection, the driverName member will be updated with a valid KexiDB driver name. In other situations the driverName member may be used to store information what driver should be used to perform connection, before we get an appropriate driver object from DriverManager.
Definition at line 76 of file connectiondata.h.
◆ hostName
| TQString KexiDB::ConnectionDataBase::hostName |
Host name used for the remote connection.
Can be empty if the connection is not remote. If it is empty "localhost" is used.
Definition at line 83 of file connectiondata.h.
◆ id
| int KexiDB::ConnectionDataBase::id |
Used for identifying a single piece of data in a set.
Optional ID used for identifying a single piece data in a set. ConnectionData::ConstList for example) This is set automatically when needed. By default: -1.
Definition at line 63 of file connectiondata.h.
◆ localSocketFileName
| TQString KexiDB::ConnectionDataBase::localSocketFileName |
Name of local (named) socket file.
For local connections only. If empty, it's driver will try to locate existing local socket file. Empty by default.
Definition at line 110 of file connectiondata.h.
◆ m_dbFileName
|
protected |
Filename of the database file.
Will be empty if database is not file-based
Definition at line 156 of file connectiondata.h.
◆ m_dbPath
|
protected |
Absolute path to the database file.
Will be empty if database is not file-based
Definition at line 149 of file connectiondata.h.
◆ m_fileName
|
protected |
The filename for file-based databases.
For file-based database engines like SQLite, fileName is used instead hostName and port
Definition at line 142 of file connectiondata.h.
◆ password
| TQString KexiDB::ConnectionDataBase::password |
Password used for the connection.
Can be empty string or null. If it is empty (equal to ""), empty password is passed to the driver. If it is null (TQString()), no password is passed to the driver. In this case, applications using KexiDB should ask for the password.
Definition at line 118 of file connectiondata.h.
◆ port
| unsigned short int KexiDB::ConnectionDataBase::port |
Port used for the remote connection.
The default is 0, what means we use don't change the database engine's default port.
Definition at line 90 of file connectiondata.h.
◆ savePassword
| bool KexiDB::ConnectionDataBase::savePassword |
True if password should be saved to a file for the connection.
False by default, in most cases can be set to true when nonempty password has been loaded from a file. For instance, this flag can be then shown for a user as a checkbox.
Definition at line 127 of file connectiondata.h.
◆ useLocalSocketFile
| bool KexiDB::ConnectionDataBase::useLocalSocketFile |
True if local socket file should be used instead of TCP/IP port.
Only meaningful for connections with localhost as server. True by default, so local communication can be optimized, and users can avoid problems with TCP/IP connections disabled by firewalls.
If true, hostName and port will be ignored and localSocketFileName will be used. On MS Windows this option is often ignored and TCP/IP connection to the localhost is performed.
Definition at line 102 of file connectiondata.h.
◆ userName
| TQString KexiDB::ConnectionDataBase::userName |
The documentation for this class was generated from the following files: