a1b16da3992f89a2506329a3d6d0aa281af80cb7
[scilab.git] / scilab / modules / graphics / help / pt_BR / property / set.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 - Djalel Abdemouche
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" 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="set" xml:lang="pt">
17     <refnamediv>
18         <refname>set</refname>
19         <refpurpose>Ajusta um valor de propriedade de uma objeto entidade gráfica
20             ou de um objeto Interface do Usuário (User Interface)
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Seqüência de Chamamento</title>
25         <synopsis>set(prop,val)
26             set(h,prop)
27             set(h,prop,val)
28             h.prop=val
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Parâmetros</title>
33         <variablelist>
34             <varlistentry>
35                 <term>h</term>
36                 <listitem>
37                     <para>manipulador da entidade da qual a propriedade nomeada se
38                         deseja ajustar, <literal>h</literal> pode ser um vetor de
39                         manipuladores, em tal caso, serão ajustados valores de propriedades
40                         para todos os objetos identificados por h
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>prop</term>
46                 <listitem>
47                     <para>string, nome da propriedade a ser ajustada. </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>val</term>
52                 <listitem>
53                     <para>valor a ser dado à propriedade</para>
54                 </listitem>
55             </varlistentry>
56         </variablelist>
57     </refsection>
58     <refsection>
59         <title>Descrição</title>
60         <para>Esta rotina pode ser utilizada para se recuperar o valor de uma
61             propriedade especificada de uma entidade de gráficos ou objeto GUI. Neste
62             caso, é equivalente a se usar o operador ponto ('.') em um manipulador.
63             Por exemplo, <literal>set(h,"background",5)</literal> é equivalente a
64             <literal>h.background = 5</literal>.
65         </para>
66         <para>Nomes de propriedades são strings. O tipo do valor ajustado dependo
67             do tipo do manipulador e da propriedade.
68         </para>
69         <para>
70             Para obter a lista de todas as propriedade existentes ver <link linkend="graphics_entities">graphics_entities</link> ou <link linkend="uicontrol">uicontrol</link> para objetos de Interface do
71             Usuário
72         </para>
73         <para>
74             <literal>set</literal> também pode ser chamado com apenas uma
75             propriedade como argumento. Neste caso, a propriedade deve ser uma das
76             seguintes:
77         </para>
78         <variablelist>
79             <varlistentry>
80                 <term>current_entity or hdl</term>
81                 <listitem>
82                     <para>
83                         <literal>set('current_entity',h)</literal> ou
84                         <literal>set('hdl',h)</literal> ajusta uma nova entidade como a
85                         corrente. Neste caso, o valor deve ser um manipulador
86                         gráfico.
87                     </para>
88                 </listitem>
89             </varlistentry>
90             <varlistentry>
91                 <term>current_figure</term>
92                 <listitem>
93                     <para>
94                         <literal>set('current_figure',fig)</literal> ajusta uma nova
95                         figura como a corrente. É equivalente a <link linkend="scf">scf</link>. Neste caso, o valor deve ser um
96                         manipulador FIgure.
97                     </para>
98                 </listitem>
99             </varlistentry>
100             <varlistentry>
101                 <term>current_axes</term>
102                 <listitem>
103                     <para>
104                         <literal>set('current_axes',axes)</literal> ajusta novos
105                         eixos como os correntes. É equivalente a <link linkend="sca">sca</link>. Neste caso, o valor deve ser um
106                         manipulador Axes.
107                     </para>
108                 </listitem>
109             </varlistentry>
110         </variablelist>
111         <para>
112             <literal>set</literal> também pode ser chamado com manipuladores
113             gráficos e com propriedades como argumentos. O manipulador deve ser de uma
114             figura padrão ou de eixos padrões. A propriedade deve ser
115             <literal>"default_values"</literal>. Neste caso, a entidade padrão é
116             reajustada para os valores que possuía na inicialização do Scilab.
117             <literal>set("default_values",h)</literal> equivale a <link linkend="sda">sda</link> ou <link linkend="sdf">sdf</link>.
118         </para>
119     </refsection>
120     <refsection>
121         <title>Exemplos</title>
122         <programlisting role="example"><![CDATA[
123 clf()
124 set("auto_clear","off") ;
125 // Exemple of a Plot 2D
126 x=[-.2:0.1:2*%pi]';
127 plot2d(x-.3,[sin(x-1) cos(2*x)],[1 2] );
128 a=get("current_axes");
129 p1=a.children.children(1);
130 p2=a.children.children(2);
131 // ajustando as propriedades nomeadas para os valores especificados nos objetos
132 set(p2,"foreground",13);
133 set(p2,"polyline_style",2);
134 set(a,'tight_limits',"on");
135 set(a,"box","off");
136 set(a,"sub_tics",[ 7 0 ]);
137 set(a,"y_location","middle")
138 set(p2,'thickness',2);
139 set(p1,'mark_mode',"on");
140 set(p1,'mark_style',3);
141 plot2d(x-2,x.^2/20);
142 p3= a.children(1).children;
143 set([a p1 p2 p3],"foreground",5)
144  ]]></programlisting>
145     </refsection>
146     <refsection>
147         <title>Ver Também </title>
148         <simplelist type="inline">
149             <member>
150                 <link linkend="get">get</link>
151             </member>
152             <member>
153                 <link linkend="delete">delete</link>
154             </member>
155             <member>
156                 <link linkend="copy">copy</link>
157             </member>
158             <member>
159                 <link linkend="move">move</link>
160             </member>
161             <member>
162                 <link linkend="graphics_entities">graphics_entities</link>
163             </member>
164             <member>
165                 <link linkend="uicontrol">uicontrol</link>
166             </member>
167         </simplelist>
168     </refsection>
169 </refentry>