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

VCF::DefaultTabPage Class Reference

#include <vcf/ApplicationKit/DefaultTabPage.h>

Inheritance diagram for VCF::DefaultTabPage:

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

Public Member Functions

 DefaultTabPage (Control *component=NULL)
virtual ~DefaultTabPage ()
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 setPageName (const String &name)
virtual String getPageName ()
virtual ControlgetPageComponent ()
virtual void setPageComponent (Control *component)
virtual bool isSelected ()
virtual void setSelected (const bool &selected)
virtual void paint (GraphicsContext *context, Rect *paintRect)
virtual uint32 getPreferredHeight ()
virtual RectgetBounds ()
 returns the Bounds for the Item or NULL if not applicable.
virtual ControlgetControl ()
 All items may have a control that "owns" them.
virtual void setControl (Control *control)
 Sets the owning control for this item.
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 setStateImageIndex (const int32 &index)
 not supported

Constructor & Destructor Documentation

VCF::DefaultTabPage::DefaultTabPage Control component = NULL  ) 
 

virtual VCF::DefaultTabPage::~DefaultTabPage  )  [virtual]
 


Member Function Documentation

virtual bool VCF::DefaultTabPage::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::DefaultTabPage::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::DefaultTabPage::getBounds  )  [inline, virtual]
 

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

Implements VCF::Item.

virtual Control* VCF::DefaultTabPage::getControl  )  [inline, virtual]
 

All items may have a control that "owns" them.

so in a ListControl, the ListItem::getControl() would return the ListControl the items were part of. The control for item must match with the view control of the item's model.

Reimplemented from VCF::Item.

virtual void* VCF::DefaultTabPage::getData  )  [virtual]
 

Returns some application defined data.

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

Implements VCF::Item.

virtual int32 VCF::DefaultTabPage::getImageIndex  )  [inline, virtual]
 

Implements VCF::Item.

virtual uint32 VCF::DefaultTabPage::getIndex  )  [virtual]
 

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

Implements VCF::Item.

virtual Control* VCF::DefaultTabPage::getPageComponent  )  [virtual]
 

Implements VCF::TabPage.

virtual String VCF::DefaultTabPage::getPageName  )  [virtual]
 

Implements VCF::TabPage.

virtual uint32 VCF::DefaultTabPage::getPreferredHeight  )  [virtual]
 

Implements VCF::TabPage.

virtual int32 VCF::DefaultTabPage::getStateImageIndex  )  [inline, virtual]
 

not supported

Implements VCF::Item.

virtual bool VCF::DefaultTabPage::isSelected  )  [virtual]
 

Implements VCF::Item.

virtual void VCF::DefaultTabPage::paint GraphicsContext context,
Rect paintRect
[virtual]
 

Implements VCF::Item.

virtual void VCF::DefaultTabPage::setBounds Rect bounds  )  [virtual]
 

Implements VCF::Item.

virtual void VCF::DefaultTabPage::setControl Control control  )  [inline, 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::DefaultTabPage::setData void *  data  )  [virtual]
 

Sets the application defined data.

Implements VCF::Item.

virtual void VCF::DefaultTabPage::setImageIndex const int32 imageIndex  )  [virtual]
 

Implements VCF::Item.

virtual void VCF::DefaultTabPage::setIndex const uint32 index  )  [virtual]
 

Implements VCF::Item.

virtual void VCF::DefaultTabPage::setPageComponent Control component  )  [virtual]
 

Implements VCF::TabPage.

virtual void VCF::DefaultTabPage::setPageName const String name  )  [virtual]
 

Implements VCF::TabPage.

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

Implements VCF::Item.

virtual void VCF::DefaultTabPage::setStateImageIndex const int32 index  )  [inline, virtual]
 

not supported

Implements VCF::Item.


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