Function

Summary

Loads a Windows icon image, and returns the image object.

Package

graphics-ports

Signature

load-icon-image port id &key width height => image

Arguments

port

A graphics port or CAPI object.

id

A keyword, string or pathname.

width

The desired width in pixels, or nil .

height

The desired height in pixels, or nil .

Values

image

An image object.

Description

The load-icon-image function loads an icon specified by id which should be either a keyword describing a standard icon, or a string or a pathname naming a Windows format icon ( .ico ) file. In this case, the first icon in the file is loaded.

The following keyword values of id are recognized:

:sample

A rectangle

:hand

A cross in a circle

:ques

A question mark in a bubble

:bang

An exclamation mark in a triangle

:note

An 'I' in a bubble

:winlogo

The Windows logo

:warning

Same as :bang

:error

Same as :hand

:information

Same as :note

load-icon-image returns an image object which can be drawn to port using draw-image and which must be freed using free-image when no longer needed.

If width and height are specified, then the image is scaled accordingly. If width and height are nil then the dimensions are taken from the icon file. width defaults to nil and height defaults to width .

Note: load-icon-image is defined only in LispWorks for Windows.

See also

draw-image
free-image
load-image