ComponentBuilder::ImageProvider Class Referenceabstract

This class is used when references to images need to be stored in ValueTrees. More...

Public Member Functions

 ImageProvider ()
 
virtual ~ImageProvider ()
 
virtual Image getImageForIdentifier (const var &imageIdentifier)=0
 Retrieves the image associated with this identifier, which could be any kind of string, number, filename, etc. More...
 
virtual var getIdentifierForImage (const Image &image)=0
 Returns an identifier to be used to refer to a given image. More...
 

Detailed Description

This class is used when references to images need to be stored in ValueTrees.

An instance of an ImageProvider provides a mechanism for converting an Image to/from a reference, which may be a file, URL, ID string, or whatever system is appropriate in your app.

When you're loading components from a ValueTree that may need a way of loading images, you should call ComponentBuilder::setImageProvider() to supply a suitable provider before trying to load the component.

See also
ComponentBuilder::setImageProvider()

Constructor & Destructor Documentation

◆ ImageProvider()

ComponentBuilder::ImageProvider::ImageProvider ( )

◆ ~ImageProvider()

virtual ComponentBuilder::ImageProvider::~ImageProvider ( )
virtual

Member Function Documentation

◆ getImageForIdentifier()

virtual Image ComponentBuilder::ImageProvider::getImageForIdentifier ( const var imageIdentifier)
pure virtual

Retrieves the image associated with this identifier, which could be any kind of string, number, filename, etc.

The image that is returned will be owned by the caller, but it may come from the ImageCache.

◆ getIdentifierForImage()

virtual var ComponentBuilder::ImageProvider::getIdentifierForImage ( const Image image)
pure virtual

Returns an identifier to be used to refer to a given image.

This is used when a reference to an image is stored in a ValueTree.


The documentation for this class was generated from the following file: