Update examples
[scilab.git] / scilab / modules / gui / help / en_US / xgetfile.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5   <TITLE>xgetfile</TITLE>
6   <TYPE>Scilab Function</TYPE>
7   <DATE>$LastChangedDate$</DATE>
8   <SHORT_DESCRIPTION name="xgetfile"> dialog to get a file path</SHORT_DESCRIPTION>
9   <CALLING_SEQUENCE>
10     <CALLING_SEQUENCE_ITEM>path=xgetfile([title='string'])  </CALLING_SEQUENCE_ITEM>
11     <CALLING_SEQUENCE_ITEM>path=xgetfile(file_mask,[title='string'])  </CALLING_SEQUENCE_ITEM>
12     <CALLING_SEQUENCE_ITEM>path=xgetfile(file_mask,dir,[title='string'])  </CALLING_SEQUENCE_ITEM>
13     <CALLING_SEQUENCE_ITEM>path=xgetfile(file_mask,dir,'string')  </CALLING_SEQUENCE_ITEM>
14   </CALLING_SEQUENCE>
15   <PARAM>
16     <PARAM_INDENT>
17       <PARAM_ITEM>
18         <PARAM_NAME>file_mask</PARAM_NAME>
19         <PARAM_DESCRIPTION>
20           <SP>: a character string which gives the file mask to use for file selection. <VERB>file_mask</VERB> is written with Unix convention. the default value is '*'.</SP>
21         </PARAM_DESCRIPTION>
22       </PARAM_ITEM>
23       <PARAM_ITEM>
24         <PARAM_NAME>dir</PARAM_NAME>
25         <PARAM_DESCRIPTION>
26           <SP>: a character string which gives the initial directory used for file search. by default xgetfile uses the previously selected directory.</SP>
27         </PARAM_DESCRIPTION>
28       </PARAM_ITEM>
29       <PARAM_ITEM>
30         <PARAM_NAME>path</PARAM_NAME>
31         <PARAM_DESCRIPTION>
32           <SP>: is the user selected file path if user answers &quot;Ok&quot; or the &quot; &quot; string if user answers &quot;Cancel&quot;</SP>
33         </PARAM_DESCRIPTION>
34       </PARAM_ITEM>
35       <PARAM_ITEM>
36         <PARAM_NAME>title='string'  </PARAM_NAME>
37         <PARAM_DESCRIPTION>
38           <SP>:Optional arguments which gives the title for the xgetfile window.</SP>
39         </PARAM_DESCRIPTION>
40       </PARAM_ITEM>
41     </PARAM_INDENT>
42   </PARAM>
43   <DESCRIPTION>
44     <P>
45     Creates a dialog window for file selection</P>
46   </DESCRIPTION>
47   <EXAMPLE>
48 <![CDATA[
49 xgetfile()
50 xgetfile(title="Choose a file name")
51 xgetfile("*.sci")
52 xgetfile("*.sci", title="Choose a file name")
53 xgetfile("*.sci", "SCI/modules/gui/macros/")
54 xgetfile("*.sci", "SCI/modules/gui/macros/", title="Choose a file name")
55 xgetfile("*.sci", "SCI/modules/gui/macros/", "Choose a file name")
56  ]]>
57   </EXAMPLE>
58   <SEE_ALSO>
59     <SEE_ALSO_ITEM>
60       <LINK>x_dialog</LINK>
61     </SEE_ALSO_ITEM>
62     <SEE_ALSO_ITEM>
63       <LINK>file</LINK>
64     </SEE_ALSO_ITEM>
65     <SEE_ALSO_ITEM>
66       <LINK>read</LINK>
67     </SEE_ALSO_ITEM>
68     <SEE_ALSO_ITEM>
69       <LINK>write</LINK>
70     </SEE_ALSO_ITEM>
71     <SEE_ALSO_ITEM>
72       <LINK>exec</LINK>
73     </SEE_ALSO_ITEM>
74     <SEE_ALSO_ITEM>
75       <LINK>getf</LINK>
76     </SEE_ALSO_ITEM>
77   </SEE_ALSO>
78 </MAN>