background-color

Arguments: standard-object &optional result-rgb

Returns the background color for standard-object. See also background-texture. The value will be stored in result-rgb (which must be a rgb color object) if that value is specified. The background-color is the color of the portions of the interior of a window where there is no text or graphics (which are drawn in the foreground-color).

The value can be an RGB color (as returned by make-rgb), or nil, which means use the default-background-color. See also effective-background-color. For controls, the value can also be t, which means use the background color of the parent. 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 background-color, and apply rgb-to-hls to get the HLS equivalent of a background-color value (which is an actual color rather than nil or t).

You can change the background color of a window with setf and this function. The change takes effect when the window is redrawn for any reason (so, e.g., iconifying and deiconifying the window will effect the change), though calling clear-page is the usual way to show the new background color.

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.