geLoadIcon

geLoadIcon( 
[ t_iconName ] 
[ t_fileName ] 
[ x_width ] 
[ x_height ] 
[ x_bgColor ] 
)
=> t / nil

Description

Creates an icon from a SKILL file.

This function loads SKILL code in t_fileName and takes the resulting Dlist, which must have the name t_iconName, and creates an icon with dimensions x_width and x_height, and using pixel value x_bgColor for the background. If any of the arguments are defaulted, a form is displayed prompting you to enter those values. The background color of the icon depends on which color, if any, is mapped to pixel value x_bgColor in the current technology file. The newly created icon is assigned to the symbol t_iconName. This icon can be used in any user interface function that takes an icon as an argument.

Arguments

t_iconName	Name given to the icon.
t_fileName	File in which the icon data is to be found.
x_width	Pixel width of the new icon.
x_height	Pixel height of the new icon.
x_bgColor	Background pixel value of the new icon.

Value Returned

t	The icon was successfully loaded.
nil	The icon was not loaded successfully.

Examples

Loads icon data from the file myIconFile, creates an icon named myIcon which is 40 pixels square and has pixel value 2 as its background color.

geLoadIcon( "myIcon" "myIconFile" 40 40 2 )

Related Topics

Icon Creation and Loading Functions

geCellViewToDlist

geSaveIcon

Return to top