Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiLoadIconData

hiLoadIconData(
t_fileName
[ t_formatName ]
)
=> l_hiIcon / nil

Description

Loads a pixmap and returns it in a format that can be used with any hi function that accepts icons, such as hiCreateMenuItem or hiCreateButton. This function can load files that are in any of the image formats supported by Qt; currently these are: BMP, JPG, PNG, PPM, XBM, and XPM. PNG is the recommended format.

Arguments

t_fileName

The pixmap file, in one of the following formats:  BMP, JPG, PNG, PPM, XBM, and XPM.

t_formatName

The image format name.

The default value of this argument is "PNG".

Values Returned

l_hiIcon

The icon handle, which can be used with any user interface function that accepts icons. l_hiIcon is of the following form:

list(handle width height)

nil

There was an error in loading t_fileName.

Examples

zoomPixmap = hiLoadIconData( "zoom.png" "png" )
hiCreateMenuItem ( ?name ’zoom ?itemIcon zoomPixmap )

Related Topics

Icon Functions

hiLoadIconFile

hiLoadImageFile

hiLoadIconData

hiSaveIconData

hiStringToIcon

hiMatchColorByName


Return to top
 ⠀
X