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

VCF::ImageControl Class Reference

Class ImageControl documentation. More...

#include <vcf/ApplicationKit/ImageControl.h>

Inheritance diagram for VCF::ImageControl:

VCF::CustomControl VCF::Control VCF::Component VCF::AbstractView VCF::ObjectWithEvents VCF::View VCF::Object List of all members.

Public Member Functions

 ImageControl ()
virtual ~ImageControl ()
ImagegetImage ()
void setImage (Image *image)
bool getTransparent ()
void setTransparent (const bool &transparent)
 sets whether or not the controls paints a background and covers it's parent
ImageFilenameString getFilename ()
void setFilename (const ImageFilenameString &filename)
virtual void paint (GraphicsContext *context)
 Paints the control.
void setAutoDelete (const bool &autoDelete)
bool getAutoDelete ()

Detailed Description

Class ImageControl documentation.


Constructor & Destructor Documentation

VCF::ImageControl::ImageControl  ) 
 

virtual VCF::ImageControl::~ImageControl  )  [virtual]
 


Member Function Documentation

bool VCF::ImageControl::getAutoDelete  )  [inline]
 

ImageFilenameString VCF::ImageControl::getFilename  ) 
 

Image* VCF::ImageControl::getImage  ) 
 

bool VCF::ImageControl::getTransparent  ) 
 

virtual void VCF::ImageControl::paint GraphicsContext context  )  [virtual]
 

Paints the control.

Called by the underlying windowing system whenever the control needs to be painted. Note that in some cases the GraphicsContext passed in to this method may not be the same pointer as the GraphicsContext that the control holds itself. During the paint() method you should only use the context value for all your drawing and not the one returned in getContext(). The value returned by getContext() should be used for drawing that takes place outside of the paint() method.

If the control allows paint notification, then the framework will fire an event to the BeforeControlPainted delegate prior to calling the control's paint() method. After the paint() method has returned, if the control allows paint notification, the framework will fire an event to the AfterControlPainted delegate. This allows outside observers to take part in the paint cycle, but beware that this does come at a bit of a cost, so use this feature sparingly.

Note: This should NEVER be called by programmers using the VCF, it will be called for you during the course of your applications native event loop, and is only here for providing custom drawing routines for controls. In other words: you implement it, you never call it yourself.

See also:
getAllowPaintNotification

Reimplemented from VCF::CustomControl.

void VCF::ImageControl::setAutoDelete const bool &  autoDelete  )  [inline]
 

void VCF::ImageControl::setFilename const ImageFilenameString filename  ) 
 

void VCF::ImageControl::setImage Image image  ) 
 

void VCF::ImageControl::setTransparent const bool &  transparent  ) 
 

sets whether or not the controls paints a background and covers it's parent

Reimplemented from VCF::CustomControl.


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