Fix all the formatting of xml files
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / getcolor.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="getcolor">
14     <refnamediv>
15         <refname>getcolor</refname>
16         <refpurpose>opens a dialog to show colors in the current colormap</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>c=getcolor(title,[cini])
21             c=getcolor()
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>title</term>
29                 <listitem>
30                     <para>string, dialog title.</para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>cini</term>
35                 <listitem>
36                     <para>initial selected color id. Default value is 1.</para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>c</term>
41                 <listitem>
42                     <para>selected color id or [] if the selection is cancelled.</para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46     </refsection>
47     <refsection>
48         <title>Description</title>
49         <para>
50             <literal>getcolor</literal> opens a window displaying the palette of the current colormap. 
51             The user can click on a color to show its id and RGB values.
52             <literal>getcolor</literal> returns the id of the selected color or [] if the "Cancel" button has been clicked or the window closed.
53         </para>
54     </refsection>
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[
58 getcolor();
59
60 getcolor("Title foo");
61
62 getcolor("foo",21); // Select the red
63  ]]></programlisting>
64     </refsection>
65     
66     <refsection role="see also">
67         <title>See Also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="color">color</link>
71             </member>
72             <member>
73                 <link linkend="colormap">colormap</link>
74             </member>
75             <member>
76                 <link linkend="getmark">getmark</link>
77             </member>
78             <member>
79                 <link linkend="getfont">getfont</link>
80             </member>
81         </simplelist>
82     </refsection>
83 </refentry>