Carbon


SetWinColor

Header: MacWindows.h Carbon status: Supported

Sets a window color table.

void SetWinColor (
    WindowRef window, 
    WCTabHandle newColorTable
);
window

On input, a pointer to the window structure.

newColorTable

On input, a handle to a window color table structure, which defines the colors for the window’s new color table.

DISCUSSION

The SetWinColor function sets a window’s color table. If the window has no auxiliary window structure, it creates a new one with the specified window color table and adds it to the auxiliary window list. If the window already has an auxiliary structure, its window color table is replaced. The Window Manager then redraws the window frame and highlighted text in the new colors and sets the window’s background color to the new content color.

If the new color table has the same entries as the default color table, SetWinColor changes the auxiliary window structure so that it points to the default color table.

Window color table resources (resources of type 'wctb') should not be purgeable.

If you specify a value of NULL for the parameter theWindow, SetWinColor changes the default color table in memory. Your application shouldn’t, however, change the default color table.

When the Appearance Manager is available and your application uses standard windows, the SetWinColor function is not recommended. SetWinColor sets a window color table structure that is now mostly ignored. Only the part identifier constant wContentColor in the value field of the ColorSpec structure is used. This constant produces the background color for the window’s content region. Under Appearance, instead of the SetWinColor function, the window definition function determines what colors it will use.

If your are creating your own custom window definition functions, SetWinColor can still be used.

VERSION NOTES

This function is not recommended with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Not available in CarbonLib, but available when InterfaceLib 7.1 or later is installed. Exported by InterfaceLib 7.1 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)