Term::Stool::CoUser3Contributed Perl DocumenTerm::Stool::Color(r)



NAME
       Term::Stool::Color - Represents the color of a stool wid-
       get.

DESCRIPTION
       First, my apologies for the awkward name of this class.
       When I called this project Stool, I just didn't realize
       what was guarenteed to happen...

       This class represents a foreground/background color pair.
       Instantiated objects are typically bound to widgets to set
       the color of those widgets.  This all ties in with S-
       Lang's own color handling.

FIELDS
       foreground
           The name of the foreground color.

       background
           The name of the background color.

       mono
           The type of mask to use on a monochrome display. For
           example, Term::Slang::REV_MASK is reverse video.

       tag The tag associated with this color pair. Typically,
           this is the name of the type of object that uses the
           color.

       id  The S-Lang id for this color pair.

METHODS
       new Create a new object. Pass in the foreground, back-
           ground, and tag fields as named parameters.

           Note that color ids start at 1. S-Lang reserves color
           id 0 for the screen background color. To set this spe-
           cial color, use "desktop" as the tag name.

           Note that if you call new repeatedly with the same
           tag, you get the same object back each time.  TODO:
           And the object's colors are not changed, which should
           be fixed..

       set Call this method to actually set the current S-Lang
           color.

AUTHOR
       Joey Hess <joey@kitenet.net>



2001-05-23                 perl v5.6.1      Term::Stool::Color(r)