[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / gui / help / en_US / printfigure.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) 2008 - INRIA - Vincent COUVERT
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: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="printfigure">
17     <refnamediv>
18         <refname>printfigure</refname>
19         <refpurpose>Opens a printing dialog and prints a figure.</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             printfigure(figid)
25             status = printfigure(figid)
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>figid</term>
33                 <listitem>
34                     <para>Real: the id of the figure to be printed.</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>status</term>
39                 <listitem>
40                     <para>
41                         Boolean: <emphasis>%T</emphasis> if the printing succeeds, <emphasis>%F</emphasis> otherwise.
42                     </para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46     </refsection>
47     <refsection>
48         <title>Description</title>
49         <para>This function opens a dialog to select a printer, printing options... and then prints the figure.</para>
50     </refsection>
51     <refsection>
52         <title>Examples</title>
53         <programlisting role="example"><![CDATA[
54 plot2d();
55 printfigure(get(gcf(), "figure_id"));
56  ]]></programlisting>
57     </refsection>
58     <refsection role="see also">
59         <title>See also</title>
60         <simplelist type="inline">
61             <member>
62                 <link linkend="toprint">toprint</link>
63             </member>
64             <member>
65                 <link linkend="printsetupbox">printsetupbox</link>
66             </member>
67         </simplelist>
68     </refsection>
69 </refentry>