Generic FunctionPackage: ideToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.2
Unrevised from 8.1 to 8.2. Moderate update since 8.2 release.
8.1 version

icon-file

Arguments: project

Returns the file (as a pathname or path namestring) containing the application icon for a project.

When a standalone application is generated from the project with the File | Build Project Distribution or File | Build Project Exe command, the icon from the file will be displayed in various places when the standalone application is run (but not when the project is run in the IDE). These places include:

The value may also be nil, in which case the Franz bust icon (as seen in the IDE) will be used. Otherwise, the value should be the pathname or path namestring of a .ico icon file.

An icon file on Windows may contain multiple images, which typically are the same logical image at different sizes. Generally it is best if the file contains at least one 32 by 32 image for use in places like the alt-tab window, and at least one 16 by 16 image for use in places like window title bars, the taskbar, and the file manager. If the file contains only a large icon, then a smaller icon is derived from it automatically, but it typically does not look as nice as a separately designed small icon.

You may find that some icon files but not others will work as application icons, depending on the version of the underlying operating system. In particular, most icons that have a depth of 4 (that is, using 4 bits per pixel) that worked on Windows XP appear not to work on Windows Vista; you may need to use an icon with a depth of 8 instead.

Allegro CL does not provide any tools for creating icon files.

The setf of this function may be used to specify a new icon file for a project programmatically, though this is typically done interactively on the Build tab of the Project Manager dialog instead.

See cg-icons.htm.

GTK Note

icon-file is not implemented on the GTK platform at this time. Specifying this property currently will have no effect.


Copyright (c) 1998-2015, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.2. This page was not revised from the 8.1 page.
Created 2010.1.21.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.2
Unrevised from 8.1 to 8.2. Moderate update since 8.2 release.
8.1 version