kexi

KexiDB::DriverManager Class Reference

#include <drivermanager.h>

Inheritance diagram for KexiDB::DriverManager:

KexiDB::Object List of all members.

Detailed Description

Database driver management, e.g. finding and loading drivers.

Definition at line 40 of file drivermanager.h.


Public Types

typedef QMap< QString, KService::Ptr > ServicesMap

Public Member Functions

 DriverManager ()
virtual ~DriverManager ()
Driverdriver (const QString &name)
const QStringList driverNames ()
const KexiDB::Driver::InfoMap driversInfo ()
KexiDB::Driver::Info driverInfo (const QString &name)
KService::Ptr serviceInfo (const QString &name)
const ServicesMapservices ()
QString lookupByMime (const QString &mimeType)
virtual QString serverErrorMsg ()
virtual int serverResult ()
virtual QString serverResultName ()
QString possibleProblemsInfoMsg () const

Protected Member Functions

virtual void drv_clearServerResult ()

Member Function Documentation

Driver * DriverManager::driver const QString &  name  ) 
 

Tries to load db driver with named name name. The name is case insensitive.

Returns:
db driver, or 0 if error (then error message is also set)

Definition at line 393 of file drivermanager.cpp.

KexiDB::Driver::Info DriverManager::driverInfo const QString &  name  ) 
 

Returns:
information about driver's named with name. The name is case insensitive. You can check if driver information is not found calling Info::name.isEmpty() (then error message is also set).

Definition at line 348 of file drivermanager.cpp.

const QStringList DriverManager::driverNames  ) 
 

returns list of available drivers names. That drivers can be loaded by first use of driver() method.

Definition at line 338 of file drivermanager.cpp.

const KexiDB::Driver::InfoMap DriverManager::driversInfo  ) 
 

returns information list of available drivers. That drivers can be loaded by first use of driver() method.

Definition at line 314 of file drivermanager.cpp.

void DriverManager::drv_clearServerResult  )  [protected, virtual]
 

Clears number of last server operation's result stored as a single integer. Formally, this integer should be set to value that means "NO ERRORS" or "OK". This method is called by clearError(). For reimplementation. By default does nothing.

See also:
serverErrorMsg()

Reimplemented from KexiDB::Object.

Definition at line 416 of file drivermanager.cpp.

QString DriverManager::lookupByMime const QString &  mimeType  ) 
 

Looks up a drivers list by MIME type of database file. Only file-based database drivers are checked. The lookup is case insensitive.

Returns:
driver name or null string if no driver found.

Definition at line 380 of file drivermanager.cpp.

QString DriverManager::possibleProblemsInfoMsg  )  const
 

HTML information about possible problems encountered. It's displayed in 'details' section, if an error encountered. Currently it contains a list of incompatible db drivers. Used in KexiStartupHandler::detectDriverForFile().

Definition at line 423 of file drivermanager.cpp.

QString DriverManager::serverErrorMsg  )  [virtual]
 

server error is set if there is error at KService level (useful for debugging)

Reimplemented from KexiDB::Object.

Definition at line 401 of file drivermanager.cpp.

int DriverManager::serverResult  )  [virtual]
 

Returns:
engine-specific last server-side operation result number. Use this in your application to give users more information on what's up.
Reimplement this for your driver - default implementation just returns 0. Note that this result value is not the same as the one returned by errorNum() (Object::m_errno member)
See also:
serverErrorMsg(), drv_clearServerResult()

Reimplemented from KexiDB::Object.

Definition at line 406 of file drivermanager.cpp.

QString DriverManager::serverResultName  )  [virtual]
 

Returns:
engine-specific last server-side operation result name, (name for serverResult()). Use this in your application to give users more information on what's up.
Reimplement this for your driver - default implementation just returns null string. Note that this result name is not the same as the error message returned by serverErorMsg() or erorMsg()
See also:
serverErrorMsg(), drv_clearServerResult()

Reimplemented from KexiDB::Object.

Definition at line 411 of file drivermanager.cpp.

KService::Ptr DriverManager::serviceInfo const QString &  name  ) 
 

Returns:
service information about driver's named with name. The name is case insensitive. In most cases you can use driverInfo() instead.

Definition at line 357 of file drivermanager.cpp.

const DriverManager::ServicesMap & DriverManager::services  ) 
 

Returns:
a map structure of the services. Not necessary for everyday use.

Definition at line 373 of file drivermanager.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys