xset: help page only 'fpf' + equivalences
[scilab.git] / scilab / modules / graphics / help / pt_BR / xset.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) ENPC - Jean-Philippe Chancelier
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
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:ns5="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="xset" xml:lang="pt">
20     <refnamediv>
21         <refname>xset</refname>
22         <refpurpose>ajusta valores para o contexto gráfico. Função obsoleta
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Seqüência de Chamamento</title>
27         <synopsis>
28             xset(choice-name,x1,x2,x3,x4,x5)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Parâmetros</title>
33         <variablelist>
34             <varlistentry>
35                 <term>choice-name</term>
36                 <listitem>
37                     <para>string</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>x1,...,x5</term>
42                 <listitem>
43                     <para>
44                         dependem de <literal>choice-name</literal>
45                     </para>
46                 </listitem>
47             </varlistentry>
48         </variablelist>
49     </refsection>
50     <refsection>
51         <title>Descrição</title>
52         <warning>
53             <emphasis role="bold">Está função está obsoleta.</emphasis>
54             Utilize a representação de objetos do Scilab ao invés (ver as documentações das funções
55             <link linkend="set">set</link> e <link linkend="get">get</link> bem como a
56             página <link linkend="graphics_entities">graphics_entities</link>).
57         </warning>
58         <para>
59             <literal>xset</literal> é utilizado para ajustar valores padrões do
60             contexto da janela de gráficos corrente.
61         </para>
62         <variablelist>
63             <varlistentry>
64                 <term>xset("fpf",string)</term>
65                 <listitem>
66                     <para>ajusta o formato de exibição de ponto flutuante para funções
67                         de contorno. <literal>string</literal> é um string fornecendo o
68                         formato em sintaxe C (por exemplo <literal>string="%.3f"</literal>).
69                         Use <literal>string=""</literal> para retornar ao formato
70                         padrão.
71                     </para>
72                 </listitem>
73             </varlistentry>
74         </variablelist>
75         <refsect2>
76             <title>Replacements</title>
77             <para>
78             <literal>xset(..)</literal> returned nothing. Please take care appending a semi-colon
79             after replacement instructions in order to cancel the display of their output.
80             </para>
81         <screen><![CDATA[
82 // SCILAB 3 & 4                 SCILAB N>4
83 // ------------                 ----------
84 xset("default")                 clf("reset")
85
86 xset("wpos", [x y])             gcf().figure_position = [x y];
87 xset("wpdim", w, h)             gcf().figure_size = [w h];
88 xset("wdim", w, h)              gcf().figure_size = [w h];
89 xset("wresize", 0|1)  HS        gcf().auto_resize = "off"|"on";
90 xset("colormap", CM)            gcf().color_map = CM;
91 xset("figure", i)               scf(i);
92 xset("window", i)               scf(i);
93 xset("viewport", xp,yp)         gcf().viewport = [xp yp];
94
95 xset("auto clear","on"|"off")   gca().auto_clear = "on"|"off";
96 xset("line mode", 0|1)          gca().line_mode = "off"|"on";
97 xset("line style", n)           gca().line_style = n;
98 xset("dashes", n)               gca().line_style = n;
99 xset("thickness", n)            gca().thickness = n;
100 xset("font size", s)            gca().font_size = s;
101 xset("font", id, fsize)         set(gca(), "font_style", id, "font_size", fsize);
102 xset("mark size", msize)        set(gca(), "mark_size_unit", "tabulated", "mark_size", msize);
103 xset("mark", id, msize)         set(gca(), "mark_style", id, "mark_size_unit", "tabulated", "mark_size", msize);
104 xset("color", icol)             gca().foreground = icol;
105 xset("color", 0)                gca().foreground = -1;
106 xset("pattern", icol)           gca().foreground = icol;
107 xset("pattern", 0)              gca().foreground = -1;
108 xset("foreground", icol)        gca().foreground = icol;
109 xset("background", icol)        gca().background = icol;
110 xset("hidden3d", icol)          gca().hiddencolor = icol;
111
112 xset("clipping", rect)          set(gca(), "clip_box", rect, "clip_state", "on");
113 xset("clipgrf")                 gca().clip_state = "clipgrf";
114 xset("clipoff")                 gca().clip_state = "off";
115
116 xset("alufunction",i)           gcf().pixel_drawing_mode = str(i);
117                                 #i   str(i)
118                                 --   ------
119                                 0 => "clear"
120                                 1 => "and"
121                                 2 => "andReverse"
122                                 3 => "copy"
123                                 4 => "andInverted"
124                                 5 => "noop"
125                                 6 => "xor"
126                                 7 => "or"
127                                 8 => "nor"
128                                 9 => "equiv"
129                                 10 => "invert"
130                                 11 => "orReverse"
131                                 12 => "copyInverted"
132                                 13 => "orInverted"
133                                 14 => "nand"
134                                 15 => "set"
135 ]]></screen>
136         </refsect2>
137     </refsection>
138     <refsection role="see also">
139         <title>Ver Também</title>
140         <simplelist type="inline">
141             <member>
142                 <link linkend="xget">xget</link>
143             </member>
144             <member>
145                 <link linkend="set">set</link>
146             </member>
147             <member>
148                 <link linkend="graphics_entities">graphics entities</link>
149             </member>
150             <member>
151                 <link linkend="gcf">gcf</link>
152             </member>
153             <member>
154                 <link linkend="gdf">gdf</link>
155             </member>
156             <member>
157                 <link linkend="gca">gca</link>
158             </member>
159             <member>
160                 <link linkend="gda">gda</link>
161             </member>
162             <member>
163                 <link linkend="ged">ged</link>
164             </member>
165             <member>
166                 <link linkend="getcolor">getcolor</link>
167             </member>
168         </simplelist>
169     </refsection>
170     <refsection>
171         <title>History</title>
172         <revhistory>
173             <revision>
174                 <revnumber>5.0.1</revnumber>
175                 <revremark>
176                     The <literal>.alufunction</literal> property is obsolete. It is no longer
177                     taken into account for graphical renderings. It is replaced with
178                     <literal>gcf().pixel_drawing_mode</literal>.
179                 </revremark>
180             </revision>
181             <revision>
182                 <revnumber>5.4.0</revnumber>
183                 <revremark>
184                     The <literal>"alufunction"</literal> is no longer supported..
185                 </revremark>
186             </revision>
187             <revision>
188                 <revnumber>6.0.0</revnumber>
189                 <revremark>
190                     The only <literal>xset("fpf", format)</literal> syntax is now supported.
191                 </revremark>
192             </revision>
193         </revhistory>
194     </refsection>
195 </refentry>