gdkcolor.c 6.29 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27
#include "config.h"
28
#include <time.h>
Owen Taylor's avatar
Started  
Owen Taylor committed
29

30
#include "gdkscreen.h"
Owen Taylor's avatar
Started  
Owen Taylor committed
31
#include "gdkcolor.h"
32
#include "gdkinternals.h"
33
#include "gdkalias.h"
Elliot Lee's avatar
Elliot Lee committed
34

Matthias Clasen's avatar
Matthias Clasen committed
35 36 37 38 39 40 41 42 43

/**
 * gdk_colormap_get_visual:
 * @colormap: a #GdkColormap.
 * 
 * Returns the visual for which a given colormap was created.
 * 
 * Return value: the visual of the colormap.
 **/
44 45 46
GdkVisual *
gdk_colormap_get_visual (GdkColormap *colormap)
{
47
  g_return_val_if_fail (GDK_IS_COLORMAP (colormap), NULL);
48

49
  return colormap->visual;
50
}
Matthias Clasen's avatar
Matthias Clasen committed
51 52 53 54 55 56 57 58 59 60

/**
 * gdk_color_copy:
 * @color: a #GdkColor.
 * 
 * Makes a copy of a color structure. The result
 * must be freed using gdk_color_free().
 * 
 * Return value: a copy of @color.
 **/
61
GdkColor*
Owen Taylor's avatar
Owen Taylor committed
62
gdk_color_copy (const GdkColor *color)
63 64 65 66 67
{
  GdkColor *new_color;
  
  g_return_val_if_fail (color != NULL, NULL);

68
  new_color = g_slice_new (GdkColor);
69 70 71 72
  *new_color = *color;
  return new_color;
}

Matthias Clasen's avatar
Matthias Clasen committed
73 74 75 76 77 78 79
/**
 * gdk_color_free:
 * @color: a #GdkColor.
 * 
 * Frees a color structure created with 
 * gdk_color_copy().
 **/
80 81 82 83 84
void
gdk_color_free (GdkColor *color)
{
  g_return_if_fail (color != NULL);

85
  g_slice_free (GdkColor, color);
86 87
}

88 89 90 91
/********************
 * Color allocation *
 ********************/

Matthias Clasen's avatar
Matthias Clasen committed
92 93 94 95 96 97
/**
 * gdk_colormap_alloc_color:
 * @colormap: a #GdkColormap.
 * @color: the color to allocate. On return the
 *    <structfield>pixel</structfield> field will be
 *    filled in if allocation succeeds.
98 99
 * @writeable: this parameter has no effect, and it's here for mere
 *   compatibility.
Matthias Clasen's avatar
Matthias Clasen committed
100 101 102 103
 * @best_match: If %TRUE, GDK will attempt to do matching against
 *    existing colors if the color cannot be allocated as requested.
 *
 * Allocates a single color from a colormap.
104
 *
Matthias Clasen's avatar
Matthias Clasen committed
105 106
 * Return value: %TRUE if the allocation succeeded.
 **/
107 108 109 110 111 112 113 114 115 116 117 118 119 120
gboolean
gdk_colormap_alloc_color (GdkColormap *colormap,
			  GdkColor    *color,
			  gboolean     writeable,
			  gboolean     best_match)
{
  gboolean success;

  gdk_colormap_alloc_colors (colormap, color, 1, writeable, best_match,
			     &success);

  return success;
}

Matthias Clasen's avatar
Matthias Clasen committed
121 122 123 124 125 126 127
/**
 * gdk_color_hash:
 * @colora: a #GdkColor.
 * 
 * A hash function suitable for using for a hash
 * table that stores #GdkColor's.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
128
 * Return value: The hash function applied to @colora
Matthias Clasen's avatar
Matthias Clasen committed
129
 **/
130
guint
131
gdk_color_hash (const GdkColor *colora)
132 133 134 135 136 137 138
{
  return ((colora->red) +
	  (colora->green << 11) +
	  (colora->blue << 22) +
	  (colora->blue >> 6));
}

Matthias Clasen's avatar
Matthias Clasen committed
139 140 141 142 143 144 145 146 147
/**
 * gdk_color_equal:
 * @colora: a #GdkColor.
 * @colorb: another #GdkColor.
 * 
 * Compares two colors. 
 * 
 * Return value: %TRUE if the two colors compare equal
 **/
Owen Taylor's avatar
Owen Taylor committed
148
gboolean
149 150
gdk_color_equal (const GdkColor *colora,
		 const GdkColor *colorb)
Elliot Lee's avatar
Elliot Lee committed
151 152 153 154 155 156 157 158
{
  g_return_val_if_fail (colora != NULL, FALSE);
  g_return_val_if_fail (colorb != NULL, FALSE);

  return ((colora->red == colorb->red) &&
	  (colora->green == colorb->green) &&
	  (colora->blue == colorb->blue));
}
159 160 161 162 163 164 165

GType
gdk_color_get_type (void)
{
  static GType our_type = 0;
  
  if (our_type == 0)
166
    our_type = g_boxed_type_register_static (g_intern_static_string ("GdkColor"),
167
					     (GBoxedCopyFunc)gdk_color_copy,
168
					     (GBoxedFreeFunc)gdk_color_free);
169 170
  return our_type;
}
171

Matthias Clasen's avatar
Matthias Clasen committed
172 173 174
/**
 * gdk_color_parse:
 * @spec: the string specifying the color.
175 176
 * @color: (out): the #GdkColor to fill in
 *
177 178 179 180 181 182 183 184 185 186 187 188
 * Parses a textual specification of a color and fill in the
 * <structfield>red</structfield>, <structfield>green</structfield>,
 * and <structfield>blue</structfield> fields of a #GdkColor
 * structure. The color is <emphasis>not</emphasis> allocated, you
 * must call gdk_colormap_alloc_color() yourself. The string can
 * either one of a large set of standard names. (Taken from the X11
 * <filename>rgb.txt</filename> file), or it can be a hex value in the
 * form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or
 * '&num;rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the
 * red, green, and blue components of the color, respectively. (White
 * in the four forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and
 * '&num;ffffffffffff')
Matthias Clasen's avatar
Matthias Clasen committed
189 190 191
 * 
 * Return value: %TRUE if the parsing succeeded.
 **/
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
gboolean
gdk_color_parse (const gchar *spec,
		 GdkColor    *color)
{
  PangoColor pango_color;

  if (pango_color_parse (&pango_color, spec))
    {
      color->red = pango_color.red;
      color->green = pango_color.green;
      color->blue = pango_color.blue;

      return TRUE;
    }
  else
    return FALSE;
}
209

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
/**
 * gdk_color_to_string:
 * @color: a #GdkColor
 *
 * Returns a textual specification of @color in the hexadecimal form
 * <literal>&num;rrrrggggbbbb</literal>, where <literal>r</literal>,
 * <literal>g</literal> and <literal>b</literal> are hex digits
 * representing the red, green and blue components respectively.
 *
 * Return value: a newly-allocated text string
 *
 * Since: 2.12
 **/
gchar *
gdk_color_to_string (const GdkColor *color)
{
  PangoColor pango_color;

  g_return_val_if_fail (color != NULL, NULL);

  pango_color.red = color->red;
  pango_color.green = color->green;
  pango_color.blue = color->blue;

  return pango_color_to_string (&pango_color);
}

237 238 239 240 241 242 243 244 245 246 247
/**
 * gdk_colormap_get_system:
 * 
 * Gets the system's default colormap for the default screen. (See
 * gdk_colormap_get_system_for_screen ())
 * 
 * Return value: the default colormap.
 **/
GdkColormap*
gdk_colormap_get_system (void)
{
Owen Taylor's avatar
Owen Taylor committed
248
  return gdk_screen_get_system_colormap (gdk_screen_get_default ());
249 250
}

251 252
#define __GDK_COLOR_C__
#include "gdkaliasdef.c"