[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / gui / help / en_US / close.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="close">
3     <refnamediv>
4         <refname>close</refname>
5         <refpurpose>closes graphic figures, progressionbars or waitbars</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>
10             close
11             close(H)
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection role="parameters">
15         <title>Arguments</title>
16         <variablelist>
17             <varlistentry>
18                 <term>H</term>
19                 <listitem>
20                     <para>Handle or vector of handles of graphic figures or progression bar
21                         or wait bar. These different types of handles can be mixed in <varname>H</varname>.
22                     </para>
23                     <para>
24                         By default, the current graphic figure is considered.
25                     </para>
26                 </listitem>
27             </varlistentry>
28         </variablelist>
29     </refsection>
30     <refsection role="description">
31         <title>Description</title>
32         <para>Graphic windows based on the Tk technology (such as still used by imshow() in the SIVP
33             external module) may be closed as well by providing their number that is their handle.
34         </para>
35     </refsection>
36     <refsection role="examples">
37         <title>Examples</title>
38         <programlisting role="example"><![CDATA[
39 // creates  figure number 1.
40 h = scf();
41 // put a clever text in figure 1
42 uicontrol( h, 'style','text', ...
43               'string','scilab is great', ...
44               'position',[50 70 100 100], ...
45               'fontsize',15);
46 // create figure 2
47 scf();
48 // put a text in figure 2
49 uicontrol( 'style','text', ...
50            'string','Really great', 'position',[50 70 100 100], 'fontsize',15);
51
52 close();   // close the current graphic window (ie fig. 2)
53 close(h);  // close figure 1
54
55 // create a progression bar
56 wid1=progressionbar("Message");
57 // close it
58 close(wid1);
59  ]]></programlisting>
60     </refsection>
61     <refsection role="see also">
62         <title>See also</title>
63         <simplelist type="inline">
64             <member>
65                 <link linkend="xdel">xdel</link>
66             </member>
67             <member>
68                 <link linkend="delete">delete</link>
69             </member>
70             <member>
71                 <link linkend="figure">figure</link>
72             </member>
73             <member>
74                 <link linkend="scf">scf</link>
75             </member>
76             <member>
77                 <link linkend="gcf">gcf</link>
78             </member>
79         </simplelist>
80     </refsection>
81 </refentry>