kexi

Public Types | Public Member Functions | Protected Member Functions | List of all members
KexiDB::DriverManager Class Reference

#include <drivermanager.h>

Inheritance diagram for KexiDB::DriverManager:
KexiDB::Object

Public Types

typedef TQMap< TQString, KService::Ptr > ServicesMap

Public Member Functions

Driver * driver (const TQString &name)
const TQStringList driverNames ()
const KexiDB::Driver::InfoMap driversInfo ()
KexiDB::Driver::Info driverInfo (const TQString &name)
KService::Ptr serviceInfo (const TQString &name)
const ServicesMap & services ()
TQString lookupByMime (const TQString &mimeType)
virtual TQString serverErrorMsg ()
virtual int serverResult ()
virtual TQString serverResultName ()
TQString possibleProblemsInfoMsg () const
Public Member Functions inherited from KexiDB::Object
bool error () const
const TQString & errorMsg () const
int errorNum () const
int previousServerResult () const
TQString previousServerResultName () const
void debugError ()
virtual void clearError ()
TQString msgTitle () const
const TQString recentSQLString () const

Protected Member Functions

virtual void drv_clearServerResult ()
Protected Member Functions inherited from KexiDB::Object
 Object (MessageHandler *handler=0)
virtual void setError (int code=ERR_OTHER, const TQString &msg=TQString())
virtual void setError (const TQString &msg)
virtual void setError (const TQString &title, const TQString &msg)
void setError (KexiDB::Object *obj, const TQString &prependMessage=TQString())
virtual void setError (KexiDB::Object *obj, int code, const TQString &prependMessage=TQString())
virtual int askQuestion (const TQString &message, KMessageBox::DialogType dlgType, KMessageBox::ButtonCode defaultResult, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const TQString &dontShowAskAgainName=TQString(), int options=KMessageBox::Notify, MessageHandler *msgHandler=0)

Additional Inherited Members

Protected Attributes inherited from KexiDB::Object
TQString m_sql
TQString m_errorSql
int m_serverResult
TQString m_serverResultName
TQString m_serverErrorMsg
TQString m_errMsg

Detailed Description

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

Definition at line 42 of file drivermanager.h.

Member Typedef Documentation

◆ ServicesMap

typedef TQMap<TQString, KService::Ptr> KexiDB::DriverManager::ServicesMap

Definition at line 45 of file drivermanager.h.

Constructor & Destructor Documentation

◆ DriverManager()

DriverManager::DriverManager ( )

Definition at line 275 of file drivermanager.cpp.

◆ ~DriverManager()

DriverManager::~DriverManager ( )
virtual

Definition at line 286 of file drivermanager.cpp.

Member Function Documentation

◆ driver()

Driver * DriverManager::driver ( const TQString & 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 388 of file drivermanager.cpp.

◆ driverInfo()

KexiDB::Driver::Info DriverManager::driverInfo ( const TQString & 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 343 of file drivermanager.cpp.

◆ driverNames()

const TQStringList DriverManager::driverNames ( )

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

Definition at line 333 of file drivermanager.cpp.

◆ driversInfo()

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 307 of file drivermanager.cpp.

◆ drv_clearServerResult()

void DriverManager::drv_clearServerResult ( )
protectedvirtual

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 411 of file drivermanager.cpp.

◆ lookupByMime()

TQString DriverManager::lookupByMime ( const TQString & 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 375 of file drivermanager.cpp.

◆ possibleProblemsInfoMsg()

TQString 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 418 of file drivermanager.cpp.

◆ serverErrorMsg()

TQString DriverManager::serverErrorMsg ( )
virtual

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

Reimplemented from KexiDB::Object.

Definition at line 396 of file drivermanager.cpp.

◆ serverResult()

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 401 of file drivermanager.cpp.

◆ serverResultName()

TQString 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 406 of file drivermanager.cpp.

◆ serviceInfo()

KService::Ptr DriverManager::serviceInfo ( const TQString & 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 352 of file drivermanager.cpp.

◆ services()

const DriverManager::ServicesMap & DriverManager::services ( )
Returns
a map structure of the services. Not necessary for everyday use.

Definition at line 368 of file drivermanager.cpp.

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