FL/fl_show_colormap.H

   1 //
   2 // "$Id: fl_show_colormap.H 8621 2011-04-23 15:46:30Z AlbrechtS $"
   3 //
   4 // Colormap picker header file for the Fast Light Tool Kit (FLTK).
   5 //
   6 // Copyright 1998-2010 by Bill Spitzak and others.
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Library General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // Library General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Library General Public
  19 // License along with this library; if not, write to the Free Software
  20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 // USA.
  22 //
  23 // Please report all bugs and problems on the following page:
  24 //
  25 //     http://www.fltk.org/str.php
  26 //
  27
  28 /** \file
  29    The fl_show_colormap() function hides the implementation classes used
  30    to provide the popup window and color selection mechanism.
  31 */
  32
  33 #ifndef fl_show_colormap_H
  34 #define fl_show_colormap_H
  35
  36 /* doxygen comment here to avoid exposing ColorMenu in fl_show_colormap.cxx
  37 */
  38
  39 /** \addtogroup  fl_attributes
  40     @{ */
  41
  42 /**
  43   \brief Pops up a window to let the user pick a colormap entry.
  44   \image html fl_show_colormap.png
  45   \image latex fl_show_colormap.png "fl_show_colormap" height=10cm
  46   \param[in] oldcol color to be highlighted when grid is shown.
  47   \retval Fl_Color value of the chosen colormap entry.
  48   \see Fl_Color_Chooser
  49 */
  50 FL_EXPORT Fl_Color fl_show_colormap(Fl_Color oldcol);
  51
  52 /** @} */
  53
  54 #endif
  55
  56 //
  57 // End of "$Id: fl_show_colormap.H 8621 2011-04-23 15:46:30Z AlbrechtS $".
  58 //