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

VCF::DefaultListItem Class Reference

#include <vcf/ApplicationKit/DefaultListItem.h>

Inheritance diagram for VCF::DefaultListItem:

List of all members.

Public Member Functions
	DefaultListItem ()
	DefaultListItem (ListModel *model)
	DefaultListItem (ListModel *model, const String &caption)
virtual	~DefaultListItem ()
void	init ()
	This is going to be removed from the bext release.
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 String	getCaption ()
virtual void	setCaption (const String &caption)
virtual void	paint (GraphicsContext *context, Rect *paintRect)
virtual bool	isSelected ()
virtual void	setSelected (const bool &selected)
virtual int32	getImageIndex ()
virtual void	setImageIndex (const int32 &imageIndex)
virtual Rect *	getBounds ()
	returns the Bounds for the Item or NULL if not applicable.
virtual bool	canPaint ()
	indicates whether the item can paint itself.
virtual void	addSubItem (const String &caption, void *data)
virtual void	addSubItem (ListItem::SubItem *subItem)
virtual void	removeSubItem (const uint32 &index)
virtual Enumerator< ListItem::SubItem * > *	getSubItems ()
virtual ListItem::SubItem *	getSubItem (const uint32 &index)
virtual uint32	getSubItemCount ()
virtual void	subItemChanged (ListItem::SubItem *item)
virtual void	setBounds (Rect *bounds)
virtual int32	getStateImageIndex ()
	not supported
virtual void	setStateImageIndex (const int32 &index)
	not supported

---

Constructor & Destructor Documentation

VCF::DefaultListItem::DefaultListItem (   )

VCF::DefaultListItem::DefaultListItem (  ListModel *  model  )

VCF::DefaultListItem::DefaultListItem (  ListModel *  model, const String &  caption )

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

---

Member Function Documentation

virtual void VCF::DefaultListItem::addSubItem (  ListItem::SubItem *  subItem  )  [virtual]

Implements VCF::ListItem.

virtual void VCF::DefaultListItem::addSubItem (  const String &  caption, void *  data )  [virtual]

Implements VCF::ListItem.

virtual bool VCF::DefaultListItem::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::DefaultListItem::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 Rect* VCF::DefaultListItem::getBounds (   )  [inline, virtual]

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

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

Implements VCF::ListItem.

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

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

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

Implements VCF::Item.

virtual uint32 VCF::DefaultListItem::getIndex (   )  [virtual]

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

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

not supported Implements VCF::Item.

virtual ListItem::SubItem* VCF::DefaultListItem::getSubItem (  const uint32 &  index  )  [virtual]

Implements VCF::ListItem.

virtual uint32 VCF::DefaultListItem::getSubItemCount (   )  [virtual]

Implements VCF::ListItem.

virtual Enumerator<ListItem::SubItem*>* VCF::DefaultListItem::getSubItems (   )  [virtual]

Implements VCF::ListItem.

void VCF::DefaultListItem::init (   )

This is going to be removed from the bext release. Deprecated: Reimplemented from VCF::Object.

virtual bool VCF::DefaultListItem::isSelected (   )  [virtual]

Implements VCF::Item.

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

Implements VCF::Item.

virtual void VCF::DefaultListItem::removeSubItem (  const uint32 &  index  )  [virtual]

Implements VCF::ListItem.

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

Implements VCF::Item.

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

Implements VCF::ListItem.

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

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

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

Implements VCF::Item.

virtual void VCF::DefaultListItem::setIndex (  const uint32 &  index  )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultListItem::setSelected (  const bool &  selected  )  [virtual]

Implements VCF::Item.

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

not supported Implements VCF::Item.

virtual void VCF::DefaultListItem::subItemChanged (  ListItem::SubItem *  item  )  [virtual]

Implements VCF::ListItem.

---

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

• vcf/ApplicationKit/DefaultListItem.h

Comments or Suggestions?    License Information