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

KexiDB::QueryColumnInfo Class Reference

#include <queryschema.h>

List of all members.

---

Detailed Description

Helper class that assigns additional information for the column in a query.

The following information is assigned:

• alias
• visibility QueryColumnInfo::Vector is created and returned by QuerySchema::fieldsExpanded(). It is efficiently cached within the QuerySchema object.

Definition at line 48 of file queryschema.h.

Public Types
typedef QPtrVector< QueryColumnInfo >	Vector
typedef QPtrList< QueryColumnInfo >	List
typedef QPtrListIterator< QueryColumnInfo >	ListIterator
Public Member Functions
	QueryColumnInfo (Field *f, const QCString &_alias, bool _visible, QueryColumnInfo *foreignColumn=0)
	~QueryColumnInfo ()
QCString	aliasOrName () const
QString	captionOrAliasOrName () const
int	indexForVisibleLookupValue () const
void	setIndexForVisibleLookupValue (int index)
QueryColumnInfo *	foreignColumn () const
QString	debugString () const
Public Attributes
Field *	field
QCString	alias
bool	visible: 1
	true if this column is visible to the user (and its data is fetched by the engine)

---

Member Typedef Documentation

typedef QPtrList<QueryColumnInfo> KexiDB::QueryColumnInfo::List

Definition at line 52 of file queryschema.h.

typedef QPtrListIterator<QueryColumnInfo> KexiDB::QueryColumnInfo::ListIterator

Definition at line 53 of file queryschema.h.

typedef QPtrVector<QueryColumnInfo> KexiDB::QueryColumnInfo::Vector

Definition at line 51 of file queryschema.h.

---

Constructor & Destructor Documentation

QueryColumnInfo::QueryColumnInfo (  Field *  f, const QCString &  _alias, bool  _visible, QueryColumnInfo *  foreignColumn = 0 )

Definition at line 41 of file queryschema.cpp.

QueryColumnInfo::~QueryColumnInfo (   )

Definition at line 48 of file queryschema.cpp.

---

Member Function Documentation

QCString KexiDB::QueryColumnInfo::aliasOrName (   )  const [inline]

Returns: alias if it is not empty, field's name otherwise. Definition at line 59 of file queryschema.h. References field, and KexiDB::Field::name(). Referenced by KexiDB::QuerySchema::fieldsExpanded(), KexiFormView::insertAutoFields(), KexiFieldListView::setSchema(), KexiFieldComboBox::setTableOrQuery(), and KexiDB::OrderByColumn::toSQLString().

QString KexiDB::QueryColumnInfo::captionOrAliasOrName (   )  const [inline]

Returns: field's caption if it is not empty, field's alias otherwise. If alias is also empty - returns field's name. Definition at line 65 of file queryschema.h. References KexiDB::Field::caption(), and field. Referenced by KexiFormView::insertAutoFields(), KexiBlobTableEdit::KexiBlobTableEdit(), KexiDBAutoField::setColumnInfoInternal(), and KexiFieldComboBox::setTableOrQuery().

QString QueryColumnInfo::debugString (   )  const

Returns: string for debugging purposes. Definition at line 52 of file queryschema.cpp. References alias, field, and KexiDB::Field::name(). Referenced by KexiDB::QuerySchema::computeFieldsExpanded(), KexiDB::QuerySchema::debugString(), and KexiDB::OrderByColumn::debugString().

QueryColumnInfo* KexiDB::QueryColumnInfo::foreignColumn (   )  const [inline]

Returns: non-0 if this column is a visible column for other column Definition at line 81 of file queryschema.h. Referenced by KexiDB::QuerySchema::computeFieldsExpanded().

int KexiDB::QueryColumnInfo::indexForVisibleLookupValue (   )  const [inline]

Returns: index of column with visible lookup value within the 'fields expanded' vector. -1 means no visible lookup value is available because there is no lookup for the column. Cached for efficiency as we use this information frequently. See also: LookupFieldSchema::visibleVolumn() Definition at line 75 of file queryschema.h. Referenced by KexiComboBoxTableEdit::createInternalEditor(), KexiTableViewData::KexiTableViewData(), and KexiTableViewData::setSorting().

void KexiDB::QueryColumnInfo::setIndexForVisibleLookupValue (  int  index  )  [inline]

Sets index of column with visible lookup value within the 'fields expanded' vector. Definition at line 78 of file queryschema.h. Referenced by KexiDB::QuerySchema::computeFieldsExpanded().

---

Member Data Documentation

QCString KexiDB::QueryColumnInfo::alias

Definition at line 69 of file queryschema.h. Referenced by debugString(), KexiTableViewColumn::KexiTableViewColumn(), and KexiDB::OrderByColumn::toSQLString().

Field* KexiDB::QueryColumnInfo::field

Definition at line 68 of file queryschema.h. Referenced by KexiTableViewColumn::acceptsFirstChar(), KexiDB::QuerySchema::autoIncrementFields(), KexiDB::QuerySchema::computeFieldsExpanded(), KexiComboBoxTableEdit::createInternalEditor(), debugString(), KexiTableEdit::displayedField(), KexiDB::QuerySchema::field(), KexiFormDataItemInterface::field(), KexiFormView::insertAutoFields(), KexiDB::Connection::insertRow(), KexiFormDataProvider::invalidateDataSources(), KexiCSVExport::exportData(), KexiTableViewColumn::KexiTableViewColumn(), KexiDBTextWidgetInterface::paint(), KexiSimplePrintingEngine::paintRecord(), KexiDB::QuerySchema::pkeyFieldsOrder(), KexiDBTextWidgetInterface::setColumnInfo(), KexiDBLineEdit::setColumnInfo(), KexiDBAutoField::setColumnInfoInternal(), KexiFieldListView::setSchema(), KexiTableViewData::setSorting(), KexiFieldComboBox::setTableOrQuery(), KexiDBTextEdit::setValueInternal(), KexiDB::OrderByColumn::toSQLString(), KexiDBLineEdit::value(), KexiDBLineEdit::valueIsEmpty(), and KexiDBLineEdit::valueIsValid().

bool KexiDB::QueryColumnInfo::visible

true if this column is visible to the user (and its data is fetched by the engine) Definition at line 87 of file queryschema.h. Referenced by KexiQueryDesignerGuiEditor::buildSchema(), and KexiTableViewData::KexiTableViewData().

---

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

• queryschema.h
• queryschema.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:47 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003