Section: User Contributed Perl Documentation (3)Updated: 2009-02-24Local indexUp
Prima::StdBitmap - shared access to the standard toolkit bitmaps
The toolkit contains sysimage.gif image library, which consists of
a predefined set of images, used in several toolkit modules. To provide
a unified access to the images this module can be used. The images are
assigned a "sbmp::" constant, which is used as an index on a load
request. If loaded successfully, images are cached and the successive
requests return the cached values.
The images can be loaded as "Prima::Image" and "Prima::Icon" instances.
To discriminate, two methods are used, correspondingly "image" and "icon".
my $logo = Prima::StdBitmap::icon( sbmp::Logo );
Loads INDEXth image frame and returns "Prima::Icon" instance.
Loads INDEXth image frame and returns "Prima::Image" instance.
Loads INDEXth image frame from IMAGE_FILE and returns it as either a "Prima::Image" or
as a "Prima::Icon" instance, depending on value of boolean AS_ICON flag. If
USE_CACHED_VALUE boolean flag is set, the cached images loaded previously
can be used. If this flag is unset, the cached value is never used, and the
created image is not stored in the cache. Since the module's intended use
is to provide shared and read-only access to the image library, USE_CACHED_VALUE
set to 0 can be used to return non-shared images.
An index value passed to the methods must be one of "sbmp::" constants:
$sysimage scalar is initialized to the file name to be used
as a source of standard image frames by default. It is possible
to alter this scalar at run-time, which causes all subsequent
image frame request to be redirected to the new file.