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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="uigetfile" xml:lang="en">
<refnamediv>
<refname>uigetfile</refname>
<refpurpose>dialog window to get a file(s) name(s), path and filter
index
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>[FileName[,PathName[,FilterIndex]]]=uigetfile([file_mask[,dir[,boxTitle[,multipleSelection]]]])
PathFileName=uigetfile([file_mask[,dir[,boxTitle[,multiple]]]])
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Input parameters</title>
<variablelist>
<varlistentry>
<term>file_mask</term>
<listitem>
<para>a string matrix which gives the file masks to use for file
selection. <literal>file_mask</literal> is written with Unix
convention. The default value is '*'.
</para>
<para>we can also add descriptions for masks, for example ["*.x*","X
files";"*.bin","BIN files"].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dir</term>
<listitem>
<para>a character string which gives the initial directory used for
file search. By default uigetfile uses the previously selected
directory.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>boxTitle</term>
<listitem>
<para>a character string which gives the title of the uigetfile
window. By default uigetfile's title is 'uigetfile'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>multipleSelection</term>
<listitem>
<para>a boolean which allows to load only one file if it is at '%f'
(false) or multiple files if it is at '%t" (true). By default
uigetfile's multiple file selection is not enable.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Output parameters</title>
<variablelist>
<varlistentry>
<term>FileName</term>
<listitem>
<para>matrix of string which give the user selected file(s) (path +
file(s) name(s)) if user answers "Ok" or the " " string if user
answers "Cancel".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PathName</term>
<listitem>
<para>is the user selected file(s) path if user answers "Ok" or the
" " string if user answers "Cancel".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FilterIndex</term>
<listitem>
<para>is the user selected filter index on the list box if user
answers "Ok" or '0' string if user answers "Cancel"
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>Creates a dialog window for file(s) selection.</para>
</refsection>
<refsection>
<title>Comments</title>
<para>On Windows, java component used by uigetfile browse also .zip
archive then it is very slow with big .zip files.
</para>
<para>To disable, this feature:</para>
<para>if getos() == 'Windows' then unix("REGSVR32 /u %WINDIR%\System32\zipfldr.dll")
;end
</para>
<para>To re-enable,</para>
<para>if getos() == 'Windows' then unix("REGSVR32 %WINDIR%\System32\zipfldr.dll")
;end
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example">
uigetfile(["*.bin";"*.sce";"*.cos*"])
uigetfile(["*.sci";"*.bin"],"SCI/modules/gui/macros/")
uigetfile(["*.sc*";"*.bin"],"SCI/modules/gui/macros/")
uigetfile(["*.x*","X files";"*.bin","BIN files"],"SCI/modules/gui/macros/")
uigetfile(["*.sce";"*.bin"],"SCI/modules/gui/macros/", "Choose a file name", %t);
uigetfile(["*.sce";"*.bin"],"SCI/modules/gui/macros/", "Choose a file name", %f);
</programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="uiputfile">uiputfile</link>
</member>
<member>
<link linkend="uigetdir">uigetdir</link>
</member>
<member>
<link linkend="x_dialog">x_dialog</link>
</member>
<member>
<link linkend="file">file</link>
</member>
<member>
<link linkend="read">read</link>
</member>
<member>
<link linkend="write">write</link>
</member>
<member>
<link linkend="exec">exec</link>
</member>
</simplelist>
</refsection>
</refentry>
|
