]> Pileus Git - ~andy/gtk/blobdiff - gdk/gdkcolor.c
Change FSF Address
[~andy/gtk] / gdk / gdkcolor.c
index 25b600ea294be1c79faaf4046ce437749fd3c790..53765f601019c87c72dd119264b03759e6dd5b71 100644 (file)
@@ -12,9 +12,7 @@
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
  */
 
-#include <config.h>
-#include <time.h>
+#include "config.h"
 
-#include "gdkscreen.h"
 #include "gdkcolor.h"
+
+#include "gdkscreen.h"
 #include "gdkinternals.h"
-#include "gdkalias.h"
 
-/**
- * gdk_colormap_ref:
- * @cmap: a #GdkColormap
- *
- * Deprecated function; use g_object_ref() instead.
- *
- * Return value: the colormap
- **/
-GdkColormap*
-gdk_colormap_ref (GdkColormap *cmap)
-{
-  return (GdkColormap *) g_object_ref (cmap);
-}
+#include <time.h>
 
 /**
- * gdk_colormap_unref:
- * @cmap: a #GdkColormap
+ * SECTION:colors
+ * @Short_description: Manipulation of colors
+ * @Title: Colors
  *
- * Deprecated function; use g_object_ref() instead.
- **/
-void
-gdk_colormap_unref (GdkColormap *cmap)
-{
-  g_object_unref (cmap);
-}
-
-
-/**
- * gdk_colormap_get_visual:
- * @colormap: a #GdkColormap.
- * 
- * Returns the visual for which a given colormap was created.
- * 
- * Return value: the visual of the colormap.
- **/
-GdkVisual *
-gdk_colormap_get_visual (GdkColormap *colormap)
-{
-  g_return_val_if_fail (GDK_IS_COLORMAP (colormap), NULL);
-
-  return colormap->visual;
-}
-
-/**
- * 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().
- **/     
-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);
-}
+ * A #GdkColor represents a color.
+ *
+ * When working with cairo, it is often more convenient
+ * to use a #GdkRGBA instead.
+ */
 
-static GMemChunk *color_chunk;
 
 /**
  * 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.
- **/
+ * @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
+ */
 GdkColor*
 gdk_color_copy (const GdkColor *color)
 {
   GdkColor *new_color;
-  
-  g_return_val_if_fail (color != NULL, NULL);
 
-  if (color_chunk == NULL)
-    color_chunk = g_mem_chunk_new ("colors",
-                                  sizeof (GdkColor),
-                                  4096,
-                                  G_ALLOC_AND_FREE);
+  g_return_val_if_fail (color != NULL, NULL);
 
-  new_color = g_chunk_new (GdkColor, color_chunk);
+  new_color = g_slice_new (GdkColor);
   *new_color = *color;
   return new_color;
 }
 
 /**
  * gdk_color_free:
- * @color: a #GdkColor.
- * 
- * Frees a color structure created with 
- * gdk_color_copy().
- **/
+ * @color: a #GdkColor
+ *
+ * Frees a color structure created with gdk_color_copy().
+ */
 void
 gdk_color_free (GdkColor *color)
 {
-  g_assert (color_chunk != NULL);
   g_return_if_fail (color != NULL);
 
-  g_mem_chunk_free (color_chunk, color);
-}
-
-/**
- * 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.
- **/
-gboolean
-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;
-
-      return_val = gdk_colormap_alloc_color (colormap, color, FALSE, TRUE);
-    }
-  else
-    return_val = FALSE;
-
-  return return_val;
-}
-
-/**
- * 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.
- **/
-gboolean
-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;
-
-      return_val = gdk_colormap_alloc_color (colormap, color, FALSE, TRUE);
-    }
-  else
-    return_val = FALSE;
-
-  return return_val;
-}
-
-/********************
- * Color allocation *
- ********************/
-
-/**
- * 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.
- **/
-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;
-}
-
-/**
- * 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.
- *
- * Deprecated: Use gdk_colormap_alloc_color() instead.
- **/
-gboolean
-gdk_color_alloc (GdkColormap *colormap,
-                GdkColor    *color)
-{
-  gboolean success;
-
-  gdk_colormap_alloc_colors (colormap, color, 1, FALSE, TRUE, &success);
-
-  return success;
+  g_slice_free (GdkColor, color);
 }
 
 /**
  * gdk_color_hash:
- * @colora: a #GdkColor.
- * 
+ * @color: a #GdkColor
+ *
  * A hash function suitable for using for a hash
- * table that stores #GdkColor's.
- * 
- * Return value: The hash function appled to @colora
- **/
+ * table that stores #GdkColors.
+ *
+ * Return value: The hash function applied to @color
+ */
 guint
-gdk_color_hash (const GdkColor *colora)
+gdk_color_hash (const GdkColor *color)
 {
-  return ((colora->red) +
-         (colora->green << 11) +
-         (colora->blue << 22) +
-         (colora->blue >> 6));
+  return ((color->red) +
+          (color->green << 11) +
+          (color->blue << 22) +
+          (color->blue >> 6));
 }
 
 /**
  * gdk_color_equal:
- * @colora: a #GdkColor.
- * @colorb: another #GdkColor.
- * 
- * Compares two colors. 
- * 
+ * @colora: a #GdkColor
+ * @colorb: another #GdkColor
+ *
+ * Compares two colors.
+ *
  * Return value: %TRUE if the two colors compare equal
- **/
+ */
 gboolean
 gdk_color_equal (const GdkColor *colora,
-                const GdkColor *colorb)
+                 const GdkColor *colorb)
 {
   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));
+          (colora->green == colorb->green) &&
+          (colora->blue == colorb->blue));
 }
 
-GType
-gdk_color_get_type (void)
-{
-  static GType our_type = 0;
-  
-  if (our_type == 0)
-    our_type = g_boxed_type_register_static (g_intern_static_string ("GdkColor"),
-                                            (GBoxedCopyFunc)gdk_color_copy,
-                                            (GBoxedFreeFunc)gdk_color_free);
-  return our_type;
-}
+G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
+                     gdk_color_copy,
+                     gdk_color_free)
 
 /**
  * gdk_color_parse:
- * @spec: the string specifying the color.
- * @color: the #GdkColor to fill in
- * 
- * 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 text string can be in any of the forms accepted
- * by <function>XParseColor</function>; these include
- * name for a color from <filename>rgb.txt</filename>, such as
- * <literal>DarkSlateGray</literal>, or a hex specification
- * such as <literal>305050</literal>.
- * 
- * Return value: %TRUE if the parsing succeeded.
- **/
+ * @spec: the string specifying the color
+ * @color: (out): the #GdkColor to fill in
+ *
+ * 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 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').
+ *
+ * Return value: %TRUE if the parsing succeeded
+ */
 gboolean
 gdk_color_parse (const gchar *spec,
-                GdkColor    *color)
+                 GdkColor    *color)
 {
   PangoColor pango_color;
 
@@ -358,18 +162,30 @@ gdk_color_parse (const gchar *spec,
 }
 
 /**
- * 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)
+ * 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.
+ *
+ * The returned string can be parsed by gdk_color_parse().
+ *
+ * Return value: a newly-allocated text string
+ *
+ * Since: 2.12
+ */
+gchar *
+gdk_color_to_string (const GdkColor *color)
 {
-  return gdk_screen_get_system_colormap (gdk_screen_get_default ());
-}
+  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;
 
-#define __GDK_COLOR_C__
-#include "gdkaliasdef.c"
+  return pango_color_to_string (&pango_color);
+}