gdkcolor.c 4.56 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"
Elliot Lee's avatar
Elliot Lee committed
33

Matthias Clasen's avatar
Matthias Clasen committed
34

35 36 37 38 39 40 41
/**
 * SECTION:colors
 * @Short_description: Manipulation of colors
 * @Title: Colors
 */


Matthias Clasen's avatar
Matthias Clasen committed
42 43 44 45 46 47 48 49 50
/**
 * 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.
 **/
51
GdkColor*
Owen Taylor's avatar
Owen Taylor committed
52
gdk_color_copy (const GdkColor *color)
53 54 55 56 57
{
  GdkColor *new_color;
  
  g_return_val_if_fail (color != NULL, NULL);

58
  new_color = g_slice_new (GdkColor);
59 60 61 62
  *new_color = *color;
  return new_color;
}

Matthias Clasen's avatar
Matthias Clasen committed
63 64 65 66 67 68 69
/**
 * gdk_color_free:
 * @color: a #GdkColor.
 * 
 * Frees a color structure created with 
 * gdk_color_copy().
 **/
70 71 72 73 74
void
gdk_color_free (GdkColor *color)
{
  g_return_if_fail (color != NULL);

75
  g_slice_free (GdkColor, color);
76 77
}

Matthias Clasen's avatar
Matthias Clasen committed
78 79 80 81 82 83 84
/**
 * 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
85
 * Return value: The hash function applied to @colora
Matthias Clasen's avatar
Matthias Clasen committed
86
 **/
87
guint
88
gdk_color_hash (const GdkColor *colora)
89 90 91 92 93 94 95
{
  return ((colora->red) +
	  (colora->green << 11) +
	  (colora->blue << 22) +
	  (colora->blue >> 6));
}

Matthias Clasen's avatar
Matthias Clasen committed
96 97 98 99 100 101 102 103 104
/**
 * 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
105
gboolean
106 107
gdk_color_equal (const GdkColor *colora,
		 const GdkColor *colorb)
Elliot Lee's avatar
Elliot Lee committed
108 109 110 111 112 113 114 115
{
  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));
}
116

Christian Persch's avatar
Christian Persch committed
117 118 119
G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
                     gdk_color_copy,
                     gdk_color_free)
120

Matthias Clasen's avatar
Matthias Clasen committed
121 122 123
/**
 * gdk_color_parse:
 * @spec: the string specifying the color.
124 125
 * @color: (out): the #GdkColor to fill in
 *
126 127 128
 * 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
Benjamin Otte's avatar
Benjamin Otte committed
129 130 131 132 133 134 135
 * structure. 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
136 137 138
 * 
 * Return value: %TRUE if the parsing succeeded.
 **/
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
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;
}
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/**
 * 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);
}