VCF::ImageList Class Reference
An image list is a collection of images.
More...
#include <vcf/ApplicationKit/ImageList.h>
Inheritance diagram for VCF::ImageList:
List of all members.
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:
- ImageList::SizeChanged
- ImageList::ImageAdded
- ImageList::ImageDeleted
Constructor & Destructor Documentation
| VCF::ImageList::ImageList |
( |
|
) |
|
|
| VCF::ImageList::ImageList |
( |
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 |
) |
|
|
|
|
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 |
| 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. |
| ImageDeleted 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 |
( |
|
) |
|
|
| virtual void VCF::ImageList::handleEvent |
( |
Event * |
event |
) |
[virtual] |
|
|
|
generic handler method for events.
All UI events are sent here and then dispatched accordingly to a more specific event handler. If an Application class is present, then it is given a chance to "see" the event first before delegating it to the Component.
All events are dispatched by their type so it is important to correctly identify the event objects type if you would like it to be dispatched correctly. The method will call the appropriate component method, like afterCreate(), beforeDestroy(), etc. - Parameters:
-
Reimplemented from VCF::Component. |
| void VCF::ImageList::init |
( |
|
) |
|
|
| 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
|
|
- 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
|
The documentation for this class was generated from the following file: