ISO-8859-1 to UTF-8
[scilab.git] / scilab / modules / gui / help / en_US / xgetfile.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="xgetfile">
3   <info>
4     <pubdate>$LastChangedDate$</pubdate>
5   </info>
6   <refnamediv>
7     <refname>xgetfile</refname>
8     <refpurpose> dialog to get a file path</refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>path=xgetfile([title='string'])
13 path=xgetfile(file_mask,[title='string'])
14 path=xgetfile(file_mask,dir,[title='string'])
15 path=xgetfile(file_mask,dir,'string')</synopsis>
16   </refsynopsisdiv>
17   <refsection>
18     <title>Parameters</title>
19     <variablelist>
20       <varlistentry>
21         <term>file_mask</term>
22         <listitem>
23           <para>a character string which gives the file mask to use for file selection. <literal>file_mask</literal> is written with Unix convention. the default value is '*'.</para>
24         </listitem>
25       </varlistentry>
26       <varlistentry>
27         <term>dir</term>
28         <listitem>
29           <para>a character string which gives the initial directory used for file search. by default xgetfile uses the previously selected directory.</para>
30         </listitem>
31       </varlistentry>
32       <varlistentry>
33         <term>path</term>
34         <listitem>
35           <para>is the user selected file path if user answers "Ok" or the " " string if user answers "Cancel"</para>
36         </listitem>
37       </varlistentry>
38       <varlistentry>
39         <term>title='string'  </term>
40         <listitem>
41           <para>:Optional arguments which gives the title for the xgetfile window.</para>
42         </listitem>
43       </varlistentry>
44     </variablelist>
45   </refsection>
46   <refsection>
47     <title>Description</title>
48     <para>
49     Creates a dialog window for file selection</para>
50   </refsection>
51   <refsection>
52     <title>Examples</title>
53     <programlisting role="example"><![CDATA[
54
55 xgetfile()
56 xgetfile(title="Choose a file name")
57 xgetfile("*.sci")
58 xgetfile("*.sci", title="Choose a file name")
59 xgetfile("*.sci", "SCI/modules/gui/macros/")
60 xgetfile("*.sci", "SCI/modules/gui/macros/", title="Choose a file name")
61 xgetfile("*.sci", "SCI/modules/gui/macros/", "Choose a file name")
62  
63   ]]></programlisting>
64   </refsection>
65   <refsection>
66     <title>See Also</title>
67     <simplelist type="inline">
68       <member>
69         <link linkend="uigetdir">uigetdir</link>
70       </member>
71       <member>
72         <link linkend="x_dialog">x_dialog</link>
73       </member>
74       <member>
75         <link linkend="file">file</link>
76       </member>
77       <member>
78         <link linkend="read">read</link>
79       </member>
80       <member>
81         <link linkend="write">write</link>
82       </member>
83       <member>
84         <link linkend="exec">exec</link>
85       </member>
86       <member>
87         <link linkend="getf">getf</link>
88       </member>
89     </simplelist>
90   </refsection>
91 </refentry>