FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Unrevised from 8.2 to 9.0.
8.2 version

ask-user-for-color

Arguments: &key initial-color show-custom-colors disable-custom-colors stream

Displays a Common Dialog for color selection provided by the Windows Operating System. Returns the color selected, or initial-color if no color is selected. If the user cancels the interaction (by pressing the cancel button on the dialog), nil is returned. initial-color should be a rgb-color (such as created by make-rgb and returned by this function).

If show-custom-colors is specified true, the extra section of the dialog that allows users to define custom colors in addition to the standard set is displayed initially. If nil, the extra section is displayed only if the user clicks the button whose appearance is controlled by the next argument.

If disable-custom-colors is specified true, the button that brings up the extra section of the dialog, which shows custom colors, is masked.

The stream specifies the owning window for the color dialog. This window and all of its owned windows will be unavailable to the end user while the color dialog is present. stream defaults to the stream returned by selected-window-or-screen. It is also valid to specify (screen *system*) (see screen), which means that the dialog will not have an owner window and therefore will not disable any windows. Note that it may be inadvisable for this particular Common Dialog not to have an owner: if the end user exits the dialog by pressing the escape key or the enter key rather than by clicking one of the dialog's buttons, the system may hang.


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

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Unrevised from 8.2 to 9.0.
8.2 version