The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::ColumnItem Class Reference

A ColumnItem item is used to represent a single header column. More...

#include <vcf/ApplicationKit/ColumnItem.h>

Inheritance diagram for VCF::ColumnItem:

List of all members.

Public Member Functions
virtual	~ColumnItem ()
virtual double	getWidth ()=0
	returns the width of the coumn.
virtual void	setWidth (const double &width)=0
	sets the width of the column
virtual void	setCaption (const String &caption)=0
	sets the caption of the column.
virtual String	getCaption ()=0
	returns the caption for the column item
virtual void	setCaptionAlignment (const TextAlignmentType &alignment)=0
	sets the alignment of the caption.
virtual TextAlignmentType	getCaptionAlignment ()=0
	gets the current alignment type fopr the column.

---

Detailed Description

A ColumnItem item is used to represent a single header column.

ColumnItems can be found in the HeaderControl, and ListViewControl, and are used to display a series of rectangular shapes that each represent a column vertical column.

---

Constructor & Destructor Documentation

virtual VCF::ColumnItem::~ColumnItem (   )  [inline, virtual]

---

Member Function Documentation

virtual String VCF::ColumnItem::getCaption (   )  [pure virtual]

returns the caption for the column item Returns: String the column's caption Implemented in VCF::DefaultColumnItem.

virtual TextAlignmentType VCF::ColumnItem::getCaptionAlignment (   )  [pure virtual]

gets the current alignment type fopr the column. Returns: TextAlignmentType the alignment type of the column See also: setCaptionAlignment() Implemented in VCF::DefaultColumnItem.

virtual double VCF::ColumnItem::getWidth (   )  [pure virtual]

returns the width of the coumn. The width should always be greater than or equal to 0 Implemented in VCF::DefaultColumnItem.

virtual void VCF::ColumnItem::setCaption (  const String &  caption  )  [pure virtual]

sets the caption of the column. If the text is wider than the current width of the column it will be truncated to fit and drawn with an ellipsis ("...") Parameters: String  the new column caption Implemented in VCF::DefaultColumnItem.

virtual void VCF::ColumnItem::setCaptionAlignment (  const TextAlignmentType &  alignment  )  [pure virtual]

sets the alignment of the caption. Setting the caption alignment determines how the caption is drawn and to which side the text is aligned. You can align it to the left, right, or center. Parameters: TextAlignmentType  teh alignment type for the column when it is drawn Implemented in VCF::DefaultColumnItem.

virtual void VCF::ColumnItem::setWidth (  const double &  width  )  [pure virtual]

sets the width of the column Parameters: double  width - the new column width Implemented in VCF::DefaultColumnItem.

---

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

• vcf/ApplicationKit/ColumnItem.h

Comments or Suggestions?    License Information