* Bug 16638 fixed: getcolor() rendering debugged
[scilab.git] / scilab / modules / graphics / help / pt_BR / 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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2021 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="getcolor" xml:lang="pt">
20     <refnamediv>
21         <refname>getcolor</refname>
22         <refpurpose>abre um diálogo que exibe as cores no mapa de cores atual ou padrão
23             corrente
24         </refpurpose>
25     </refnamediv>
26     <refsynopsisdiv>
27         <title>Seqüência de Chamamento</title>
28         <synopsis>
29             c = getcolor()
30             c = getcolor(title)
31             c = getcolor(title, cini)
32         </synopsis>
33     </refsynopsisdiv>
34     <refsection>
35         <title>Parâmetros</title>
36         <variablelist>
37             <varlistentry>
38                 <term>title</term>
39                 <listitem>
40                     <para>string, o título do diálogo</para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>cini</term>
45                 <listitem>
46                     <para>número da cor selecionada inicial. O valor padrão é 1.
47                     </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>c</term>
52                 <listitem>
53                     <para>número da cor selecionada, ou [] se o usuário tiver
54                         clicado no botão "Cancel" (cancelar).
55                     </para>
56                 </listitem>
57             </varlistentry>
58         </variablelist>
59     </refsection>
60     <refsection>
61         <title>Descrição</title>
62         <para>
63             <literal>getcolor</literal> abre uma janela que exibe o palete do mapa
64             de cores corrente o padrão. O usuário pode clicar numa cor para exibir seu
65             número e valores RGB. <literal>getcolor</literal> retorna o
66             número da cor selecionada, ou [] se o usuário clicar no botão "Cancel".
67         </para>
68     </refsection>
69     <refsection>
70         <title>Exemplos</title>
71         <programlisting role="example"><![CDATA[
72 c = getcolor();
73
74 c = getcolor("Title foo", color("red")); // preselects the red
75
76 c = getcolor("Please choose a color");
77      ]]></programlisting>
78         <para/>
79         <inlinemediaobject>
80             <imageobject>
81                 <imagedata fileref="../../images/getcolor.png"/>
82             </imageobject>
83         </inlinemediaobject>
84         <para/>
85         <screen><![CDATA[
86 --> c = getcolor("Please choose a color")
87  c  =
88    28.
89 ]]></screen>
90     </refsection>
91     <refsection role="see also">
92         <title>Ver Também</title>
93         <simplelist type="inline">
94             <member>
95                 <link linkend="uigetcolor">uigetcolor</link>
96             </member>
97             <member>
98                 <link linkend="color_list">color_list</link>
99             </member>
100             <member>
101                 <link linkend="color">color</link>
102             </member>
103             <member>
104                 <link linkend="colormap">colormap</link>
105             </member>
106         </simplelist>
107     </refsection>
108 </refentry>