kexi

Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
KexiTableViewColumn Class Reference

#include <kexitableviewdata.h>

Public Types

typedef TQPtrList< KexiTableViewColumn > List
 
typedef TQPtrListIterator< KexiTableViewColumn > ListIterator
 

Public Member Functions

 KexiTableViewColumn (KexiDB::Field &f, bool owner=false)
 
 KexiTableViewColumn (const TQString &name, KexiDB::Field::Type ctype, uint cconst=KexiDB::Field::NoConstraints, uint options=KexiDB::Field::NoOptions, uint length=0, uint precision=0, TQVariant defaultValue=TQVariant(), const TQString &caption=TQString(), const TQString &description=TQString(), uint width=0)
 
 KexiTableViewColumn (const TQString &name, KexiDB::Field::Type ctype, const TQString &caption, const TQString &description=TQString())
 
 KexiTableViewColumn (const KexiDB::QuerySchema &query, KexiDB::QueryColumnInfo &aColumnInfo, KexiDB::QueryColumnInfo *aVisibleLookupColumnInfo=0)
 
virtual bool acceptsFirstChar (const TQChar &ch) const
 
bool isReadOnly () const
 
void setReadOnly (bool ro)
 
bool visible () const
 
void setVisible (bool v)
 
void setIcon (const TQIconSet &icon)
 
TQIconSet icon () const
 
void setHeaderTextVisible (bool visible)
 
bool isHeaderTextVisible () const
 
TQString captionAliasOrName () const
 
void setValidator (KexiUtils::Validator *v)
 
KexiUtils::Validator * validator () const
 
void setRelatedData (KexiTableViewData *data)
 
KexiTableViewData * relatedData () const
 
KexiDB::Field * field () const
 
void setRelatedDataEditable (bool set)
 
bool relatedDataEditable () const
 

Public Attributes

KexiDB::QueryColumnInfo * columnInfo
 
KexiDB::QueryColumnInfo * visibleLookupColumnInfo
 
bool isDBAware: 1
 

Protected Member Functions

 KexiTableViewColumn (bool)
 
void init ()
 

Protected Attributes

TQString m_captionAliasOrName
 
TQIconSet m_icon
 
KexiUtils::Validator * m_validator
 
KexiTableViewData * m_data
 
KexiTableViewData * m_relatedData
 
uint m_relatedDataPKeyID
 
KexiDB::Field * m_field
 
bool m_readOnly: 1
 
bool m_fieldOwned: 1
 
bool m_visible: 1
 
bool m_relatedDataEditable: 1
 
bool m_headerTextVisible: 1
 

Friends

class KexiTableViewData
 

Detailed Description

Single column definition.

Definition at line 52 of file kexitableviewdata.h.

Member Typedef Documentation

◆ List

typedef TQPtrList<KexiTableViewColumn> KexiTableViewColumn::List

Definition at line 54 of file kexitableviewdata.h.

◆ ListIterator

typedef TQPtrListIterator<KexiTableViewColumn> KexiTableViewColumn::ListIterator

Definition at line 55 of file kexitableviewdata.h.

Constructor & Destructor Documentation

◆ KexiTableViewColumn() [1/5]

KexiTableViewColumn::KexiTableViewColumn ( KexiDB::Field &  f,
bool  owner = false 
)

Not db-aware ctor. if owner is true, the field will be owned by this column, so you shouldn't care about destroying this field.

Definition at line 46 of file kexitableviewdata.cpp.

◆ KexiTableViewColumn() [2/5]

KexiTableViewColumn::KexiTableViewColumn ( const TQString &  name,
KexiDB::Field::Type  ctype,
uint  cconst = KexiDB::Field::NoConstraints,
uint  options = KexiDB::Field::NoOptions,
uint  length = 0,
uint  precision = 0,
TQVariant  defaultValue = TQVariant(),
const TQString &  caption = TQString(),
const TQString &  description = TQString(),
uint  width = 0 
)

Not db-aware, convenience ctor, like above. The field is created using specified parameters that are equal to these accepted by KexiDB::Field ctor. The column will be the owner of this automatically generated field.

Definition at line 57 of file kexitableviewdata.cpp.

◆ KexiTableViewColumn() [3/5]

KexiTableViewColumn::KexiTableViewColumn ( const TQString &  name,
KexiDB::Field::Type  ctype,
const TQString &  caption,
const TQString &  description = TQString() 
)

Not db-aware, convenience ctor, simplified version of the above.

Definition at line 81 of file kexitableviewdata.cpp.

◆ KexiTableViewColumn() [4/5]

KexiTableViewColumn::KexiTableViewColumn ( const KexiDB::QuerySchema &  query,
KexiDB::QueryColumnInfo &  aColumnInfo,
KexiDB::QueryColumnInfo *  aVisibleLookupColumnInfo = 0 
)

Db-aware version.

Todo:
2.0: remove this when queries become editable ^^^^^^^^^^^^^^

Definition at line 101 of file kexitableviewdata.cpp.

◆ ~KexiTableViewColumn()

KexiTableViewColumn::~KexiTableViewColumn ( )
virtual

Definition at line 149 of file kexitableviewdata.cpp.

◆ KexiTableViewColumn() [5/5]

KexiTableViewColumn::KexiTableViewColumn ( bool  )
protected

special ctor that do not allocate d member;

Definition at line 140 of file kexitableviewdata.cpp.

Member Function Documentation

◆ acceptsFirstChar()

bool KexiTableViewColumn::acceptsFirstChar ( const TQChar &  ch) const
virtual

Definition at line 208 of file kexitableviewdata.cpp.

◆ captionAliasOrName()

TQString KexiTableViewColumn::captionAliasOrName ( ) const
inline
Returns
whatever is available:
  • field's caption
  • or field's alias (from query)
  • or finally - field's name

Definition at line 123 of file kexitableviewdata.h.

◆ field()

KexiDB::Field * KexiTableViewColumn::field ( ) const
inline
Returns
field for this column. For db-aware information is taken from columnInfo member.

Definition at line 149 of file kexitableviewdata.h.

◆ icon()

TQIconSet KexiTableViewColumn::icon ( ) const
inline
Returns
bame of icon displayed in the caption area (header).

Definition at line 109 of file kexitableviewdata.h.

◆ init()

void KexiTableViewColumn::init ( )
protected

Definition at line 157 of file kexitableviewdata.cpp.

◆ isHeaderTextVisible()

bool KexiTableViewColumn::isHeaderTextVisible ( ) const
inline
Returns
true if caption has to be displayed in the column's header, (or field's name if caption is empty.

Definition at line 117 of file kexitableviewdata.h.

◆ isReadOnly()

bool KexiTableViewColumn::isReadOnly ( ) const
Returns
true if the column is read-only For db-aware column this can depend on whether the column is in parent table of this query.
See also
setReadOnly()

Definition at line 203 of file kexitableviewdata.cpp.

◆ relatedData()

KexiTableViewData * KexiTableViewColumn::relatedData ( ) const
inline

For not-db-aware data only: Related data data for this column, what defines simple one-field. NULL by default.

See also
setRelatedData()

Definition at line 145 of file kexitableviewdata.h.

◆ relatedDataEditable()

bool KexiTableViewColumn::relatedDataEditable ( ) const
inline

Only usable if related data is set (ie. this is for combo boxes).

Returns
'editable' flag for this column. False by default.
See also
setRelatedDataEditable(bool).

Definition at line 159 of file kexitableviewdata.h.

◆ setHeaderTextVisible()

void KexiTableViewColumn::setHeaderTextVisible ( bool  visible)
inline

If visible is true, caption has to be displayed in the column's header, (or field's name if caption is empty. True by default.

Definition at line 113 of file kexitableviewdata.h.

◆ setIcon()

void KexiTableViewColumn::setIcon ( const TQIconSet &  icon)
inline

Sets icon for displaying in the caption area (header).

Definition at line 106 of file kexitableviewdata.h.

◆ setReadOnly()

void KexiTableViewColumn::setReadOnly ( bool  ro)
inline

forces readOnly flag to be set to ro

Definition at line 93 of file kexitableviewdata.h.

◆ setRelatedData()

void KexiTableViewColumn::setRelatedData ( KexiTableViewData *  data)

For not-db-aware data only: Sets related data data for this column, what defines simple one-field, one-to-many relationship between this column and the primary key in data. The relationship will be used to generate a popup editor instead of just regular editor. This assignment has no result if data has no primary key defined. data is owned, so is will be destroyed when needed. It is also destroyed when another data (or NULL) is set for the same column.

Definition at line 177 of file kexitableviewdata.cpp.

◆ setRelatedDataEditable()

void KexiTableViewColumn::setRelatedDataEditable ( bool  set)

Only usable if related data is set (ie. this is for combo boxes). Sets 'editable' flag for this column, what means a new value can be entered by hand. This is similar to TQComboBox::setEditable().

Definition at line 198 of file kexitableviewdata.cpp.

◆ setValidator()

void KexiTableViewColumn::setValidator ( KexiUtils::Validator *  v)

Assigns validator v for this column. If the validator has no parent object, it will be owned by the column, so you shouldn't care about destroying it.

Definition at line 168 of file kexitableviewdata.cpp.

◆ setVisible()

void KexiTableViewColumn::setVisible ( bool  v)
inline

Changes column visibility.

Definition at line 99 of file kexitableviewdata.h.

◆ validator()

KexiUtils::Validator * KexiTableViewColumn::validator ( ) const
inline
Returns
validator assigned for this column of 0 if there is no validator assigned.

Definition at line 131 of file kexitableviewdata.h.

◆ visible()

bool KexiTableViewColumn::visible ( ) const
inline

Column visibility. By default column is visible.

Definition at line 96 of file kexitableviewdata.h.

Friends And Related Symbol Documentation

◆ KexiTableViewData

friend class KexiTableViewData
friend

Definition at line 209 of file kexitableviewdata.h.

Member Data Documentation

◆ columnInfo

KexiDB::QueryColumnInfo* KexiTableViewColumn::columnInfo

A rich field information for db-aware data. For not-db-aware data it is always 0 (use field() instead).

Definition at line 163 of file kexitableviewdata.h.

◆ isDBAware

bool KexiTableViewColumn::isDBAware

true if data is stored in DB, not only in memeory

Definition at line 172 of file kexitableviewdata.h.

◆ m_captionAliasOrName

TQString KexiTableViewColumn::m_captionAliasOrName
protected

Definition at line 189 of file kexitableviewdata.h.

◆ m_data

KexiTableViewData* KexiTableViewColumn::m_data
protected

Data that this column is assigned to.

Definition at line 196 of file kexitableviewdata.h.

◆ m_field

KexiDB::Field* KexiTableViewColumn::m_field
protected

Definition at line 201 of file kexitableviewdata.h.

◆ m_fieldOwned

bool KexiTableViewColumn::m_fieldOwned
protected

Definition at line 204 of file kexitableviewdata.h.

◆ m_headerTextVisible

bool KexiTableViewColumn::m_headerTextVisible
protected

Definition at line 207 of file kexitableviewdata.h.

◆ m_icon

TQIconSet KexiTableViewColumn::m_icon
protected

Definition at line 191 of file kexitableviewdata.h.

◆ m_readOnly

bool KexiTableViewColumn::m_readOnly
protected

Definition at line 203 of file kexitableviewdata.h.

◆ m_relatedData

KexiTableViewData* KexiTableViewColumn::m_relatedData
protected

Definition at line 198 of file kexitableviewdata.h.

◆ m_relatedDataEditable

bool KexiTableViewColumn::m_relatedDataEditable
protected

Definition at line 206 of file kexitableviewdata.h.

◆ m_relatedDataPKeyID

uint KexiTableViewColumn::m_relatedDataPKeyID
protected

Definition at line 199 of file kexitableviewdata.h.

◆ m_validator

KexiUtils::Validator* KexiTableViewColumn::m_validator
protected

Definition at line 193 of file kexitableviewdata.h.

◆ m_visible

bool KexiTableViewColumn::m_visible
protected

Definition at line 205 of file kexitableviewdata.h.

◆ visibleLookupColumnInfo

KexiDB::QueryColumnInfo* KexiTableViewColumn::visibleLookupColumnInfo

A rich field information for db-aware data. Specifies information for a column that should be visible instead of columnInfo. For example case see KexiDB::QueryColumnInfo::Vector KexiDB::QuerySchema::fieldsExpanded(KexiDB::QuerySchema::FieldsExpandedOptions options = Default)

For not-db-aware data it is always 0.

Definition at line 170 of file kexitableviewdata.h.

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