Generic FunctionPackage: ideToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Unrevised from 8.0 to 8.1.
8.0 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.

The icon file must contain either a single 32 by 32 icon, or else two icons (and no more), one 32 by 32 and the other 16 by 16 (in either order). The icon(s) must have a depth of 4 bits (16 colors). Allegro CL does not provide any tools for creating icon files, though a variety of third-party tools do.

If the file contains a single large icon, then the smaller icon is derived from it automatically (and generally does not look as nice as a separately designed small icon). The larger icon is used in some places such as the alt-tab window, and the smaller icon in other places such as window title-bars.

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-2009, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.1. This page was not revised from the 8.0 page.
Created 2009.7.29.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Unrevised from 8.0 to 8.1.
8.0 version