diff options
| author | engelsman <engelsman> | 2010-10-29 22:14:59 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2010-10-29 22:14:59 +0000 |
| commit | efd349ddceb8fa8e216bb2e9fb12dfc7dbb6637d (patch) | |
| tree | da5d9cb287397a3b6496b3d5d91d766a3ce0daa2 /FL | |
| parent | 9a84309f51cf3f785489b7e48e3d28f0c33a2d59 (diff) | |
updated documentation for color handling - see STR #2226
- added text about color(0xRRGGBBII) call to common.dox and drawing.dox
- added doxygen comments for fl_show_chooser(), including image.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7770 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
| -rw-r--r-- | FL/fl_show_colormap.H | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/FL/fl_show_colormap.H b/FL/fl_show_colormap.H index 29acf5eab..12159e50b 100644 --- a/FL/fl_show_colormap.H +++ b/FL/fl_show_colormap.H @@ -25,9 +25,25 @@ // http://www.fltk.org/str.php // +/** \file + The fl_show_colormap() function hides the implementation classes used + to provide the popup window and color selection mechanism. +*/ + #ifndef fl_show_colormap_H #define fl_show_colormap_H +/* doxygen comment here to avoid exposing ColorMenu in fl_show_colormap.cxx +*/ +/** + \brief Pops up a window to let the user pick an colormap entry. + \image html fl_show_colormap.gif + \image latex fl_show_colormap.eps "fl_show_colormap" width=8cm + \param[in] oldcol color to be highlighted when grid is shown. + \retval Fl_Color value of the chosen colormap entry. + \sa Fl_Color_Chooser +*/ + FL_EXPORT Fl_Color fl_show_colormap(Fl_Color oldcol); #endif |