summaryrefslogtreecommitdiff
path: root/modules/gui/help/en_US/toolbar.xml
blob: d1e8254c594ba7188163fe8743c944455208c9ff (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
<?xml version="1.0" encoding="UTF-8"?>
<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="toolbar">
    <refnamediv>
        <refname>toolbar</refname>
        <refpurpose>show or hide a toolbar</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>state1=toolbar(winnum,state2)
            state1=toolbar(winnum)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>state1</term>
                <listitem>
                    <para>returns toolbar's state 'on' or 'off'</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>winum</term>
                <listitem>
                    <para>window's number (-1: Scilab console window)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>state2</term>
                <listitem>
                    <para>'on' or 'off' set toolbar's state</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>show or hide a toolbar.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
toolbar(-1,'off')
state=toolbar(-1,'on')

plot3d();
h=gcf();
toolbar(h.figure_id,'off')
 ]]></programlisting>
    </refsection>
</refentry>