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
144
145
|
########################################################################
##
## Copyright (C) 2010-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile ()
## @deftypefnx {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt})
## @deftypefnx {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt}, @var{dialog_name})
## @deftypefnx {} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt}, @var{dialog_name}, @var{default_file})
## Open a GUI dialog for selecting a file.
##
## @var{flt} contains a (list of) file filter string(s) in one of the following
## formats:
##
## @table @asis
## @item @qcode{"/path/to/filename.ext"}
## If a filename is given the file extension is extracted and used as filter.
## In addition the path is selected as current path in the dialog and the
## filename is selected as default file. Example:
## @code{uiputfile ("myfcn.m")}
##
## @item @qcode{"*.ext"}
## A single file extension.
## Example: @code{uiputfile ("*.ext")}
##
## @item @code{@{"*.ext", "My Description"@}}
## A 2-column cell array containing the file extension in the 1st column and
## a brief description in the 2nd column. Example:
## @code{uiputfile (@{"*.ext","My Description";"*.xyz", "XYZ-Format"@})}
## @end table
##
## The filter string can also contain a semicolon separated list of filter
## extensions. Example:
## @code{uiputfile (@{"*.gif;*.png;*.jpg", "Supported Picture Formats"@})}
##
## @var{dialog_name} can be used to customize the dialog title.
## If @var{default_file} is given it is preselected in the GUI dialog.
## If, in addition, a path is given it is also used as current path.
##
## @var{fname} and @var{fpath} return the chosen name and path, respectively.
## @var{fltidx} is the index in the list of filter extensions @var{flt} that
## was selected.
##
## @seealso{uigetfile, uigetdir}
## @end deftypefn
function [retfile, retpath, retindex] = uiputfile (varargin)
if (nargin > 3)
print_usage ();
endif
## Preset default values
outargs = {cell(0, 2), # File Filter
"Save File", # Dialog Title
"", # Default filename
"create",
pwd}; # Default directory
if (nargin > 0)
[outargs{1}, outargs{3}, defdir] = __file_filter__ ("uiputfile",
varargin{1});
if (! isempty (defdir))
outargs{5} = defdir;
endif
else
outargs{1} = __file_filter__ ("uiputfile", outargs{1});
endif
if (nargin > 1)
if (ischar (varargin{2}))
outargs{2} = varargin{2};
elseif (! isempty (varargin{2}))
print_usage ();
endif
endif
if (nargin > 2)
if (ischar (varargin{3}))
if (isfolder (varargin{3}))
fdir = varargin{3};
fname = fext = "";
else
[fdir, fname, fext] = fileparts (varargin{3});
endif
if (! isempty (fdir))
outargs{5} = fdir;
endif
if (! isempty (fname) || ! isempty (fext))
outargs{3} = [fname fext];
endif
elseif (! isempty (varargin{3}))
print_usage ();
endif
endif
if (__event_manager_have_dialogs__ ())
[retfile, retpath, retindex] = __event_manager_file_dialog__ (outargs{:});
else
funcname = __get_funcname__ (mfilename ());
[retfile, retpath, retindex] = feval (funcname, outargs{:});
endif
## Append extension to the name if it isn't already added.
if (ischar (retfile))
[~, ~, ext] = fileparts (retfile);
if (isempty (ext))
ext = outargs{1}{retindex};
ext = strrep (ext, "*", "");
if (! strcmp (ext, '.'))
[~, ~, ext] = fileparts (ext); # paranoid checking of extension
retfile = [retfile ext];
endif
endif
endif
endfunction
%!demo
%! uiputfile ({'*.gif;*.png;*.jpg', 'Supported Picture Formats'});
## Remove from test statistics. No real tests possible.
%!assert (1)
|
