kexi

KexiDB::DatabaseProperties Class Reference

#include <dbproperties.h>

Inheritance diagram for KexiDB::DatabaseProperties:

KexiDB::Object List of all members.

Detailed Description

A set of storable database properties.

This is a convenience class that allows to store global dabatase properties without a need for creating and maintain custom table. DatabaseProperties object is accessible only using KexiDB::Connection::databaseProperties() method.

Definition at line 34 of file dbproperties.h.


Public Member Functions

bool setValue (const QString &name, const QVariant &value)
bool setCaption (const QString &name, const QString &caption)
QVariant value (const QString &name)
QString caption (const QString &name)
QStringList names ()

Protected Member Functions

 DatabaseProperties (Connection *conn)
 ~DatabaseProperties ()

Protected Attributes

QGuardedPtr< Connectionm_conn

Friends

class Connection

Member Function Documentation

QString DatabaseProperties::caption ( const QString &  name  ) 

Returns:
translated property caption for name. If there's no such property defined for driver, empty string value is returned.

Definition at line 122 of file dbproperties.cpp.

QStringList DatabaseProperties::names (  ) 

Returns:
a list of available property names.

Definition at line 137 of file dbproperties.cpp.

bool DatabaseProperties::setCaption ( const QString &  name,
const QString &  caption 
)

Sets caption for for property name. Usually it shouldn't be translated: trnaslation can be performed before displaying.

Definition at line 71 of file dbproperties.cpp.

bool DatabaseProperties::setValue ( const QString &  name,
const QVariant &  value 
)

Sets value for property name. Optional caption can be also set. If there's no such property defined, it will be added. Existing value will be overwritten. Note that to execute this method, database must be opened in read-write mode.

Returns:
true on successfull data. Connection

Definition at line 35 of file dbproperties.cpp.

QVariant DatabaseProperties::value ( const QString &  name  ) 

Returns:
property value for propeName available for this driver. If there's no such property defined for driver, Null QVariant value is returned.

Definition at line 109 of file dbproperties.cpp.


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