Document symbolic colors and color expressions.

2005-11-23  Matthias Clasen  <mclasen@redhat.com>

	* gtk/tmpl/gtkrc.sgml: Document symbolic colors and
	color expressions.

diff --git a/ChangeLog b/ChangeLog
index cc7f3f69637010f75d4b42aef75bd9cc5f81ec04..4f6c6adea1457ab1178735c828cdb3f21ec3e13d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2005-11-23  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtksettings.c (gtk_settings_class_init): Add some docs
+       about gtk-color-scheme.
+
 2005-11-23  Behdad Esfahbod  <behdad@gnome.org>
 
        * configure.in (enable_explicit_deps): Fix typo when checking

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index cc7f3f69637010f75d4b42aef75bd9cc5f81ec04..4f6c6adea1457ab1178735c828cdb3f21ec3e13d 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2005-11-23  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtksettings.c (gtk_settings_class_init): Add some docs
+       about gtk-color-scheme.
+
 2005-11-23  Behdad Esfahbod  <behdad@gnome.org>
 
        * configure.in (enable_explicit_deps): Fix typo when checking

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index c8b8629db4442fb7b17e3c709fabd6b34b430bcb..6e2564aa8dcd9e9a7aac9d887f73641036a2bbe7 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2005-11-23  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/tmpl/gtkrc.sgml: Document symbolic colors and
+       color expressions.
+
 2005-11-23  Michael Natterer  <mitch@imendio.com>
 
        * gtk/gtk-sections.txt: add gtk_style_lookup_color

diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml
index 1282268b6c37182c432f2278983e078c442dd668..0751551aa6b79af4a95b51aa822255cc6e595a7e 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkrc.sgml
+++ b/docs/reference/gtk/tmpl/gtkrc.sgml
@@ -440,6 +440,15 @@ elements are:
        </para>
      </listitem>
   </varlistentry>
+  <varlistentry>
+    <term><literal>color[<replaceable>"color-name"</replaceable>] = <replaceable>color specification</replaceable></literal></term>
+     <listitem>
+       <para>
+        Since 2.10, this element can be used to defines symbolic colors. See below for
+        the syntax of color specifications. 
+       </para>
+     </listitem>
+  </varlistentry>
   <varlistentry>
     <term><literal>engine <replaceable>"engine"</replaceable> { <replaceable>engine-specific
 settings</replaceable> }</literal></term>
@@ -520,8 +529,7 @@ state of the widget. The states are:
 
 <para><anchor id="color-format"/>
 Colors can be specified as a string containing a color name (GTK+ knows
-all names from the X color database 
-<filename>/usr/lib/X11/rgb.txt</filename>),  
+all names from the X color database <filename>/usr/lib/X11/rgb.txt</filename>),  
 in one of the hexadecimal forms <literal>&num;rrrrggggbbbb</literal>,
 <literal>&num;rrrgggbbb</literal>, <literal>&num;rrggbb</literal>,
 or <literal>&num;rgb</literal>, where <literal>r</literal>,
@@ -532,6 +540,56 @@ hex digits, or they can be specified as a triplet
 <literal>g</literal> and <literal>b</literal> are either integers in 
 the range 0-65535 or floats in the range 0.0-1.0.
 </para>
+<para>
+Since 2.10, colors can also be specified by refering to a symbolic color, as
+follows: <literal>@<!-- -->color-name</literal>, or by using expressions to combine
+colors. The following expressions are currently supported:
+  <variablelist>
+    <varlistentry>
+      <term>mix (<replaceable>factor</replaceable>, <replaceable>color1</replaceable>, <replaceable>color2</replaceable>)</term>
+      <listitem><para>
+        Computes a new color by mixing <replaceable>color1</replaceable> and 
+        <replaceable>color2</replaceable>. The <replaceable>factor</replaceable> 
+        determines how close the new color is to <replaceable>color1</replaceable>. 
+        A factor of 1.0 gives pure <replaceable>color1</replaceable>, a factor of 
+        0.0 gives pure <replaceable>color2</replaceable>.  
+      </para></listitem>        
+    </varlistentry>
+
+    <varlistentry>
+      <term>shade (<replaceable>factor</replaceable>, <replaceable>color</replaceable>)</term>
+      <listitem><para>
+        Computes a lighter or darker variant of <replaceable>color</replaceable>. 
+        A <replaceable>factor</replaceable> of 1.0 leaves the color unchanged, smaller 
+        factors yield darker colors, larger factors yield lighter colors.
+      </para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term>lighter (<replaceable>color</replaceable>)</term>
+      <listitem><para>
+        This is an abbreviation for 
+        <literal>shade (1.3, <replaceable>color</replaceable>)</literal>.
+      </para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term>darker (<replaceable>color</replaceable>)</term>
+      <listitem><para>
+        This is an abbreviation for 
+        <literal>shade (0.7, <replaceable>color</replaceable>)</literal>.
+      </para></listitem>
+    </varlistentry>
+  </variablelist>      
+</para>
+<para>
+Here are some examples of color expressions:
+<informalexample><programlisting>  
+ mix (0.5, "red", "blue")
+ shade (1.5, mix (0.3, "&num;0abbc0", { 0.3, 0.5, 0.9 }))
+ lighter (@<!-- -->foreground)
+</programlisting></informalexample>
+</para>
 
 <para>
 In a <literal>stock</literal> definition, icon sources are specified as a
@@ -744,6 +802,7 @@ specific portions of a RC file.
 @GTK_RC_TOKEN_STOCK: 
 @GTK_RC_TOKEN_LTR: 
 @GTK_RC_TOKEN_RTL: 
+@GTK_RC_TOKEN_COLOR: 
 @GTK_RC_TOKEN_LAST: 
 
 <!-- ##### FUNCTION gtk_rc_scanner_new ##### -->

diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index f57a056f27258c8bc2cf81e4b78d39e2523e0f97..15b9f45f03a4f1ed5e610ada5ce6aae45f2f374e 100644 (file)
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -433,6 +433,22 @@ gtk_settings_class_init (GtkSettingsClass *class)
 
   g_assert (result == PROP_TIMEOUT_REPEAT);
 
+  /**
+   * GtkSettings:gtk-color-scheme:
+   *
+   * A palette of named colors for use in themes. The format of the string is
+   * <programlisting>
+   * name1: color1
+   * name2: color2
+   * ...
+   * </programlisting>
+   * Color names must be acceptable as identifiers in the 
+   * <link linkend="gtk-Resource-Files">gtkrc</link> syntax, and
+   * color specifications must be in the format accepted by
+   * gdk_color_parse().
+   * 
+   * Since: 2.10
+   */
   result = settings_install_property_parser (class,
                                             g_param_spec_string ("gtk-color-scheme",
                                                                  P_("Color scheme"),