kexi

KexiDB::SchemaData

KexiDB::SchemaData Class Reference

#include <schemadata.h>

Inheritance diagram for KexiDB::SchemaData:

KexiDB::IndexSchema KexiDB::QuerySchema KexiDB::TableSchema KexiProjectData KexiDB::InternalTableSchema List of all members.

Detailed Description

Container class that stores common kexi object schema's properties like id, name, caption, help text. By kexi object we mean in-db storable object like table schema or query schema.

Definition at line 36 of file schemadata.h.


Public Member Functions

 SchemaData (int obj_type=KexiDB::UnknownObjectType)
virtual ~SchemaData ()
int type () const
int id () const
QString name () const
QString objectName () const
void setName (const QString &n)
QString caption () const
void setCaption (const QString &c)
QString description () const
void setDescription (const QString &desc)
virtual QString schemaDataDebugString () const
virtual bool isNative () const
virtual void setNative (bool set)

Protected Member Functions

void clear ()

Protected Attributes

int m_type
int m_id
QString m_name
QString m_caption
QString m_desc
bool m_native: 1

Friends

class Connection

Member Function Documentation

void SchemaData::clear (   )  [protected]
 

Clears all properties except 'type'.

Reimplemented in KexiDB::QuerySchema, and KexiDB::TableSchema.

Definition at line 38 of file schemadata.cpp.

virtual bool KexiDB::SchemaData::isNative (   )  const [inline, virtual]
 

Returns:
true if this is schema of native database object, like, for example like, native table. This flag is set when object schema (currently -- database table) is not retrieved using kexi__* schema storage system, but just based on the information about native table.
By native object we mean the one that has no additional data like caption, description, etc. properties (no kexidb extensions).

Native objects schemas are used mostly for representing kexi system (kexi__*) tables in memory for later reference; see Connection::tableNames().

By default (on allocation) SchemaData objects are not native.

Reimplemented in KexiDB::TableSchema.

Definition at line 71 of file schemadata.h.

QString KexiDB::SchemaData::objectName (   )  const [inline]
 

The same as name(). Added to avoid conflict with QObject::name()

Definition at line 46 of file schemadata.h.

QString SchemaData::schemaDataDebugString (   )  const [virtual]
 

Returns:
debug string useful for debugging

Definition at line 46 of file schemadata.cpp.

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

kexi

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys