summaryrefslogtreecommitdiff
path: root/modules/gui/help/en_US/toprint.xml
blob: 6bcc7c1e37d0e3f6d09f2670e15012bf464fd45b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Allan CORNET
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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="toprint">
    <refnamediv>
        <refname>toprint</refname>
        <refpurpose>Send text or figure to the printer.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>
            toprint(filename)
            toprint(linestoprint,pageheader)
            toprint(figid)
            toprint(figid,output)
            status = toprint(filename)
            status = toprint(linestoprint,pageheader)
            status = toprint(figid)
            status = toprint(figid,output)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>filename</term>
                <listitem>
                    <para>String: path of the text file to be printed.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>linestoprint</term>
                <listitem>
                    <para>String matrix: text to be printed, each entry is a line in printed pages.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>pageheader</term>
                <listitem>
                    <para>String: header of printed pages.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>figid</term>
                <listitem>
                    <para>Real: the id of the figure to be printed.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>output</term>
                <listitem>
                    <para>
                        String: printing output type, must be <emphasis>"pos"</emphasis> for PostScript or <emphasis>"gdi"</emphasis> for Bitmap format (<emphasis>"gdi"</emphasis> by default).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>status</term>
                <listitem>
                    <para>
                        Boolean: <emphasis>%T</emphasis> if the printing succeeds, <emphasis>%F</emphasis> otherwise.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Prints a text file, Scilab character strings or figure.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
toprint(SCI+"/etc/scilab.start");
toprint(['Test','toprint primitive'],'Scilab page header');
scf(4);
plot();
toprint(4);
toprint(4,"pos");
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="printfigure">printfigure</link>
            </member>
            <member>
                <link linkend="printsetupbox">printsetupbox</link>
            </member>
        </simplelist>
    </refsection>
</refentry>