summaryrefslogtreecommitdiff
path: root/modules/gui/help/en_US/uigetdir.xml
blob: 12d3dec864bf78385e4859d088ec61d18bbc2fb9 (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
<?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="uigetdir">
    <refnamediv>
        <refname>uigetdir</refname>
        <refpurpose>dialog for selecting a directory</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>directory = uigetdir()
            directory = uigetdir(start_path [,title])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>start_path</term>
                <listitem>
                    <para>a character string which gives the initial directory used for search. By default uigetdir uses current working directory.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>title</term>
                <listitem>
                    <para>the title for the uigetdir window.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>directory</term>
                <listitem>
                    <para>is the user selected directory if user answers "Ok" or the " " string if user cancels.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Creates a dialog window for selecting a directory
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
uigetdir()
uigetdir("SCI/modules/")
uigetdir("SCI/modules/", "Choose a directory")
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="uigetfile">uigetfile</link>
            </member>
            <member>
                <link linkend="uiputfile">uiputfile</link>
            </member>
        </simplelist>
    </refsection>
</refentry>