KexiDB::SchemaData Class Reference

#include <schemadata.h>

Inheritance diagram for KexiDB::SchemaData:

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

Protected Member Functions
void	clear ()

Protected Attributes
int	m_type
int	m_id
TQString	m_name
TQString	m_caption
TQString	m_desc
bool	m_native: 1

Friends
class	Connection

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.

Constructor & Destructor Documentation

SchemaData()

SchemaData::SchemaData

(

int

obj_type = KexiDB::UnknownObjectType

)

Definition at line 27 of file schemadata.cpp.

~SchemaData()

SchemaData::~SchemaData ( )

virtual

Definition at line 34 of file schemadata.cpp.

Member Function Documentation

caption()

TQString KexiDB::SchemaData::caption ( ) const

inline

Definition at line 48 of file schemadata.h.

clear()

void SchemaData::clear ( )

protected

Clears all properties except 'type'.

Definition at line 38 of file schemadata.cpp.

description()

TQString KexiDB::SchemaData::description ( ) const

inline

Definition at line 50 of file schemadata.h.

id()

int KexiDB::SchemaData::id ( ) const

inline

Definition at line 43 of file schemadata.h.

isNative()

virtual bool KexiDB::SchemaData::isNative ( ) const

inlinevirtual

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.

name()

TQString KexiDB::SchemaData::name ( ) const

inline

Definition at line 44 of file schemadata.h.

objectName()

TQString KexiDB::SchemaData::objectName ( ) const

inline

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

Definition at line 46 of file schemadata.h.

schemaDataDebugString()

TQString SchemaData::schemaDataDebugString ( ) const

virtual

Returns

debug string useful for debugging

Definition at line 46 of file schemadata.cpp.

setCaption()

void KexiDB::SchemaData::setCaption ( const TQString & c )

inline

Definition at line 49 of file schemadata.h.

setDescription()

void KexiDB::SchemaData::setDescription ( const TQString & desc )

inline

Definition at line 51 of file schemadata.h.

setName()

void KexiDB::SchemaData::setName ( const TQString & n )

inline

Definition at line 47 of file schemadata.h.

setNative()

virtual void KexiDB::SchemaData::setNative ( bool set )

inlinevirtual

Definition at line 74 of file schemadata.h.

type()

int KexiDB::SchemaData::type ( ) const

inline

Definition at line 42 of file schemadata.h.

Friends And Related Symbol Documentation

Connection

friend class Connection

friend

Definition at line 87 of file schemadata.h.

Member Data Documentation

m_caption

TQString KexiDB::SchemaData::m_caption

protected

Definition at line 83 of file schemadata.h.

m_desc

TQString KexiDB::SchemaData::m_desc

protected

Definition at line 84 of file schemadata.h.

m_id

int KexiDB::SchemaData::m_id

protected

Definition at line 81 of file schemadata.h.

m_name

TQString KexiDB::SchemaData::m_name

protected

Definition at line 82 of file schemadata.h.

m_native

bool KexiDB::SchemaData::m_native

protected

Definition at line 85 of file schemadata.h.

m_type

int KexiDB::SchemaData::m_type

protected

Definition at line 80 of file schemadata.h.

---

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

• schemadata.h
• schemadata.cpp