Kexi API Documentation (2.0 alpha)
	Overview Class Hierarchy Classes Classes (annotated) Members Source Files

KexiDB::SchemaData Class Reference

#include <schemadata.h>

Inheritance diagram for KexiDB::SchemaData:

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 ()
	Clears all properties except 'type'.
Protected Attributes
int	m_type
int	m_id
QString	m_name
QString	m_caption
QString	m_desc
bool	m_native: 1
Friends
class	Connection

---

Constructor & Destructor Documentation

SchemaData::SchemaData (  int  obj_type = KexiDB::UnknownObjectType  )

Definition at line 27 of file schemadata.cpp.

SchemaData::~SchemaData (   )  [virtual]

Definition at line 34 of file schemadata.cpp.

---

Member Function Documentation

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

Definition at line 48 of file schemadata.h. Referenced by KexiDB::TableOrQuerySchema::captionOrName(), KexiDBShortcutFile::saveProjectData(), KexiDBConnectionWidget::setDataInternal(), and KexiDB::Connection::storeObjectSchemaData().

void SchemaData::clear (   )  [protected]

Clears all properties except 'type'. Reimplemented in KexiDB::QuerySchema, and KexiDB::TableSchema. Definition at line 38 of file schemadata.cpp. References m_caption, m_desc, m_id, and m_name. Referenced by KexiDB::TableSchema::clear(), and KexiDB::QuerySchema::clear().

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

Reimplemented in KexiProjectData. Definition at line 50 of file schemadata.h. Referenced by KexiProjectData::description(), and KexiDB::Connection::storeObjectSchemaData().

int KexiDB::SchemaData::id (   )  const [inline]

Definition at line 43 of file schemadata.h. Referenced by KexiCSVImportDialog::accept(), KexiDB::Connection::alterTableName(), KexiDB::Connection::createTable(), KexiDB::Connection::dropTable(), KexiDB::Connection::loadExtendedTableSchemaData(), KexiMigration::KexiMigrate::performImport(), KexiDB::Connection::removeTableSchemaInternal(), KexiViewBase::storeNewData(), KexiScriptDesignView::storeNewData(), KexiReportView::storeNewData(), KexiQueryDesignerSQLView::storeNewData(), KexiMacroView::storeNewData(), KexiFormView::storeNewData(), KexiDialogBase::storeNewData(), and KexiDB::Connection::storeObjectSchemaData().

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::name (   )  const [inline]

Definition at line 44 of file schemadata.h. Referenced by KexiCSVImportDialog::accept(), KexiRelationWidget::addTable(), KexiRelationView::addTableContainer(), KexiDB::Connection::alterTable(), KexiDB::Connection::alterTableName(), KexiDB::TableOrQuerySchema::captionOrName(), KexiDB::Connection::createTable(), KexiDB::Connection::createTableStatement(), KexiDB::Cursor::Cursor(), KexiProjectData::databaseName(), KexiDB::QueryAsterisk::debugString(), KexiDB::QuerySchema::debugString(), KexiDB::Connection::deleteAllRows(), KexiDB::deleteRow(), KexiDB::Connection::deleteRow(), KexiDB::Connection::dropTable(), KexiDB::AlterTableHandler::execute(), KexiDB::PreparedStatement::generateStatementString(), KexiFormView::initDataSource(), KexiDB::Connection::insertRecord(), KexiDB::Connection::insertRow(), KexiDB::Connection::lastInsertedAutoIncValue(), KexiDB::Connection::loadExtendedTableSchemaData(), KexiTablePart::loadSchemaData(), KexiDB::TableOrQuerySchema::name(), KexiMigration::KexiMigrate::performImport(), KexiDB::QuerySchema::pkeyFieldsOrder(), KexiTablePart::remove(), KexiDB::Connection::removeTableSchemaInternal(), KexiDB::replaceRow(), KexiDB::Connection::selectStatement(), KexiDB::TableSchema::setLookupFieldSchema(), KexiQueryDesignerGuiEditor::slotTableFieldDoubleClicked(), KexiRelationWidget::slotTableHidden(), KexiDB::Connection::storeObjectSchemaData(), KexiRelationView::tableContainer(), KexiQueryDesignerGuiEditor::updateColumnsData(), and KexiDB::Connection::updateRow().

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. Referenced by KexiProject::dropProject().

QString SchemaData::schemaDataDebugString (   )  const [virtual]

Returns: debug string useful for debugging Definition at line 46 of file schemadata.cpp. References m_caption, m_desc, m_id, and m_name. Referenced by KexiDB::TableSchema::debugString(), KexiDB::QuerySchema::debugString(), and KexiDB::IndexSchema::debugString().

void KexiDB::SchemaData::setCaption (  const QString &  c  )  [inline]

Definition at line 49 of file schemadata.h. Referenced by KexiCSVImportDialog::accept(), KexiDBConnectionTabWidget::currentProjectData(), KexiProjectData::KexiProjectData(), KexiDBShortcutFile::loadProjectData(), KexiPart::Part::openInstance(), KexiMigration::KexiMigrate::performImport(), and KexiDialogBase::storeNewData().

void KexiDB::SchemaData::setDescription (  const QString &  desc  )  [inline]

Reimplemented in KexiProjectData. Definition at line 51 of file schemadata.h. Referenced by KexiCSVImportDialog::accept(), KexiPart::Part::openInstance(), KexiProjectData::setDescription(), and KexiDialogBase::storeNewData().

void KexiDB::SchemaData::setName (  const QString &  n  )  [inline]

Definition at line 47 of file schemadata.h. Referenced by KexiDB::Connection::alterTableName(), KexiProject::createInternalStructures(), KexiDB::AlterTableHandler::execute(), KexiPart::Part::openInstance(), KexiProjectData::setDatabaseName(), and KexiDialogBase::storeNewData().

virtual void KexiDB::SchemaData::setNative (  bool  set  )  [inline, virtual]

Reimplemented in KexiDB::TableSchema. Definition at line 74 of file schemadata.h.

int KexiDB::SchemaData::type (   )  const [inline]

Definition at line 42 of file schemadata.h. Referenced by KexiDB::Connection::storeObjectSchemaData().

---

Friends And Related Function Documentation

friend class Connection [friend]

Reimplemented in KexiDB::IndexSchema, KexiDB::QuerySchema, and KexiDB::TableSchema. Definition at line 87 of file schemadata.h.

---

Member Data Documentation

QString KexiDB::SchemaData::m_caption [protected]

Definition at line 83 of file schemadata.h. Referenced by clear(), KexiDB::QuerySchema::QuerySchema(), schemaDataDebugString(), and KexiDB::Connection::setupObjectSchemaData().

QString KexiDB::SchemaData::m_desc [protected]

Definition at line 84 of file schemadata.h. Referenced by clear(), schemaDataDebugString(), and KexiDB::Connection::setupObjectSchemaData().

int KexiDB::SchemaData::m_id [protected]

Definition at line 81 of file schemadata.h. Referenced by KexiDB::Connection::alterTableName(), clear(), KexiDB::Connection::createTable(), schemaDataDebugString(), KexiDB::Connection::setupObjectSchemaData(), KexiDB::Connection::setupQuerySchema(), KexiDB::Connection::setupTableSchema(), KexiDB::Connection::storeObjectSchemaData(), and KexiDB::TableSchema::TableSchema().

QString KexiDB::SchemaData::m_name [protected]

Definition at line 82 of file schemadata.h. Referenced by clear(), KexiDB::QuerySchema::QuerySchema(), schemaDataDebugString(), KexiDB::Connection::setupObjectSchemaData(), KexiDB::Connection::setupQuerySchema(), KexiDB::Connection::setupTableSchema(), and KexiDB::TableSchema::TableSchema().

bool KexiDB::SchemaData::m_native [protected]

Definition at line 85 of file schemadata.h. Referenced by KexiDB::TableSchema::setKexiDBSystem(), and KexiDB::TableSchema::setNative().

int KexiDB::SchemaData::m_type [protected]

Definition at line 80 of file schemadata.h. Referenced by KexiDB::QuerySchema::init().

---

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

• schemadata.h
• schemadata.cpp

This file is part of the documentation for Kexi 2.0 alpha.

Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:50:48 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003