KexiDB::TableOrQuerySchema Class Reference

#include <utils.h>

Detailed Description

Variant class providing a pointer to table or query.

Definition at line 143 of file kexidb/utils.h.

Public Member Functions

TableOrQuerySchema (Connection *conn, const QCString &name)

TableOrQuerySchema (Connection *conn, const QCString &name, bool table)

TableOrQuerySchema (FieldList &tableOrQuery)

TableOrQuerySchema (Connection *conn, int id)

TableOrQuerySchema (TableSchema *table)

TableOrQuerySchema (QuerySchema *query)

QuerySchema * query () const

TableSchema * table () const

QCString name () const

QString captionOrName () const

const QueryColumnInfo::Vector columns (bool unique=false)

Field * field (const QString &name)

QueryColumnInfo * columnInfo (const QString &name)

Connection * connection () const

QString debugString ()

void debug ()

Protected Attributes

QCString m_name

the name is kept here because m_table and m_table can be 0 and we still want name() and acptionOrName() work.

TableSchema * m_table

QuerySchema * m_query

Constructor & Destructor Documentation

TableOrQuerySchema::TableOrQuerySchema ( Connection * conn,

const QCString & name

)

Creates a new TableOrQuerySchema variant object, retrieving table or query schema using conn connection and name. If both table and query exists for name, table has priority over query. You should check whether a query or table has been found by testing (query() || table()) expression.
Definition at line 190 of file kexidb/utils.cpp.
References KexiDBWarn, m_query, and m_table.

TableOrQuerySchema::TableOrQuerySchema ( Connection * conn,

const QCString & name,

bool table

)

Creates a new TableOrQuerySchema variant object, retrieving table or query schema using conn connection and name. If table is true, name is assumed to be a table name, otherwise name is assumed to be a query name. You should check whether a query or table has been found by testing (query() || table()) expression.
Definition at line 200 of file kexidb/utils.cpp.
References KexiDBWarn, m_query, and m_table.

TableOrQuerySchema::TableOrQuerySchema ( FieldList & tableOrQuery )

Creates a new TableOrQuerySchema variant object. tableOrQuery must be of class TableSchema or QuerySchema. You should check whether a query or table has been found by testing (query() || table()) expression.
Definition at line 213 of file kexidb/utils.cpp.
References KexiDBWarn, m_query, and m_table.

TableOrQuerySchema::TableOrQuerySchema ( Connection * conn,

int id

)

Creates a new TableOrQuerySchema variant object, retrieving table or query schema using conn connection and id. You should check whether a query or table has been found by testing (query() || table()) expression.
Definition at line 222 of file kexidb/utils.cpp.
References KexiDBWarn, m_query, and m_table.

TableOrQuerySchema::TableOrQuerySchema ( TableSchema * table )

Creates a new TableOrQuerySchema variant object, keeping a pointer so table object.
Definition at line 231 of file kexidb/utils.cpp.
References KexiDBWarn, and m_table.

TableOrQuerySchema::TableOrQuerySchema ( QuerySchema * query )

Creates a new TableOrQuerySchema variant object, keeping a pointer so query object.
Definition at line 239 of file kexidb/utils.cpp.
References KexiDBWarn, and m_query.

Member Function Documentation

QString TableOrQuerySchema::captionOrName ( ) const

Returns:
caption (if present) or name of the table/query

Definition at line 268 of file kexidb/utils.cpp.
References KexiDB::SchemaData::caption(), m_name, m_table, and KexiDB::SchemaData::name().
Referenced by KexiCSVExportWizard::KexiCSVExportWizard(), KexiSimplePrintingCommand::print(), KexiCSVExportWizard::showPage(), and KexiSimplePrintingCommand::showPrintPreview().

QueryColumnInfo * TableOrQuerySchema::columnInfo ( const QString & name )

Like Field* field(const QString& name); but returns all information associated with field/column name.
Definition at line 286 of file kexidb/utils.cpp.
References m_query, m_table, and KexiDB::TableSchema::query().
Referenced by KexiFormView::insertAutoFields(), and KexiFormView::updateAutoFieldsDataSource().

const QueryColumnInfo::Vector TableOrQuerySchema::columns ( bool unique = false )

Returns:
all columns for the table or the query

Definition at line 247 of file kexidb/utils.cpp.
References KexiDB::QuerySchema::Default, KexiDBWarn, m_query, m_table, KexiDB::TableSchema::query(), and KexiDB::QuerySchema::Unique.
Referenced by KexiFieldListView::setSchema(), and KexiFieldComboBox::setTableOrQuery().

Connection * TableOrQuerySchema::connection ( ) const

Returns:
connection object, for table or query or 0 if there's no table or query defined.

Definition at line 314 of file kexidb/utils.cpp.
References KexiDB::TableSchema::connection(), and m_table.
Referenced by KexiCSVExport::exportData().

void TableOrQuerySchema::debug ( )

Shows debug information about table or query.
Definition at line 306 of file kexidb/utils.cpp.
References KexiDB::FieldList::debug(), and m_table.

QString TableOrQuerySchema::debugString ( )

Returns:
String for debugging purposes.

Definition at line 297 of file kexidb/utils.cpp.
References KexiDB::TableSchema::debugString(), m_query, and m_table.

Field * TableOrQuerySchema::field ( const QString & name )

Returns:
a field of the table or the query schema for name name or 0 if there is no such field.

Definition at line 276 of file kexidb/utils.cpp.
References KexiDB::FieldList::field(), m_query, and m_table.

QCString TableOrQuerySchema::name ( ) const

Returns:
name of a query or table

Definition at line 259 of file kexidb/utils.cpp.
References m_name, m_query, m_table, and KexiDB::SchemaData::name().
Referenced by KexiFieldListView::dragObject(), and KexiRelationViewTableContainer::KexiRelationViewTableContainer().

QuerySchema* KexiDB::TableOrQuerySchema::query ( ) const [inline]

Returns:
a pointer to the query if it's provided

Definition at line 180 of file kexidb/utils.h.
Referenced by KexiFieldComboBox::indexOfField(), KexiSimplePrintingEngine::init(), KexiFormView::insertAutoFields(), KexiCSVExport::exportData(), KexiCSVExportWizard::KexiCSVExportWizard(), KexiDB::fieldCount(), KexiSimplePrintingCommand::print(), KexiFieldComboBox::setTableOrQuery(), KexiSimplePrintingCommand::showPrintPreview(), KexiDataSourcePage::slotDataSourceChanged(), KexiLookupColumnPage::slotRowSourceChanged(), KexiFormView::updateAutoFieldsDataSource(), and KexiFormView::updateValuesForSubproperties().

TableSchema* KexiDB::TableOrQuerySchema::table ( ) const [inline]

Returns:
a pointer to the table if it's provided

Definition at line 183 of file kexidb/utils.h.
Referenced by KexiFieldListView::dragObject(), KexiFieldComboBox::indexOfField(), KexiSimplePrintingEngine::init(), KexiFormView::insertAutoFields(), KexiCSVExport::exportData(), KexiCSVExportWizard::KexiCSVExportWizard(), KexiDB::fieldCount(), KexiSimplePrintingCommand::print(), KexiFieldComboBox::setTableOrQuery(), KexiSimplePrintingCommand::showPrintPreview(), KexiDataSourcePage::slotDataSourceChanged(), KexiLookupColumnPage::slotRowSourceChanged(), KexiFormView::updateAutoFieldsDataSource(), and KexiFormView::updateValuesForSubproperties().

Member Data Documentation

QCString KexiDB::TableOrQuerySchema::m_name [protected]

the name is kept here because m_table and m_table can be 0 and we still want name() and acptionOrName() work.

Definition at line 212 of file kexidb/utils.h.
Referenced by captionOrName(), and name().

QuerySchema* KexiDB::TableOrQuerySchema::m_query [protected]

Definition at line 215 of file kexidb/utils.h.
Referenced by columnInfo(), columns(), debugString(), field(), name(), and TableOrQuerySchema().

TableSchema* KexiDB::TableOrQuerySchema::m_table [protected]

Definition at line 214 of file kexidb/utils.h.
Referenced by captionOrName(), columnInfo(), columns(), connection(), debug(), debugString(), field(), name(), and TableOrQuerySchema().

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


Public Member Functions
	TableOrQuerySchema (Connection *conn, const QCString &name)
	TableOrQuerySchema (Connection *conn, const QCString &name, bool table)
	TableOrQuerySchema (FieldList &tableOrQuery)
	TableOrQuerySchema (Connection *conn, int id)
	TableOrQuerySchema (TableSchema *table)
	TableOrQuerySchema (QuerySchema *query)
QuerySchema *	query () const
TableSchema *	table () const
QCString	name () const
QString	captionOrName () const
const QueryColumnInfo::Vector	columns (bool unique=false)
Field *	field (const QString &name)
QueryColumnInfo *	columnInfo (const QString &name)
Connection *	connection () const
QString	debugString ()
void	debug ()
Protected Attributes
QCString	m_name
	the name is kept here because m_table and m_table can be 0 and we still want name() and acptionOrName() work.
TableSchema *	m_table
QuerySchema *	m_query

Kexi API Documentation (2.0 alpha)

KexiDB::TableOrQuerySchema Class Reference

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation