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