gdkcolor.c 9.27 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GDK - The GIMP Drawing Kit
 * 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
/**
 * gdk_colormap_ref:
Owen Taylor's avatar
Owen Taylor committed
37
 * @cmap: a #GdkColormap
Matthias Clasen's avatar
Matthias Clasen committed
38 39 40 41 42
 *
 * Deprecated function; use g_object_ref() instead.
 *
 * Return value: the colormap
 **/
Elliot Lee's avatar
Elliot Lee committed
43 44 45
GdkColormap*
gdk_colormap_ref (GdkColormap *cmap)
{
46
  return (GdkColormap *) g_object_ref (cmap);
Elliot Lee's avatar
Elliot Lee committed
47 48
}

Matthias Clasen's avatar
Matthias Clasen committed
49 50
/**
 * gdk_colormap_unref:
Owen Taylor's avatar
Owen Taylor committed
51
 * @cmap: a #GdkColormap
Matthias Clasen's avatar
Matthias Clasen committed
52 53 54
 *
 * Deprecated function; use g_object_ref() instead.
 **/
Elliot Lee's avatar
Elliot Lee committed
55 56 57
void
gdk_colormap_unref (GdkColormap *cmap)
{
58
  g_object_unref (cmap);
Elliot Lee's avatar
Elliot Lee committed
59 60
}

Matthias Clasen's avatar
Matthias Clasen committed
61 62 63 64 65 66 67 68 69

/**
 * gdk_colormap_get_visual:
 * @colormap: a #GdkColormap.
 * 
 * Returns the visual for which a given colormap was created.
 * 
 * Return value: the visual of the colormap.
 **/
70 71 72
GdkVisual *
gdk_colormap_get_visual (GdkColormap *colormap)
{
73
  g_return_val_if_fail (GDK_IS_COLORMAP (colormap), NULL);
74

75
  return colormap->visual;
76
}
Matthias Clasen's avatar
Matthias Clasen committed
77 78 79 80 81 82 83 84 85 86 87

/**
 * gdk_colors_store:
 * @colormap: a #GdkColormap.
 * @colors: the new color values.
 * @ncolors: the number of colors to change.
 * 
 * Changes the value of the first @ncolors colors in
 * a private colormap. This function is obsolete and
 * should not be used. See gdk_color_change().
 **/     
Elliot Lee's avatar
Elliot Lee committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
void
gdk_colors_store (GdkColormap   *colormap,
		  GdkColor      *colors,
		  gint           ncolors)
{
  gint i;

  for (i = 0; i < ncolors; i++)
    {
      colormap->colors[i].pixel = colors[i].pixel;
      colormap->colors[i].red = colors[i].red;
      colormap->colors[i].green = colors[i].green;
      colormap->colors[i].blue = colors[i].blue;
    }

  gdk_colormap_change (colormap, ncolors);
}

Matthias Clasen's avatar
Matthias Clasen committed
106 107 108 109 110 111 112 113 114
/**
 * 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.
 **/
115
GdkColor*
Owen Taylor's avatar
Owen Taylor committed
116
gdk_color_copy (const GdkColor *color)
117 118 119 120 121
{
  GdkColor *new_color;
  
  g_return_val_if_fail (color != NULL, NULL);

122
  new_color = g_slice_new (GdkColor);
123 124 125 126
  *new_color = *color;
  return new_color;
}

Matthias Clasen's avatar
Matthias Clasen committed
127 128 129 130 131 132 133
/**
 * gdk_color_free:
 * @color: a #GdkColor.
 * 
 * Frees a color structure created with 
 * gdk_color_copy().
 **/
134 135 136 137 138
void
gdk_color_free (GdkColor *color)
{
  g_return_if_fail (color != NULL);

139
  g_slice_free (GdkColor, color);
140 141
}

Matthias Clasen's avatar
Matthias Clasen committed
142 143 144 145 146 147 148 149 150 151
/**
 * gdk_color_white:
 * @colormap: a #GdkColormap.
 * @color: the location to store the color.
 * 
 * Returns the white color for a given colormap. The resulting
 * value has already allocated been allocated. 
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
152
gboolean
Elliot Lee's avatar
Elliot Lee committed
153 154 155 156 157 158 159 160 161 162 163 164 165
gdk_color_white (GdkColormap *colormap,
		 GdkColor    *color)
{
  gint return_val;

  g_return_val_if_fail (colormap != NULL, FALSE);

  if (color)
    {
      color->red = 65535;
      color->green = 65535;
      color->blue = 65535;

Manish Singh's avatar
Manish Singh committed
166
      return_val = gdk_colormap_alloc_color (colormap, color, FALSE, TRUE);
Elliot Lee's avatar
Elliot Lee committed
167 168 169 170 171 172 173
    }
  else
    return_val = FALSE;

  return return_val;
}

Matthias Clasen's avatar
Matthias Clasen committed
174 175 176 177 178 179 180 181 182 183
/**
 * gdk_color_black:
 * @colormap: a #GdkColormap.
 * @color: the location to store the color.
 * 
 * Returns the black color for a given colormap. The resulting
 * value has already benn allocated. 
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
184
gboolean
Elliot Lee's avatar
Elliot Lee committed
185 186 187 188 189 190 191 192 193 194 195 196 197
gdk_color_black (GdkColormap *colormap,
		 GdkColor    *color)
{
  gint return_val;

  g_return_val_if_fail (colormap != NULL, FALSE);

  if (color)
    {
      color->red = 0;
      color->green = 0;
      color->blue = 0;

Manish Singh's avatar
Manish Singh committed
198
      return_val = gdk_colormap_alloc_color (colormap, color, FALSE, TRUE);
Elliot Lee's avatar
Elliot Lee committed
199 200 201 202 203 204 205
    }
  else
    return_val = FALSE;

  return return_val;
}

206 207 208 209
/********************
 * Color allocation *
 ********************/

Matthias Clasen's avatar
Matthias Clasen committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/**
 * 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.
 * @writeable: If %TRUE, the color is allocated writeable
 *    (their values can later be changed using gdk_color_change()).
 *    Writeable colors cannot be shared between applications.
 * @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.
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
226 227 228 229 230 231 232 233 234 235 236 237 238 239
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
240 241 242 243 244 245 246 247 248
/**
 * gdk_color_alloc:
 * @colormap: a #GdkColormap.
 * @color: The color to allocate. On return, the 
 *    <structfield>pixel</structfield> field will be filled in.
 * 
 * Allocates a single color from a colormap.
 * 
 * Return value: %TRUE if the allocation succeeded.
Matthias Clasen's avatar
Matthias Clasen committed
249 250
 *
 * Deprecated: Use gdk_colormap_alloc_color() instead.
Matthias Clasen's avatar
Matthias Clasen committed
251
 **/
252 253 254 255 256 257 258 259 260
gboolean
gdk_color_alloc (GdkColormap *colormap,
		 GdkColor    *color)
{
  gboolean success;

  gdk_colormap_alloc_colors (colormap, color, 1, FALSE, TRUE, &success);

  return success;
Elliot Lee's avatar
Elliot Lee committed
261 262
}

Matthias Clasen's avatar
Matthias Clasen committed
263 264 265 266 267 268 269
/**
 * 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
270
 * Return value: The hash function applied to @colora
Matthias Clasen's avatar
Matthias Clasen committed
271
 **/
272
guint
273
gdk_color_hash (const GdkColor *colora)
274 275 276 277 278 279 280
{
  return ((colora->red) +
	  (colora->green << 11) +
	  (colora->blue << 22) +
	  (colora->blue >> 6));
}

Matthias Clasen's avatar
Matthias Clasen committed
281 282 283 284 285 286 287 288 289
/**
 * 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
290
gboolean
291 292
gdk_color_equal (const GdkColor *colora,
		 const GdkColor *colorb)
Elliot Lee's avatar
Elliot Lee committed
293 294 295 296 297 298 299 300
{
  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));
}
301 302 303 304 305 306 307

GType
gdk_color_get_type (void)
{
  static GType our_type = 0;
  
  if (our_type == 0)
308
    our_type = g_boxed_type_register_static (g_intern_static_string ("GdkColor"),
309
					     (GBoxedCopyFunc)gdk_color_copy,
310
					     (GBoxedFreeFunc)gdk_color_free);
311 312
  return our_type;
}
313

Matthias Clasen's avatar
Matthias Clasen committed
314 315 316 317 318
/**
 * gdk_color_parse:
 * @spec: the string specifying the color.
 * @color: the #GdkColor to fill in
 * 
319 320 321 322 323 324 325 326 327 328 329 330
 * 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
331 332 333
 * 
 * Return value: %TRUE if the parsing succeeded.
 **/
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
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;
}
351

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
/**
 * 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);
}

379 380 381 382 383 384 385 386 387 388 389
/**
 * 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
390
  return gdk_screen_get_system_colormap (gdk_screen_get_default ());
391 392
}

393 394
#define __GDK_COLOR_C__
#include "gdkaliasdef.c"