foreground-color

Arguments: standard-object &optional result-rgb

Returns the foreground color for standard-object. The foreground-color is the color in which graphics will be drawn and text will be written on the argument object. See with-foreground-color, a macro which will temporarily change the foreground color while code is executed for an easy way to draw or write in a different color.

The value will be stored in result-rgb (which must be a rgb color object, see make-rgb) if that value is specified. The value nil can be specified. It means use the default-foreground-color. See also effective-foreground-color, which returns the actual color used for the foreground-color (i.e. what foreground-color returns if it returns a color object, the actual color if foreground-color returns nil).

If the value is a color, it must be an RGB color (as returned by make-rgb). Note that the value cannot be an HLS color (as returned by make-hls). If you use HLS colors, apply hls-to-rgb to them before setting this property, and apply rgb-to-hls to get the HLS equivalent of a RGB value.

Note: incompatible change in release 6.0: in releases prior to 6.0, when a frame-with-single-child instance was passed to this operator, the operator was actually applied to the child (the result of applying frame-child to the frame-with-single-child instance). In release 6.0, this redirection no longer occurs. If you intend this operator to apply to the frame-child, pass that to this operator rather than the parent. This is a non-backward-compatible-change. See the release notes for more information.

Copyright (c) 1998-2001, Franz Inc. Berkeley, CA., USA. All rights reserved.
Documentation for Allegro CL version 6.1 update # 1. This page was not revised.
Created 2001.12.15.