summaryrefslogtreecommitdiff
path: root/modules/gui/help/en_US/unsetmenu.xml
blob: c45e9e0e7cb105cd998615dc0d05d8419c8e9a00 (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
<?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="unsetmenu">
    <refnamediv>
        <refname>unsetmenu</refname>
        <refpurpose>interactive button or menu or submenu de-activation</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>unsetmenu(button,[nsub])
            unsetmenu(gwin,button,[nsub])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>button</term>
                <listitem>
                    <para>a character string. The button name</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>gwin</term>
                <listitem>
                    <para>integer. The number of graphic window where the button is installed</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>nsub</term>
                <listitem>
                    <para>
                        integer. The number of submenu to de-activate (if any). If button has no sub-menu, <literal>nsub</literal> is ignored
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The function allows the user to deactivate  buttons or menus created by
            <literal>addmenu</literal> in the main or graphics windows command panels.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
addmenu('foo')
unsetmenu('foo')
unsetmenu(gettext("File"), 3)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="delmenu">delmenu</link>
            </member>
            <member>
                <link linkend="setmenu">setmenu</link>
            </member>
            <member>
                <link linkend="addmenu">addmenu</link>
            </member>
        </simplelist>
    </refsection>
</refentry>