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.
sbmp::
The images can be loaded as Prima::Image and Prima::Icon instances. To discriminate, two methods are used, correspondingly image and icon.
Prima::Image
Prima::Icon
image
icon
use Prima::StdBitmap; 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 file and returns it as either a Prima::Image or as a Prima::Icon instance, depending on value of boolean icon flag. If copy boolean flag is unset, the cached images loaded previously can be used. If this flag is set, 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, copy set to 1 can be used to return non-shared images.
index
file
copy
The loader automatically scales images if system dpi suggests so. If layering is supported, the icon scaling will use that. To disable these optimizations use raw => 1 (to disable all) construct, or argb => 0 ( to disable ARGB icons ).
raw => 1
argb => 0
An index value passed to the methods must be one of sbmp:: constants:
sbmp::Logo sbmp::CheckBoxChecked sbmp::CheckBoxCheckedPressed sbmp::CheckBoxUnchecked sbmp::CheckBoxUncheckedPressed sbmp::RadioChecked sbmp::RadioCheckedPressed sbmp::RadioUnchecked sbmp::RadioUncheckedPressed sbmp::Warning sbmp::Information sbmp::Question sbmp::OutlineCollapse sbmp::OutlineExpand sbmp::Error sbmp::SysMenu sbmp::SysMenuPressed sbmp::Max sbmp::MaxPressed sbmp::Min sbmp::MinPressed sbmp::Restore sbmp::RestorePressed sbmp::Close sbmp::ClosePressed sbmp::Hide sbmp::HidePressed sbmp::DriveUnknown sbmp::DriveFloppy sbmp::DriveHDD sbmp::DriveNetwork sbmp::DriveCDROM sbmp::DriveMemory sbmp::GlyphOK sbmp::GlyphCancel sbmp::SFolderOpened sbmp::SFolderClosed sbmp::Last
$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.
$sysimage
Note: the module scales the images automatically with the resolution. Therefore it is advisable to use the module's function after Application object is loaded.
Dmitry Karasik, <dmitry@karasik.eu.org>.
Prima, Prima::Image, Prima::Const.
To install Prima, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Prima
CPAN shell
perl -MCPAN -e shell install Prima
For more information on module installation, please visit the detailed CPAN module installation guide.