Curses::UI::Color

Curses::UI::Color(3) User Contributed Perl Documentation Curses::UI::Color(3)



NAME
       Curses::UI::Color - Color support module

WARNING
       This is a development version. As I do not expect to change the inter-
       face during this time it may happen that the color behaviour (e.g. to
       what extend color is drawn in a window) may change or even the colors
       themselves. If you want something stable, use -color_support => 0 ,
       but you won’t get those fency colors then :-)

DESCRIPTION
       This module provides all functions related to color support in
       Curses::UI. The color support was implemented without disturbing old
       applications, they will look as they used to do. Only if you enable
       color support explicitly and it is available on your terminal the
       color functions will have an effect.

SYNOPSIS
       my $cui = new Curses::UI(-color_support => 1,
				-clear_on_exit => 0);

       my $mainw = $cui->add(’screen’, ’Window’);

       $mainw->add(’l’,’Label’, -bg => "white",
				-fg => "blue",
				-text => "Colored Label");

METHODS
       * new (-default-colors => BOOLEAN)
	   Creates a new Curses::UI::Color object, the option default colors
	   define if the use_default_colors function of Curses is used. See
	   Curses for that.

       * get_colors ( )
	   Returns all in this object defined colors as an array

       * colors ( )
	   Is true if color support is enabled.

       * define_color ( NAME, R, G, B )
	   This function defines a new color in the Color object. The RGB
	   values can be between 0 and 1000. Existing colors can be rede-
	   fined.

USAGE
       Curses::UI has 7 predefined colors:
		black
		red
		green
		yellow
		blue
		magenta
		cyan
		white

       Curses::UI with color support also defines some new options:

	    -fg	 -bg for general foreground and background color.
	   -tfg -tbg for widget title fg and bg color
	   -bfg -bbg for widget border fg and bg color
	   -sfg -sbg for scrollbar fg and bg color

       Every widget has has a runtime setter:
	   set_color_fg ( COLOR )
	   set_colof_bg ( COLOR )
	   set_color_tfg ( COLOR )
	   set_colof_tbg ( COLOR )
	   set_color_bfg ( COLOR )
	   set_colof_bbg ( COLOR )
	   set_color_sfg ( COLOR )
	   set_colof_sbg ( COLOR )

       Mostly every widget has a -fg and -bg option to set the foreground and
       background color using the above color names. Own colors can be
       defined using the define_color method. Every widget that supports
       color by now has also two functions set_color_fg and set_color_bg to
       set or change the color at runtime.  Widgets with borders and scroll-
       bars can use -bfg and -bbg to set the foreground and background color
       of the border or the -sfg and -sbg option to set the colors of the
       scrollbar.  Widgets with titles can set the -tfg and -tbg option to
       define the title foreground and background color.

       Check also the examples/color_editor for seeing what is possible at
       the moment.

SEE ALSO
       Curses::UI

AUTHOR
       Copyright (c) 2003 Marcus Thiesen. All rights reserved.

       Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)

       This package is free software and is provided "as is" without express
       or implied warranty. It may be used, redistributed and/or modified
       under the same terms as perl itself.



perl v5.8.8			  2008-12-21		 Curses::UI::Color(3)