Linux Certif

Toute la documentation sur la certification Linux LPI

Prima::StdBitmap

NAME

Prima::StdBitmap - shared access to the standard toolkit bitmaps

DESCRIPTION

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".

SYNOPSIS

         use Prima::StdBitmap;
         my $logo = Prima::StdBitmap::icon( sbmp::Logo );
 
 

API

Methods

icon INDEX

Loads INDEXth image frame and returns "Prima::Icon" instance.

image INDEX

Loads INDEXth image frame and returns "Prima::Image" instance.

load_std_bmp INDEX, AS_ICON, USE_CACHED_VALUE, IMAGE_FILE

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.

Constants

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::OutlineCollaps
         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
 
 

Scalars

$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.

AUTHOR

Dmitry Karasik, <dmitry@karasik.eu.org>.

SEE ALSO

Prima, Prima::Image, Prima::Const.