[doc] uigetcolor() and colormap pages illustrated
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / uigetcolor.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
4           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
5           xml:lang="en" xml:id="uigetcolor">
6     <refnamediv>
7         <refname>uigetcolor</refname>
8         <refpurpose>Opens a dialog for selecting a color.</refpurpose>
9     </refnamediv>
10     <refsynopsisdiv>
11         <title>Syntax</title>
12         <synopsis>
13             uigetcolor()
14
15             RGB = uigetcolor()
16             RGB = uigetcolor(defaultRGB)
17             RGB = uigetcolor(defaultRed, defaultGreen, defaultBlue)
18             RGB = uigetcolor(title, ..)
19
20             [R, G, B] = uigetcolor()
21             [R, G, B] = uigetcolor(defaultRGB)
22             [R, G, B] = uigetcolor(defaultRed, defaultGreen, defaultBlue)
23             [R, G, B] = uigetcolor(title, ..)
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Arguments</title>
28         <variablelist>
29             <varlistentry>
30                 <term>title</term>
31                 <listitem>
32                     <para>
33                         String: Optional argument, the title to display in the dialog.
34                         Default value is "Color Chooser".
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>defaultRGB</term>
40                 <listitem>
41                     <para>
42                         1x3 vector [red, green, blue] of default values in [0, 255] for Red, Green
43                         and Blue intensities.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>defaultRed, defaultGreen, defaultBlue</term>
49                 <listitem>
50                     <para>
51                         Integers in [0, 255]: Scalar default values for Red, Green, and Blue
52                         intensities.
53                     </para>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>RGB</term>
58                 <listitem>
59                     <para>
60                         1x3 vector [red, green, blue] of values in [0, 255] for Red, Green and Blue
61                         intensities, or [] if the user cancels.
62                     </para>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>R, G, B</term>
67                 <listitem>
68                     <para>
69                         Integers in [0, 255]: Scalar values for Red, Green and Blue intensities,
70                         or [] if the user cancels.
71                     </para>
72                 </listitem>
73             </varlistentry>
74         </variablelist>
75     </refsection>
76     <refsection>
77         <title>Description</title>
78         <para>
79             Creates a dialog window for selecting a color. All (default and returned) values are
80             in the interval [0 255].
81         </para>
82     </refsection>
83     <refsection>
84         <title>Examples</title>
85         <programlisting role="example"><![CDATA[
86 uigetcolor()
87 [R, G, B] = uigetcolor([255 128 0])
88 RBG = uigetcolor(0, 128, 255)
89 RBG = uigetcolor("My color chooser", 250, 150, 50)
90      ]]></programlisting>
91         <para/>
92         <inlinemediaobject>
93             <imageobject>
94                 <imagedata fileref="../../images/uigetcolor_1.png"/>
95             </imageobject>
96             <para/>
97             <imageobject>
98                 <imagedata fileref="../../images/uigetcolor_RGB.png"/>
99             </imageobject>
100         </inlinemediaobject>
101     </refsection>
102     <refsection role="see also">
103         <title>See also</title>
104         <simplelist type="inline">
105             <member>
106                 <link linkend="getcolor">getcolor</link>
107             </member>
108         </simplelist>
109     </refsection>
110 </refentry>