add CDATA + role in the graphics module
[scilab.git] / scilab / modules / graphics / help / pt_BR / xclip.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
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 version="5.0-subset Scilab" xml:id="xclip" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate$</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>xclip</refname>
26
27     <refpurpose>Ajusta uma área de recorte</refpurpose>
28   </refnamediv>
29
30   <refsynopsisdiv>
31     <title>Seqüência de Chamamento</title>
32
33     <synopsis>xclip([x,y,w,h])
34 xclip(rect)
35 xclip("clipgrf")</synopsis>
36   </refsynopsisdiv>
37
38   <refsection>
39     <title>Parâmetros</title>
40
41     <variablelist>
42       <varlistentry>
43         <term>x,y,w,h</term>
44
45         <listitem>
46           <para>valores reais </para>
47         </listitem>
48       </varlistentry>
49
50       <varlistentry>
51         <term>rect</term>
52
53         <listitem>
54           <para>vetor linha de tamanho 4.</para>
55         </listitem>
56       </varlistentry>
57     </variablelist>
58   </refsection>
59
60   <refsection>
61     <title>Descrição</title>
62
63     <para><literal>xclip</literal> ajusta uma área de recorte dada pelas
64     coordenadas, na escala de gráficos corrente, do retângulo
65     <literal>x,y,w,h</literal> (ponto superior esquerdo, largura, altura).
66     Apenas um argumento dado significa a especificação do retângulo
67     <literal>rect=[x,y,w,h]</literal>.</para>
68
69     <para><literal>xclip("clipgrf")</literal> é usado para recortar as
70     fronteiras usuais de um retângulo.</para>
71
72     <para>Para desfazer o recorte, use o comando
73     <literal>xclip()</literal>.</para>
74
75     <para>A função <literal>xclip</literal> está obsoleta e será
76     permanentemente removida no Scilab 5.2. Para ajustar uma zona de recorte,
77     por favor, utilize as propriedades <literal>clip_state</literal> e
78     <literal>clip_box</literal> das entidade gráficas ao invés.</para>
79   </refsection>
80
81   <refsection>
82     <title>Exemplos</title>
83
84     <programlisting role="example"><![CDATA[ 
85 x=0:0.2:2*%pi;
86 x1=[sin(x);100*sin(x)];
87 y1=[cos(x);100*cos(x)];
88 y1=y1+20*ones(y1);
89
90 // ajustando a moldura
91 clf();a=gca();a.data_bounds=[-100 -100;500 600];
92     
93 // sem recorte
94 xsegs(10*x1+200*ones(x1),10*y1+200*ones(y1))
95 e=gce(); //manipulador da entidade Segs
96
97 // desenhando zona de recorte do retângulo
98 xrect(150,460,100,150)
99 // ajustando a propriedade clip_box para a entidade Segs
100 e.clip_box=[150,460,100,150];
101
102 // ajustando fronteiras usuais da zona de recorte do retângulo
103 e.clip_state='clipgrf';
104 xclip("clipgrf")
105 // removendo recorte
106 e.clip_state='off';
107  ]]></programlisting>
108   </refsection>
109
110   <refsection>
111     <title>Ver Também</title>
112
113     <simplelist type="inline">
114       <member><link linkend="axes_properties">axes_properties</link></member>
115     </simplelist>
116   </refsection>
117
118   <refsection>
119     <title>Autor</title>
120
121     <para>J.Ph.C.</para>
122   </refsection>
123 </refentry>