modules/gui/help/en_US/delmenu.xml


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

<?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="delmenu">
    <refnamediv>
        <refname>delmenu</refname>
        <refpurpose>interactive button or menu deletion</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>delmenu(button)
            delmenu(gwin,button)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>button</term>
                <listitem>
                    <para>a character string. The button name. On Windows operating systems (not X_window), an &amp; should be placed before the character in the name used for keyboard shortcut; this character is underlined on the GUI.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>gwin</term>
                <listitem>
                    <para>integer. The number of graphic window where the button is required to be installed</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The function allows the user to delete  buttons or menus create by
            <literal>addmenu</literal> in the main or graphics windows command panels. 
            Predefined buttons on Scilab graphic windows can also be deleted.
        </para>
        <para>
            If possible, it is better to delete first the latest created button
            for a given window to avoid gaps in  command panels.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
addmenu('foo')
delmenu('foo')
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="setmenu">setmenu</link>
            </member>
            <member>
                <link linkend="unsetmenu">unsetmenu</link>
            </member>
            <member>
                <link linkend="addmenu">addmenu</link>
            </member>
        </simplelist>
    </refsection>
</refentry>