effective-background-color

Arguments: object &key base-color scratch-rgb

Returns the color returned by background-color for object if that function returns a color (rather than t or nil).

The value will be an RGB color (as returned by make-rgb). See hls-to-rgb and rgb-to-hls.

If the scratch-rgb argument is specified, it should be a RGB object which will be modified to be the effective background color. This avoids consing a new RGB object.

The base-color argument is used internally and should not be specified by applications.

If background-color returns nil, effective-background-color returns the color returned by default-background-color for object. (As of 5.0, background-color returns nil when no background color has been explicitly assigned to an object.)

If background-color returns t for a control, indicating that the control's background color should be the same as its parent window's background color, then the effective-background-color of the parent window is returned.

Copyright (c) 1998-2008, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.1. The object described on this page has been modified in the 8.1 release; see the Release Notes.
Created 2007.4.30.