xset: help page only 'fpf' + equivalences
[scilab.git] / scilab / modules / graphics / help / pt_BR / xset.xml
index 43b8613..63b2ae8 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) ENPC - Jean-Philippe Chancelier
  * along with this program.
  *
  -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xset" xml:lang="pt">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
+    xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
+    xmlns:scilab="http://www.scilab.org" xml:id="xset" xml:lang="pt">
     <refnamediv>
         <refname>xset</refname>
-        <refpurpose>ajusta valores para o contexto gráfico. Função
-            obsoleta
+        <refpurpose>ajusta valores para o contexto gráfico. Função obsoleta
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Seqüência de Chamamento</title>
-        <synopsis>xset(choice-name,x1,x2,x3,x4,x5)
-            xset()
+        <synopsis>
+            xset(choice-name,x1,x2,x3,x4,x5)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
     </refsection>
     <refsection>
         <title>Descrição</title>
-        <para>Aviso: está função está obsoleta. Utilize a representação de objetos
-            do Scilab ao invés (ver as documentações das funções <link linkend="set">set</link> e <link linkend="get">get</link> bem como a
+        <warning>
+            <emphasis role="bold">Está função está obsoleta.</emphasis>
+            Utilize a representação de objetos do Scilab ao invés (ver as documentações das funções
+            <link linkend="set">set</link> e <link linkend="get">get</link> bem como a
             página <link linkend="graphics_entities">graphics_entities</link>).
-        </para>
+        </warning>
         <para>
             <literal>xset</literal> é utilizado para ajustar valores padrões do
             contexto da janela de gráficos corrente.
         </para>
-        <para>Quando chamado sem argumento, um menu de escolha é criado exibindo
-            os valores correntes e mudanças podem ser realizadas através e botões de
-            escolha.
-        </para>
-        <para>
-            Use <literal>xset()</literal> para exibir ou ajustar a cor corrente,
-            marca e fontes utilizadas.
-        </para>
-        <para/>
         <variablelist>
             <varlistentry>
-                <term>xset("alufunction",number)</term>
-                <listitem>
-                    <para>usado para ajustar a função lógica para desenho. A função
-                        lógica utilizada é ajustada por <literal>x1</literal>. Os valores
-                        usuais são: 3 para cópia (padrão), 6 para animação e 0 para limpeza.
-                        Ver alufunctions para mais detalhes.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("auto clear","on"|"off")</term>
-                <listitem>
-                    <para>alterna o modo de limpeza automática para gráficos entre "on"
-                        e "off" . Quando o modo de limpeza automática é "on", esboços
-                        sucessivos não são superpostos, ie, uma operação
-                        <literal>clf()</literal> (a janela de gráficos é limpa e os
-                        gráficos gravados associados são apagados) é realizada antes de cada
-                        função gráfica de alto-nível. O valor padrão é "off".
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("background",color)</term>
-                <listitem>
-                    <para>ajusta a cor de plano de fundo do objeto Axes corrente. O
-                        argumento <literal>color</literal> é um índice no mapa de cores da
-                        cor a ser utilizada.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("clipping",x,y,w,h)</term>
-                <listitem>
-                    <para>ajusta a zona de recorte (a zona da janela de gráficos onde os
-                        esboços podem ser desenhados) como sendo o retângulo (x,y,w,h)
-                        (ponto superior esquerdo, largura, altura). Esta função utiliza a
-                        utiliza as coordenadas correntes do esboço.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("color",value)</term>
-                <listitem>
-                    <para>ajusta a cor padrão para funções de preechimento, linha ou
-                        impressão de textos. <literal>value</literal> é um inteiro projetado
-                        no intervalo [0,whiteid]. 0 é usado para preenchimento com preto e
-                        whiteid para preenchimento com branco. O valor do identificador do
-                        branco pode ser obtido através de
-                        <literal>xget("white")</literal>.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("colormap",cmap)</term>
-                <listitem>
-                    <para>ajusta o mapa de cores como sendo uma matriz m x 3. m é o
-                        número de cores. A cor de número i é dada como sendo a tripla
-                        cmap(i,1), cmap(i,2), cmap(i,3) correspondentes respectivamente às
-                        intensidades de vermelho, verde e azul entre 0 e 1.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("dashes",i)</term>
-                <listitem>
-                    <para>
-                        no modo preto e branco (<literal>xset("use
-                            color",0)
-                        </literal>
-                        ), ajusta o estilo de tracejado como o estilo i
-                        (0 para linha sólida). No modo colorido (<literal>xset("use color",1
-                            )
-                        </literal>
-                        )é utilizado para ajustar a cor da linha, da marca e do
-                        texto. Esta palavra-chave está obsoleta, utilize
-                        <literal>xset('color',i)</literal> ou <literal>xset('line
-                            style',i)
-                        </literal>
-                        ao invés.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("default")</term>
-                <listitem>
-                    <para>reajusta o contexto gráfico para valores padrões.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("font",fontid,fontsize)</term>
-                <listitem>
-                    <para>ajusta a fonte corrente e seu tamanho. Note que
-                        <literal>fontsize</literal> se aplica a todas as fontes, não só a
-                        <literal>fontid</literal> .
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("font size",fontsize)</term>
-                <listitem>
-                    <para>ajusta o tamanho da fonte.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("foreground",color)</term>
-                <listitem>
-                    <para>ajusta a cor de primeiro plano do objeto Axes corrente. O
-                        argumento <literal>color</literal> é um índice no mapa de cores da
-                        cor a ser utilizada.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
                 <term>xset("fpf",string)</term>
                 <listitem>
                     <para>ajusta o formato de exibição de ponto flutuante para funções
                     </para>
                 </listitem>
             </varlistentry>
-            <varlistentry>
-                <term>xset("hidden3d",colorid)</term>
-                <listitem>
-                    <para>ajusta o número de cor para as faces escondidas em um
-                        <literal>plot3d. colorid=0</literal> suprime o desenho de faces
-                        escondidas de objetos 3d. Isto é tecnicamente chamdo 'culling' e
-                        acelera a renderização de superfícies fechadas.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("line mode",type)</term>
-                <listitem>
-                    <para>esta função é utilizada para se ajustar o modo de desenho da
-                        linha. O modo absoluto é ajustado com type= 1 e o modo relativo com
-                        type=0. (aviso: o modo type= 0 possui defeitos)
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("line style",value)</term>
-                <listitem>
-                    <para>ajusta o estilo de linha corrente (1: sólida, &gt;1 estilos
-                        tracejados).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("mark",markid,marksize)</term>
-                <listitem>
-                    <para>ajusta a marca corrente e seu tamanho. Use
-                        <literal>xset()</literal> para visualizar as marcas. Note que
-                        <literal>marksize</literal> se aplica a todas as marcas, não apenas
-                        a <literal>markid</literal> .
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("mark size",marksize)</term>
-                <listitem>
-                    <para>ajusta o tamanho da marca.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("pattern",value)</term>
-                <listitem>
-                    <para>ajusta o padrão (pattern, não confundir com padrão = default)
-                        corrente para funções de preenchimento. O valor é um inteiro
-                        projetado no intervalo [0,whiteid]. 0 é utilizado para preenchimento
-                        com preto e whiteid para preenchimento com branco. O valor de
-                        whiteid pode ser obtido com <literal>xget("white")</literal>.
-                        "pattern" é equivalente a "color".
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("thickness",value)</term>
-                <listitem>
-                    <para>ajusta o valor de espessura das linhas em pixel (0 e 1 têm o
-                        mesmo significado: 1 pixel de espessura).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("use color",flag)</term>
-                <listitem>
-                    <para>
-                        se flag=1, então <literal>xset("pattern",.)</literal> ou
-                        <literal>xset("dashes",.)</literal> será utilizado de modo a
-                        modificar a cor padrão para desenho ou para padrões de
-                        preenchimento. Se flag=0 então retorna-se ao modo de escalas de
-                        cinza e tracejados.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("viewport",x,y)</term>
-                <listitem>
-                    <para>ajusta a posição do cursor.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("wdim",width,height)</term>
-                <listitem>
-                    <para>ajusta a largura e altura da janela de gráficos corrente. Esta
-                        opção não é utilizada pelo driver Postscript.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("wpdim",width,height)</term>
-                <listitem>
-                    <para>ajusta a largura e altura da janela de gráficos física
-                        corrente (que pode ser diferente do tamanho atual no modo wresize
-                        1). Esta opção não é utilizada pelo driver Postscript.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("window",window-number)</term>
-                <listitem>
-                    <para>
-                        ajusta a janela <literal>window-number</literal> como sendo a
-                        janela corrente e cria a janela se esta não existir.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("wpos",[x,y])</term>
-                <listitem>
-                    <para>ajusta a posição do ponto superior esquerdo da janela de
-                        gráficos.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xset("wresize",flag)</term>
-                <listitem>
-                    <para>se flag= 1então o gráfico é automaticamente redimensionado
-                        para preencher a janela de gráficos.
-                    </para>
-                    <programlisting role=""><![CDATA[
-xdel();
-xset("wresize",1);
-plot2d();
-xset("wdim",1000,500)
- ]]></programlisting>
-                    <para>Se flag=0 a escala do gráfico é inalterada quando a janela de
-                        gráfico é redimensionada. O cursor no canto superior esquerdo ou as
-                        setas do teclado podem ser utilizadas para rolar o gráfico .
-                    </para>
-                    <programlisting role=""><![CDATA[
-xdel();
-plot2d();
-xset("wresize",0);
-xset("wdim",1000,500)
- ]]></programlisting>
-                </listitem>
-            </varlistentry>
         </variablelist>
+        <refsect2>
+            <title>Replacements</title>
+            <para>
+            <literal>xset(..)</literal> returned nothing. Please take care appending a semi-colon
+            after replacement instructions in order to cancel the display of their output.
+            </para>
+        <screen><![CDATA[
+// SCILAB 3 & 4                 SCILAB N>4
+// ------------                 ----------
+xset("default")                 clf("reset")
+
+xset("wpos", [x y])             gcf().figure_position = [x y];
+xset("wpdim", w, h)             gcf().figure_size = [w h];
+xset("wdim", w, h)              gcf().figure_size = [w h];
+xset("wresize", 0|1)  HS        gcf().auto_resize = "off"|"on";
+xset("colormap", CM)            gcf().color_map = CM;
+xset("figure", i)               scf(i);
+xset("window", i)               scf(i);
+xset("viewport", xp,yp)         gcf().viewport = [xp yp];
+
+xset("auto clear","on"|"off")   gca().auto_clear = "on"|"off";
+xset("line mode", 0|1)          gca().line_mode = "off"|"on";
+xset("line style", n)           gca().line_style = n;
+xset("dashes", n)               gca().line_style = n;
+xset("thickness", n)            gca().thickness = n;
+xset("font size", s)            gca().font_size = s;
+xset("font", id, fsize)         set(gca(), "font_style", id, "font_size", fsize);
+xset("mark size", msize)        set(gca(), "mark_size_unit", "tabulated", "mark_size", msize);
+xset("mark", id, msize)         set(gca(), "mark_style", id, "mark_size_unit", "tabulated", "mark_size", msize);
+xset("color", icol)             gca().foreground = icol;
+xset("color", 0)                gca().foreground = -1;
+xset("pattern", icol)           gca().foreground = icol;
+xset("pattern", 0)              gca().foreground = -1;
+xset("foreground", icol)        gca().foreground = icol;
+xset("background", icol)        gca().background = icol;
+xset("hidden3d", icol)          gca().hiddencolor = icol;
+
+xset("clipping", rect)          set(gca(), "clip_box", rect, "clip_state", "on");
+xset("clipgrf")                 gca().clip_state = "clipgrf";
+xset("clipoff")                 gca().clip_state = "off";
+
+xset("alufunction",i)           gcf().pixel_drawing_mode = str(i);
+                                #i   str(i)
+                                --   ------
+                                0 => "clear"
+                                1 => "and"
+                                2 => "andReverse"
+                                3 => "copy"
+                                4 => "andInverted"
+                                5 => "noop"
+                                6 => "xor"
+                                7 => "or"
+                                8 => "nor"
+                                9 => "equiv"
+                                10 => "invert"
+                                11 => "orReverse"
+                                12 => "copyInverted"
+                                13 => "orInverted"
+                                14 => "nand"
+                                15 => "set"
+]]></screen>
+        </refsect2>
     </refsection>
     <refsection role="see also">
         <title>Ver Também</title>
@@ -337,17 +142,54 @@ xset("wdim",1000,500)
                 <link linkend="xget">xget</link>
             </member>
             <member>
-                <link linkend="getcolor">getcolor</link>
+                <link linkend="set">set</link>
             </member>
             <member>
-                <link linkend="ged">ged</link>
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
             <member>
-                <link linkend="set">set</link>
+                <link linkend="gcf">gcf</link>
+            </member>
+            <member>
+                <link linkend="gdf">gdf</link>
+            </member>
+            <member>
+                <link linkend="gca">gca</link>
             </member>
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="gda">gda</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="getcolor">getcolor</link>
             </member>
         </simplelist>
     </refsection>
-</refentry>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.0.1</revnumber>
+                <revremark>
+                    The <literal>.alufunction</literal> property is obsolete. It is no longer
+                    taken into account for graphical renderings. It is replaced with
+                    <literal>gcf().pixel_drawing_mode</literal>.
+                </revremark>
+            </revision>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>
+                    The <literal>"alufunction"</literal> is no longer supported..
+                </revremark>
+            </revision>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revremark>
+                    The only <literal>xset("fpf", format)</literal> syntax is now supported.
+                </revremark>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>
\ No newline at end of file