Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::DefaultTreeItem

VCF::DefaultTreeItem Class Reference

#include <vcf/ApplicationKit/DefaultTreeItem.h>

Inheritance diagram for VCF::DefaultTreeItem:

VCF::TreeItem VCF::Item VCF::Component VCF::ObjectWithEvents VCF::Object List of all members.

Public Types

enum  TreeEvents { teItemExpanded = ITEM_EVENT_CHANGED + 200 }

Public Member Functions

 DefaultTreeItem (const String &caption, Control *owningControl, TreeModel *model)
 DefaultTreeItem (const String &caption)
 DefaultTreeItem ()
virtual ~DefaultTreeItem ()
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 * getData ()
 Returns some application defined data.
virtual void setData (void *data)
 Sets the application defined data.
virtual Color * getTextColor ()
virtual void setTextColor (Color *color)
virtual void setTextBold (const bool &bold)
virtual bool getTextBold ()
virtual bool isLeaf ()
virtual bool isRoot ()
virtual TreeItem * getParent ()
virtual void setParent (TreeItem *parent)
virtual TreeItem * getNextChildNodeItem ()
 gets the next sibling item in the tree node, i.e.
virtual TreeItem * getPrevChildNodeItem ()
 gets the previous sibling item in the tree node, i.e.
virtual String getCaption ()
virtual void setCaption (const String &caption)
virtual uint32 getChildCount ()
virtual Enumerator< TreeItem * > * getChildren ()
void init ()
 This is going to be removed from the bext release.
virtual void addChild (TreeItem *child)
virtual void insertChild (const uint32 &index, TreeItem *child)
virtual void deleteChild (TreeItem *child)
virtual void deleteChildAtIndex (const uint32 &index)
virtual void clearChildren ()
virtual void setIndex (const uint32 &index)
virtual void paint (GraphicsContext *context, Rect *paintRect)
virtual bool isSelected ()
virtual void setSelected (const bool &selected)
virtual void setModel (Model *model)
 Sets the model that this item is a part of.
virtual void setControl (Control *control)
 Sets the owning control for this item.
virtual bool isExpanded ()
virtual void expand (const bool &isExpanded)
virtual void expandAllChildren (const bool &isExpanded)
virtual uint32 getLevel ()
virtual Rect * getBounds ()
 returns the Bounds for the Item or NULL if not applicable.
virtual int32 getImageIndex ()
virtual void setImageIndex (const int32 &imageIndex)
virtual int32 getSelectedImageIndex ()
virtual void setSelectedImageIndex (const int32 &selectedImageIndex)
virtual int32 getExpandedImageIndex ()
virtual void setExpandedImageIndex (const int32 &expandedImageIndex)
virtual bool canPaint ()
 indicates whether the item can paint itself.
virtual void setBounds (Rect *bounds)
virtual int32 getStateImageIndex ()
 not supported
virtual void setStateImageIndex (const int32 &index)
virtual void addSubItem (const String &caption, void *data)
virtual void addSubItem (SubItem *subItem)
virtual void removeSubItem (const uint32 &index)
virtual Enumerator< SubItem * > * getSubItems ()
virtual SubItem * getSubItem (const uint32 &index)
virtual uint32 getSubItemCount ()
virtual void subItemChanged (SubItem *item)

Protected Member Functions

virtual void changed (const uint32 &eventType=ITEM_EVENT_CHANGED)

Protected Attributes

bool textBold_
Color TextColor_
String caption_
TreeItem * parent_
void * userData_
uint32 index_
EnumeratorContainer< std::vector<
TreeItem * >, TreeItem * > 		enumContainer_
std::vector< TreeItem * > childNodeItems_
EnumeratorContainer< std::vector<
SubItem * >, SubItem * > 		enumSubItemsContainer_
std::vector< SubItem * > subItems_
bool selected_
bool isExpanded_
Rect bounds_
int32 imageIndex_
int32 selectedImageIndex_
int32 expandedImageIndex_
int32 stateImageIndex_

Member Enumeration Documentation

enum VCF::DefaultTreeItem::TreeEvents
 

Enumerator:
teItemExpanded 

Constructor & Destructor Documentation

VCF::DefaultTreeItem::DefaultTreeItem (  const String &  caption,
Control *  owningControl,
TreeModel *  model
) 
 

VCF::DefaultTreeItem::DefaultTreeItem (  const String &  caption  ) 
 

VCF::DefaultTreeItem::DefaultTreeItem (   ) 
 

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

Member Function Documentation

virtual void VCF::DefaultTreeItem::addChild (  TreeItem *  child  )  [virtual]
 

Implements VCF::TreeItem.

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

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

Implements VCF::TreeItem.

virtual bool VCF::DefaultTreeItem::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 void VCF::DefaultTreeItem::changed (  const uint32 &  eventType = ITEM_EVENT_CHANGED  )  [protected, virtual]
 

virtual void VCF::DefaultTreeItem::clearChildren (   )  [virtual]
 

Implements VCF::TreeItem.

virtual bool VCF::DefaultTreeItem::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 void VCF::DefaultTreeItem::deleteChild (  TreeItem *  child  )  [virtual]
 

Implements VCF::TreeItem.

virtual void VCF::DefaultTreeItem::deleteChildAtIndex (  const uint32 &  index  )  [virtual]
 

Implements VCF::TreeItem.

virtual void VCF::DefaultTreeItem::expand (  const bool &  isExpanded  )  [virtual]
 

Implements VCF::TreeItem.

virtual void VCF::DefaultTreeItem::expandAllChildren (  const bool &  isExpanded  )  [virtual]
 

Implements VCF::TreeItem.

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

returns the Bounds for the Item or NULL if not applicable.

Implements VCF::Item.

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

Implements VCF::TreeItem.

virtual uint32 VCF::DefaultTreeItem::getChildCount (   )  [virtual]
 

Implements VCF::TreeItem.

virtual Enumerator<TreeItem*>* VCF::DefaultTreeItem::getChildren (   )  [virtual]
 

Implements VCF::TreeItem.

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

Returns some application defined data.

This can be anything you want, hence the void* storage.

Implements VCF::Item.

virtual int32 VCF::DefaultTreeItem::getExpandedImageIndex (   )  [inline, virtual]
 

Implements VCF::TreeItem.

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

Implements VCF::Item.

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

Returns the index of the item within it's model.

Implements VCF::Item.

virtual uint32 VCF::DefaultTreeItem::getLevel (   )  [virtual]
 

Implements VCF::TreeItem.

virtual TreeItem* VCF::DefaultTreeItem::getNextChildNodeItem (   )  [virtual]
 

gets the next sibling item in the tree node, i.e.

an item with the same parent and at the same 'level' of this one.

Returns:
TreeItem*, a pointer to the following TreeItem. It returns NULL if this item is the first between the parent's children.

Implements VCF::TreeItem.

virtual TreeItem* VCF::DefaultTreeItem::getParent (   )  [virtual]
 

Implements VCF::TreeItem.

virtual TreeItem* VCF::DefaultTreeItem::getPrevChildNodeItem (   )  [virtual]
 

gets the previous sibling item in the tree node, i.e.

an item with the same parent and at the same 'level' of this one.

Returns:
TreeItem*, a pointer to the previous TreeItem. It returns NULL if this item is the first between the parent's children.

Implements VCF::TreeItem.

virtual int32 VCF::DefaultTreeItem::getSelectedImageIndex (   )  [inline, virtual]
 

Implements VCF::TreeItem.

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

not supported

Implements VCF::Item.

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

Implements VCF::TreeItem.

virtual uint32 VCF::DefaultTreeItem::getSubItemCount (   )  [inline, virtual]
 

Implements VCF::TreeItem.

virtual Enumerator<SubItem*>* VCF::DefaultTreeItem::getSubItems (   )  [inline, virtual]
 

Implements VCF::TreeItem.

virtual bool VCF::DefaultTreeItem::getTextBold (   )  [virtual]
 

Implements VCF::TreeItem.

virtual Color* VCF::DefaultTreeItem::getTextColor (   )  [virtual]
 

Implements VCF::TreeItem.

void VCF::DefaultTreeItem::init (   ) 
 

This is going to be removed from the bext release.

Deprecated:

Reimplemented from VCF::Object.

virtual void VCF::DefaultTreeItem::insertChild (  const uint32 &  index,
TreeItem *  child
)  [virtual]
 

Implements VCF::TreeItem.

virtual bool VCF::DefaultTreeItem::isExpanded (   )  [inline, virtual]
 

Implements VCF::TreeItem.

virtual bool VCF::DefaultTreeItem::isLeaf (   )  [virtual]
 

Implements VCF::TreeItem.

virtual bool VCF::DefaultTreeItem::isRoot (   )  [virtual]
 

Implements VCF::TreeItem.

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

Implements VCF::Item.

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

Implements VCF::Item.

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

Implements VCF::TreeItem.

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

Implements VCF::Item.

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

Implements VCF::TreeItem.

virtual void VCF::DefaultTreeItem::setControl (  Control *  control  )  [virtual]
 

Sets the owning control for this item.

It's made virtual so that subclasses can override the behaviour if they need to.

Reimplemented from VCF::Item.

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

Sets the application defined data.

Implements VCF::Item.

virtual void VCF::DefaultTreeItem::setExpandedImageIndex (  const int32 &  expandedImageIndex  )  [virtual]
 

Implements VCF::TreeItem.

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

Implements VCF::Item.

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

Implements VCF::Item.

virtual void VCF::DefaultTreeItem::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::DefaultTreeItem::setParent (  TreeItem *  parent  )  [virtual]
 

Implements VCF::TreeItem.

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

Implements VCF::Item.

virtual void VCF::DefaultTreeItem::setSelectedImageIndex (  const int32 &  selectedImageIndex  )  [virtual]
 

Implements VCF::TreeItem.

virtual void VCF::DefaultTreeItem::setStateImageIndex (  const int32 &  index  )  [virtual]
 

Implements VCF::Item.

virtual void VCF::DefaultTreeItem::setTextBold (  const bool &  bold  )  [virtual]
 

Implements VCF::TreeItem.

virtual void VCF::DefaultTreeItem::setTextColor (  Color *  color  )  [virtual]
 

Implements VCF::TreeItem.

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

Member Data Documentation

Rect VCF::DefaultTreeItem::bounds_ [protected]
 

String VCF::DefaultTreeItem::caption_ [protected]
 

std::vector<TreeItem*> VCF::DefaultTreeItem::childNodeItems_ [protected]
 

EnumeratorContainer<std::vector<TreeItem*>,TreeItem*> VCF::DefaultTreeItem::enumContainer_ [protected]
 

EnumeratorContainer<std::vector<SubItem*>,SubItem*> VCF::DefaultTreeItem::enumSubItemsContainer_ [protected]
 

int32 VCF::DefaultTreeItem::expandedImageIndex_ [protected]
 

int32 VCF::DefaultTreeItem::imageIndex_ [protected]
 

uint32 VCF::DefaultTreeItem::index_ [protected]
 

bool VCF::DefaultTreeItem::isExpanded_ [protected]
 

TreeItem* VCF::DefaultTreeItem::parent_ [protected]
 

bool VCF::DefaultTreeItem::selected_ [protected]
 

int32 VCF::DefaultTreeItem::selectedImageIndex_ [protected]
 

int32 VCF::DefaultTreeItem::stateImageIndex_ [protected]
 

std::vector<SubItem*> VCF::DefaultTreeItem::subItems_ [protected]
 

bool VCF::DefaultTreeItem::textBold_ [protected]
 

Color VCF::DefaultTreeItem::TextColor_ [protected]
 

void* VCF::DefaultTreeItem::userData_ [protected]
 

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information