Make 3.0 parallel-installable to 2.x

[~andy/gtk] / docs / reference / gdk / tmpl / colors.sgml

diff --git a/docs/reference/gdk/tmpl/colors.sgml b/docs/reference/gdk/tmpl/colors.sgml
index 3f47ec8260965930a1c6518d9243ead4c18e2667..3d1a8749f1a085e72db56f077045df85e85d961b 100644 (file)
--- a/docs/reference/gdk/tmpl/colors.sgml
+++ b/docs/reference/gdk/tmpl/colors.sgml
@@ -2,11 +2,40 @@
 Colormaps and Colors
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Manipulation of colors and colormaps
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+These functions are used to modify colormaps.
+A colormap is an object that contains the mapping
+between the color values stored in memory and
+the RGB values that are used to display color
+values. In general, colormaps only contain
+significant information for pseudo-color visuals,
+but even for other visual types, a colormap object
+is required in some circumstances.
+</para>
 
+<para>
+There are a couple of special colormaps that can
+be retrieved. The system colormap (retrieved 
+with gdk_colormap_get_system()) is the default
+colormap of the system. If you are using GdkRGB,
+there is another colormap that is important - the
+colormap in which GdkRGB works, retrieved with
+gdk_rgb_get_colormap(). However, when using GdkRGB, 
+it is not generally necessary to allocate colors
+directly.
+</para>
+
+<para>
+In previous revisions of this interface, a number
+of functions that take a #GdkColormap parameter
+were replaced with functions whose names began
+with "gdk_colormap_". This process will probably
+be extended somewhat in the future - 
+gdk_color_white(), gdk_color_black(), and 
+gdk_color_change() will probably become aliases.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -14,28 +43,40 @@ Colormaps and Colors
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### STRUCT GdkColor ##### -->
 <para>
-
+The #GdkColor structure is used to describe an 
+allocated or unallocated color.
 </para>
 
-@pixel: 
-@red: 
-@green: 
-@blue: 
+@pixel: For allocated colors, the value used to
+  draw this color on the screen.
+@red: The red component of the color. This is
+  a value between 0 and 65535, with 65535 indicating
+  full intensitiy.
+@green: The blue component of the color.
+@blue: The green component of the color.
 
 <!-- ##### STRUCT GdkColormap ##### -->
 <para>
-
+The colormap structure contains the following public fields.
 </para>
 
-@parent_instance: 
-@size: 
-@colors: 
+@size: For pseudo-color colormaps, the number of colors
+  in the colormap.
+@colors: An array containing the current values in the
+  colormap. This can be used to map from pixel values
+  back to RGB values. This is only meaningful for
+  pseudo-color colormaps.
 
 <!-- ##### FUNCTION gdk_colormap_new ##### -->
 <para>
-
 </para>
 
 @visual: 
@@ -62,23 +103,22 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colormap_get_system ##### -->
 <para>
-
 </para>
 
+@void: 
 @Returns: 
 
 
 <!-- ##### FUNCTION gdk_colormap_get_system_size ##### -->
 <para>
-
 </para>
 
+@void: 
 @Returns: 
 
 
 <!-- ##### FUNCTION gdk_colormap_change ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -87,12 +127,11 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colormap_alloc_colors ##### -->
 <para>
-
 </para>
 
 @colormap: 
 @colors: 
-@ncolors: 
+@n_colors: 
 @writeable: 
 @best_match: 
 @success: 
@@ -101,7 +140,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colormap_alloc_color ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -113,12 +151,11 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colormap_free_colors ##### -->
 <para>
-
 </para>
 
 @colormap: 
 @colors: 
-@ncolors: 
+@n_colors: 
 
 
 <!-- ##### FUNCTION gdk_colormap_query_color ##### -->
@@ -133,18 +170,25 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colormap_get_visual ##### -->
 <para>
-
 </para>
 
 @colormap: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_colors_store ##### -->
+<!-- ##### FUNCTION gdk_colormap_get_screen ##### -->
 <para>
 
 </para>
 
+@cmap: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_colors_store ##### -->
+<para>
+</para>
+
 @colormap: 
 @colors: 
 @ncolors: 
@@ -152,7 +196,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_copy ##### -->
 <para>
-
 </para>
 
 @color: 
@@ -161,7 +204,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_free ##### -->
 <para>
-
 </para>
 
 @color: 
@@ -169,7 +211,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colors_alloc ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -183,7 +224,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_colors_free ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -194,7 +234,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_white ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -204,7 +243,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_black ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -214,7 +252,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_parse ##### -->
 <para>
-
 </para>
 
 @spec: 
@@ -224,7 +261,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_alloc ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -234,7 +270,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_change ##### -->
 <para>
-
 </para>
 
 @colormap: 
@@ -244,7 +279,6 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_equal ##### -->
 <para>
-
 </para>
 
 @colora: 
@@ -254,10 +288,18 @@ Colormaps and Colors
 
 <!-- ##### FUNCTION gdk_color_hash ##### -->
 <para>
-
 </para>
 
 @colora: 
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_color_to_string ##### -->
+<para>
+
+</para>
+
+@color: 
+@Returns: 
+
+