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

VCF::DefaultTableCellItem Class Reference

#include <vcf/ApplicationKit/DefaultTableCellItem.h>

Inheritance diagram for VCF::DefaultTableCellItem:

List of all members.

Public Member Functions
	DefaultTableCellItem ()
virtual	~DefaultTableCellItem ()
virtual bool	containsPoint (Point *pt)
	This is called to determine if a given point is within the bounds of the item.
virtual uint32	getIndex ()
	Returns the index of the item within it's model.
virtual void	setIndex (const uint32 &index)
virtual void *	getData ()
	Returns some application defined data.
virtual void	setData (void *data)
	Sets the application defined data.
virtual void	paint (GraphicsContext *context, Rect *paintRect)
virtual TableItemEditor *	createItemEditor ()
	Calling this will create a new table item editor.
virtual bool	isSelected ()
virtual bool	isReadonly ()
	Identifies if this item is in a readonly state, or if it's possible to edit it.
virtual bool	isFixed ()
virtual bool	isFocused ()
virtual bool	isDropHighlighted ()
virtual bool	isEditable ()
virtual void	setSelected (const bool &val)
virtual void	setReadonly (const bool &val)
virtual void	setFocused (const bool &val)
virtual void	setDropHighlighted (const bool &val)
virtual void	setFixed (const bool &val)
virtual String	getCaption ()
virtual void	setCaption (const String &caption)
virtual Rect *	getBounds ()
	returns the Bounds for the Item or NULL if not applicable.
virtual int32	getImageIndex ()
virtual void	setImageIndex (const int32 &imageIndex)
virtual bool	canPaint ()
	indicates whether the item can paint itself.
virtual void	setBounds (Rect *bounds)
virtual int32	getStateImageIndex ()
	not supported
virtual void	setModel (Model *model)
	Sets the model that this item is a part of.
virtual void	setStateImageIndex (const int32 &index)
	not supported
virtual double	getTextCellWidth (GraphicsContext *context)
	rerturns the width of the cell, taking into account the text of the cell, and any other formatting rules the cell wants to consider.
virtual double	getTextCellHeight (GraphicsContext *context)
virtual const Color &	getColor ()
	Returns a non modifiable color reference.
virtual void	setColor (Color *color)
virtual const Font &	getFont ()
	Returns a non modifiable font reference.
virtual void	setFont (Font *font)

---

Constructor & Destructor Documentation

VCF::DefaultTableCellItem::DefaultTableCellItem (   )

virtual VCF::DefaultTableCellItem::~DefaultTableCellItem (   )  [virtual]

---

Member Function Documentation

virtual bool VCF::DefaultTableCellItem::canPaint (   )  [inline, virtual]

indicates whether the item can paint itself. In general this is often false, but when true, the control that contains the item should call the item's paint() method whenever the item needs repainting. Implements VCF::Item.

virtual bool VCF::DefaultTableCellItem::containsPoint (  Point *  pt  )  [virtual]

This is called to determine if a given point is within the bounds of the item. The bounds may be slightly different than what is returned by getBounds(). For example, an item may not support getBounds(), but may have a non-rectangular region and may implement containsPoint() accordingly. Implements VCF::Item.

virtual TableItemEditor* VCF::DefaultTableCellItem::createItemEditor (   )  [virtual]

Calling this will create a new table item editor. The implementor is responsible for returning an editor that is properly initialized with the data from the item. Returns: TableItemEditor an new instance of an editor, or NULL if no editing is supported. If isReadonly() returns true, then this should return NULL regardless of whether or not the item implementation supports and editor or not. See also: isReadonly() Implements VCF::TableCellItem.

virtual Rect* VCF::DefaultTableCellItem::getBounds (   )  [inline, virtual]

returns the Bounds for the Item or NULL if not applicable. Implements VCF::Item.

virtual String VCF::DefaultTableCellItem::getCaption (   )  [virtual]

Implements VCF::TableCellItem.

virtual const Color& VCF::DefaultTableCellItem::getColor (   )  [virtual]

Returns a non modifiable color reference. If you need to change the cell's color, you should call setColor(). See also: setColor() Implements VCF::TableCellItem.

virtual void* VCF::DefaultTableCellItem::getData (   )  [virtual]

Returns some application defined data. This can be anything you want, hence the void* storage. Implements VCF::Item.

virtual const Font& VCF::DefaultTableCellItem::getFont (   )  [virtual]

Returns a non modifiable font reference. If you need to change the cell's font, you should call setFont(). See also: setFont() Implements VCF::TableCellItem.

virtual int32 VCF::DefaultTableCellItem::getImageIndex (   )  [inline, virtual]

Implements VCF::Item.

virtual uint32 VCF::DefaultTableCellItem::getIndex (   )  [inline, virtual]

Returns the index of the item within it's model. Implements VCF::Item.

virtual int32 VCF::DefaultTableCellItem::getStateImageIndex (   )  [inline, virtual]

not supported Implements VCF::Item.

virtual double VCF::DefaultTableCellItem::getTextCellHeight (  GraphicsContext *  context  )  [virtual]

Implements VCF::TableCellItem.

virtual double VCF::DefaultTableCellItem::getTextCellWidth (  GraphicsContext *  context  )  [virtual]

rerturns the width of the cell, taking into account the text of the cell, and any other formatting rules the cell wants to consider. Implements VCF::TableCellItem.

virtual bool VCF::DefaultTableCellItem::isDropHighlighted (   )  [inline, virtual]

Implements VCF::TableCellItem.

virtual bool VCF::DefaultTableCellItem::isEditable (   )  [inline, virtual]

Implements VCF::TableCellItem.

virtual bool VCF::DefaultTableCellItem::isFixed (   )  [inline, virtual]

Implements VCF::TableCellItem.

virtual bool VCF::DefaultTableCellItem::isFocused (   )  [inline, virtual]

Implements VCF::TableCellItem.

virtual bool VCF::DefaultTableCellItem::isReadonly (   )  [inline, virtual]

Identifies if this item is in a readonly state, or if it's possible to edit it. Implements VCF::TableCellItem.

virtual bool VCF::DefaultTableCellItem::isSelected (   )  [inline, virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::paint (  GraphicsContext *  context, Rect *  paintRect )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultTableCellItem::setBounds (  Rect *  bounds  )  [virtual]

Implements VCF::Item.

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

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setColor (  Color *  color  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setData (  void *  data  )  [virtual]

Sets the application defined data. Implements VCF::Item.

virtual void VCF::DefaultTableCellItem::setDropHighlighted (  const bool &  val  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setFixed (  const bool &  val  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setFocused (  const bool &  val  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setFont (  Font *  font  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setImageIndex (  const int32 &  imageIndex  )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultTableCellItem::setIndex (  const uint32 &  index  )  [inline, virtual]

Implements VCF::Item.

virtual void VCF::DefaultTableCellItem::setModel (  Model *  model  )  [virtual]

Sets the model that this item is a part of. Subclasses may need or want to customize this. Reimplemented from VCF::Item.

virtual void VCF::DefaultTableCellItem::setReadonly (  const bool &  val  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setSelected (  const bool &  val  )  [virtual]

Implements VCF::TableCellItem.

virtual void VCF::DefaultTableCellItem::setStateImageIndex (  const int32 &  index  )  [inline, virtual]

not supported Implements VCF::Item.

---

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

• vcf/ApplicationKit/DefaultTableCellItem.h

Comments or Suggestions?    License Information