bug 4852
[scilab.git] / scilab / modules / tclsci / help / en_US / tk_getfile.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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="tk_getfile">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>tk_getfile</refname>
19     <refpurpose>dialog to get one or more file paths (obsolete)</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>path=tk_getfile([Title="string"])
24 path=tk_getfile([multip="1"])
25 path=tk_getfile(file_mask[,Title="string"][,multip="1"])
26 path=tk_getfile(file_mask,dir[,Title="string"])
27 path=tk_getfile(file_mask,dir[,Title="string"][,multip="1"])
28 path=tk_getfile(file_mask,dir,"string"[,"multip"])</synopsis>
29   </refsynopsisdiv>
30   <refsection>
31     <title>Parameters</title>
32     <variablelist>
33       <varlistentry>
34         <term>file_mask</term>
35         <listitem>
36           <para>a character string which gives the file mask to use for file
37           selection. <literal>file_mask</literal> is written with Unix convention.
38           The default value is '*'.</para>
39         </listitem>
40       </varlistentry>
41       <varlistentry>
42         <term>dir</term>
43         <listitem>
44           <para>a character string which gives the initial directory used for
45           file search. By default tk_getfile uses the previously selected
46           directory.</para>
47         </listitem>
48       </varlistentry>
49       <varlistentry>
50         <term>path</term>
51         <listitem>
52           <para>is the user selected file path(s) if user answers "Ok" or the
53           " " string if user answers "Cancel".</para>
54         </listitem>
55       </varlistentry>
56       <varlistentry>
57         <term>Title="string"</term>
58         <listitem>
59           <para>Optional argument which gives the title for the tk_getfile
60           window. <literal>Warning</literal>: Use the new variable
61           <literal>Title</literal> instead of the old variable
62           <literal>title</literal>.</para>
63         </listitem>
64       </varlistentry>
65       <varlistentry>
66         <term>multip</term>
67         <listitem>
68           <para>Optional argument which allows to select more than one file at
69           once in the tk_getfile window. If given, it must be the string "1".
70           Otherwise, or if not given, this argument defaults to "0" i.e. only
71           one file can be selected in the dialog.</para>
72         </listitem>
73       </varlistentry>
74     </variablelist>
75   </refsection>
76   <refsection>
77     <title>Description</title>
78     <para>Creates a dialog window for file selection.</para>
79     <para>This function is obsolete and will be removed in Scilab 5.2, please use <link linkend="uigetfile">uigetfile</link> instead.</para>
80   </refsection>
81   <refsection>
82     <title>Examples</title>
83     <programlisting role="example"><![CDATA[ 
84 tk_getfile()
85 tk_getfile("*.sci","SCI/modules/graphics/macros")
86 tk_getfile(Title="Choose a file name")
87 tk_getfile(Title="Choose many file names at once",multip="1")
88 tk_getfile(multip="1")
89  ]]></programlisting>
90   </refsection>
91   <refsection>
92     <title>See Also</title>
93     <simplelist type="inline">
94       <member>
95         <link linkend="uigetfile">uigetfile</link>
96       </member>
97       <member>
98         <link linkend="tk_getdir">tk_getdir</link>
99       </member>
100       <member>
101         <link linkend="file">file</link>
102       </member>
103       <member>
104         <link linkend="fileinfo">fileinfo</link>
105       </member>
106     </simplelist>
107   </refsection>
108 </refentry>