Public Types | Public Member Functions | Public Attributes | List of all members
KexiDB::QueryColumnInfo Class Reference

#include <queryschema.h>

Public Types

typedef TQPtrVector< QueryColumnInfo > Vector
 
typedef TQPtrList< QueryColumnInfo > List
 
typedef TQPtrListIterator< QueryColumnInfo > ListIterator
 

Public Member Functions

 QueryColumnInfo (Field *f, const TQCString &_alias, bool _visible, QueryColumnInfo *foreignColumn=0)
 
TQCString aliasOrName () const
 
TQString captionOrAliasOrName () const
 
int indexForVisibleLookupValue () const
 
void setIndexForVisibleLookupValue (int index)
 
QueryColumnInfo * foreignColumn () const
 
TQString debugString () const
 

Public Attributes

Field * field
 
TQCString alias
 
bool visible: 1
 

Detailed Description

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

The following information is assigned:

Definition at line 48 of file queryschema.h.

Member Typedef Documentation

◆ List

typedef TQPtrList<QueryColumnInfo> KexiDB::QueryColumnInfo::List

Definition at line 52 of file queryschema.h.

◆ ListIterator

typedef TQPtrListIterator<QueryColumnInfo> KexiDB::QueryColumnInfo::ListIterator

Definition at line 53 of file queryschema.h.

◆ Vector

typedef TQPtrVector<QueryColumnInfo> KexiDB::QueryColumnInfo::Vector

Definition at line 51 of file queryschema.h.

Constructor & Destructor Documentation

◆ QueryColumnInfo()

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

Definition at line 41 of file queryschema.cpp.

◆ ~QueryColumnInfo()

QueryColumnInfo::~QueryColumnInfo ( )

Definition at line 48 of file queryschema.cpp.

Member Function Documentation

◆ aliasOrName()

TQCString KexiDB::QueryColumnInfo::aliasOrName ( ) const
inline
Returns
alias if it is not empty, field's name otherwise.

Definition at line 59 of file queryschema.h.

◆ captionOrAliasOrName()

TQString 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.

◆ debugString()

TQString QueryColumnInfo::debugString ( ) const
Returns
string for debugging purposes.

Definition at line 52 of file queryschema.cpp.

◆ foreignColumn()

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.

◆ indexForVisibleLookupValue()

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 defined. Cached for efficiency as we use this information frequently.
See also
LookupFieldSchema::visibleVolumn()

Definition at line 75 of file queryschema.h.

◆ setIndexForVisibleLookupValue()

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.

Member Data Documentation

◆ alias

TQCString KexiDB::QueryColumnInfo::alias

Definition at line 69 of file queryschema.h.

◆ field

Field* KexiDB::QueryColumnInfo::field

Definition at line 68 of file queryschema.h.

◆ visible

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.

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