color.h

Go to the documentation of this file.

#ifndef COLOR_CLASS
#define COLOR_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : color                                                             *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Represents the attribute of color for a windowing sytem.                 *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "dll_wp_passive.h"

class WP_PASSIVE_CLASS_STYLE color
{
public:
  color(int red = 0, int green = 0, int blue = 0);
  ~color();

  int red() const;
  int green() const;
  int blue() const;

  void red(int red);
  void green(int green);
  void blue(int blue);
    // observes or modifies the components of the color.  because modifying
    // a color changes its screen interpretation, the rgb modifiers also
    // invalidate the color's palette index; the color must be added to the
    // palette again to be revalidated.

  bool operator == (const color &to_compare) const;
  bool operator != (const color &to_compare) const;

  int index() const;
    // returns the index of this color in the system color table.  this is
    // not accurate until the color has been added to the color table; the
    // default index is a negative number.

  void index(int new_index);
    // sets the index for this color in the color map.

  istring text_form() const;

private:
  int _red, _green, _blue;
  int _index;
};

#endif

---