pango: Document ->color procedure. Pull string formats from Cairo.
authorMatt Birkholz <matt@birchwood-abbey.net>
Mon, 12 Mar 2018 16:16:01 +0000 (09:16 -0700)
committerMatt Birkholz <matt@birchwood-abbey.net>
Mon, 12 Mar 2018 16:16:01 +0000 (09:16 -0700)
src/pango/pango.texi

index 1d513cb7e1397b0b416e9bda68557d09a2c229b2..88660bace73719b48982bdd8778f47938c03a9f6 100644 (file)
@@ -366,10 +366,24 @@ thereafter signal an error.
 @deffn Procedure pango-color-parse string
 Parses @var{string} and returns a floating-vector containing four
 flonums between 0. and 1. inclusive: the red, green, blue and alpha
-components.  @var{String} can be a standard color name (per the
-Cascading Style Sheetse standard) or 1-4 hex digits specifying the
-intensity of the red, green and blue components: @code{"#RGB"} or
-@code{"#RRGGBB"} or @code{"#RRRGGGBBB"} or @code{"#RRRRGGGGBBBB"}.
+components.  @var{String} should be in one of the following formats.
+@itemize
+@item A standard color name (per the Cascading Style Sheets standard).
+@item A hex value: 'RGB', 'RRGGBB', 'RRRGGGBBB', or 'RRRRGGGGBBBB'.
+@item An RGB color: 'rgb(R,G,B)' where R, G and B are decimal
+numbers between 0 and 255 inclusive or percentages.
+@item An RGBA color: 'rgba(R,G,B,A)' where R, G and B are numbers or
+percentages as above, and A is a floating point number between 0. and
+1. inclusive.
+@end itemize
+@end deffn
+
+@anchor{->color}
+@deffn Procedure ->color object operator
+Returns a color, else signals @code{error:wrong-type-argument} with
+@var{operator}.  @var{Object} should be a color, symbol or string.
+Symbols and strings are converted to colors by
+@bref{pango-color-parse}.
 @end deffn
 
 @node GNU Free Documentation License, , API Reference, Top