color.h

   1 /* color.h
   2  * Definitions for "toolkit-independent" colors
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program 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
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #ifndef __COLOR_H__
  24 #define __COLOR_H__
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif /* __cplusplus */
  29
  30 /*
  31  * Data structure holding RGB value for a color.
  32  *
  33  * XXX - yes, I know, there's a "pixel" value in there as well; for
  34  * now, it's intended to look just like a GdkColor but not to require
  35  * that any GTK+ header files be included in order to use it.
  36  * The way we handle colors needs to be cleaned up somewhat, in order
  37  * to keep toolkit-specific stuff separate from toolkit-independent stuff.
  38  */
  39 typedef struct {
  40         guint32 pixel;
  41         guint16 red;
  42         guint16 green;
  43         guint16 blue;
  44 } color_t;
  45
  46 /** Initialize a color with R, G, and B values, including any toolkit-dependent
  47  ** work that needs to be done.
  48  *
  49  * @param color the color_t to be filled
  50  * @param red the red value for the color
  51  * @param green the green value for the color
  52  * @param blue the blue value for the color
  53  * @return TRUE if it succeeds, FALSE if it fails
  54  */
  55 gboolean initialize_color(color_t *color, guint16 red, guint16 green, guint16 blue);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif /* __cplusplus */
  60
  61 #endif /* __COLOR_H__ */
  62
  63 /*
  64  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
  65  *
  66  * Local variables:
  67  * c-basic-offset: 8
  68  * tab-width: 8
  69  * indent-tabs-mode: t
  70  * End:
  71  *
  72  * vi: set shiftwidth=8 tabstop=8 noexpandtab:
  73  * :indentSize=8:tabSize=8:noTabs=false:
  74  */