palette.h

Go to the documentation of this file.

#ifndef PALETTE_CLASS
#define PALETTE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : palette                                                           *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Provides methods for adding colors and manipulating the color map.       *
*                                                                             *
*******************************************************************************
* 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 "color.h"
#include "definitions_passive.h"
#include "nub.h"

class WP_PASSIVE_CLASS_STYLE palette
{
public:
  palette(window_handle parent, int gray_colors = 0);
    // constructs a colormap for the windowing system object "parent".  if the
    // number of "gray_colors" is greater than 0 (and less than a system
    // defined maximum), then the colormap is given that many gray scale values
    // to start.

  virtual ~palette();

  IMPLEMENT_CLASS_NAME("palette");

  bool add(color &to_add);
    // Allocates a colormap entry for "to_add".  If it could be added to the
    // colormap, then true is returned.  Otherwise, false is returned and the
    // "to_add" is set to a close match to the original request.

  void install_gray_colormap(int number_of_colors);
    // adds "number_of_colors" grayscaled colors to the colormap.  this method
    // can currently only be invoked once per palette, and the possible
    // invocation by the constructor (if "gray_colors" is greater than zero)
    // counts as an invocation.

  void make_map(Pixel *map);
    // installs a gray color map and stuffs it in "map".  Note that "map"
    // must be as large as the "size_of_colormap()".  If the graymap is not
    // installed yet, then this does nothing.

  window_color translate(color &to_add_or_find);
    // this returns the type of color used by the underlying window system
    // and can be used for direct interaction with that system.

  color lookup(const char *color_name);
  color lookup(const istring &color_name);
    // searches for a color with the name specified and returns it if found.
    // if it is found, it is added to the colormap so that it can be used.
    // if it is not found, BLACK is returned.

  int size_of_colormap() const;
    // returns the number of colors the display can show simultaneously.

  void apply(window_handle to_apply_to);
    // Uses the colormap here as the colormap for the window specified.

private:
  window_colormap _colormap;
  nub _parent;
  Pixel *graymap;  // list of grayscales to be stored in the colormap.
  int number_in_graymap;
  int maximum_colors_on_screen;

  window_color add(color &to_add, bool &success);
};

#endif

---