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

VCF::ImageList Class Reference

An image list is a collection of images. More...

#include <vcf/ApplicationKit/ImageList.h>

Inheritance diagram for VCF::ImageList:

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

Public Member Functions

 ImageList ()
 ImageList (Component *owner)
 ImageList (const String &name, Component *owner)
 ImageList (const String &name)
virtual ~ImageList ()
 Creates a new imagelist from a Image and the appropriate width and height.
void init ()
 This is going to be removed from the bext release.
uint32 getImageWidth ()
 returns the width of each image in the list, NOT the width of the list itself.
uint32 getImageHeight ()
 returns the height of an image in the list.
void setImageWidth (const uint32 &width)
void setImageHeight (const uint32 &height)
void setTransparentColor (Color *color)
ColorgetTransparentColor ()
void addImage (Image *newImage)
void insertImage (const uint32 &index, Image *newImage)
void deleteImage (const uint32 &index)
virtual void draw (GraphicsContext *context, const uint32 &index, Point *pt)
virtual void draw (GraphicsContext *context, const uint32 &index, Rect *bounds)
 Draws the image within the bounds specified in bounds.
void copyImage (Image *imageToCopyTo, const uint32 &index)
void setResizeIncrement (const uint32 &resizeIncrement)
virtual void afterCreate (ComponentEvent *event)
 after the component has been created/instantiated the afterCreate() method is called.
uint32 getImageCount ()
ImagegetMasterImage ()

Public Attributes

VCF::Delegate SizeChanged
VCF::Delegate ImageAdded
VCF::Delegate ImageDeleted

Detailed Description

An image list is a collection of images.

The image list is used by controls like the TreeControl, ListViewControl, and others. The collection of images is implemented by storing them on one single image.

Event Delegates for this class:


Constructor & Destructor Documentation

VCF::ImageList::ImageList  ) 
 

VCF::ImageList::ImageList Component owner  ) 
 

VCF::ImageList::ImageList const String name,
Component owner
 

VCF::ImageList::ImageList const String name  ) 
 

virtual VCF::ImageList::~ImageList  )  [virtual]
 

Creates a new imagelist from a Image and the appropriate width and height.


Member Function Documentation

void VCF::ImageList::addImage Image newImage  ) 
 

virtual void VCF::ImageList::afterCreate ComponentEvent event  )  [virtual]
 

after the component has been created/instantiated the afterCreate() method is called.

Special initializations may then happen here.

Reimplemented from VCF::Component.

void VCF::ImageList::copyImage Image imageToCopyTo,
const uint32 index
 

void VCF::ImageList::deleteImage const uint32 index  ) 
 

virtual void VCF::ImageList::draw GraphicsContext context,
const uint32 index,
Rect bounds
[virtual]
 

Draws the image within the bounds specified in bounds.

Where the bounds->left_ and top_ represent the upper left and top coords. If the boudns width or height is less than the images, then clipping occurs

virtual void VCF::ImageList::draw GraphicsContext context,
const uint32 index,
Point pt
[virtual]
 

uint32 VCF::ImageList::getImageCount  )  [inline]
 

uint32 VCF::ImageList::getImageHeight  ) 
 

returns the height of an image in the list.

All images in the list will have the same width and height.

uint32 VCF::ImageList::getImageWidth  ) 
 

returns the width of each image in the list, NOT the width of the list itself.

All images in the list will have the same width and height.

Image* VCF::ImageList::getMasterImage  )  [inline]
 

Color* VCF::ImageList::getTransparentColor  ) 
 

void VCF::ImageList::init  ) 
 

This is going to be removed from the bext release.

Deprecated:

Reimplemented from VCF::Object.

void VCF::ImageList::insertImage const uint32 index,
Image newImage
 

void VCF::ImageList::setImageHeight const uint32 height  ) 
 

void VCF::ImageList::setImageWidth const uint32 width  ) 
 

void VCF::ImageList::setResizeIncrement const uint32 resizeIncrement  )  [inline]
 

void VCF::ImageList::setTransparentColor Color color  ) 
 


Member Data Documentation

VCF::Delegate VCF::ImageList::ImageAdded
 

Event Delegate:
ImageAdded this is fired when a new image is added.
event class: ImageListEvent
event type: IMAGELIST_EVENT_ITEM_ADDED
See also:
addImage

insertImage

VCF::Delegate VCF::ImageList::ImageDeleted
 

Event Delegate:
ImageDeleted this is fired after an image has been removed from the image list.
event class: ImageListEvent
event type: IMAGELIST_EVENT_ITEM_DELETED
See also:
deleteImage

VCF::Delegate VCF::ImageList::SizeChanged
 

Event Delegate:
SizeChanged is fired when the size of teh image list changes. This happens whenever the setImageWidth() or setImageHeight() methods are called.
event class: ImageListEvent
event type: IMAGELIST_EVENT_WIDTH_CHANGED
event type: IMAGELIST_EVENT_HEIGHT_CHANGED
See also:
setImageWidth

setImageHeight


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