Mercurial > octave
view scripts/gui/uiputfile.m @ 30893:e1788b1a315f
maint: Use "fcn" as preferred abbreviation for "function" in m-files.
* accumarray.m, accumdim.m, quadl.m, quadv.m, randi.m, structfun.m,
__is_function__.m, uigetfile.m, uimenu.m, uiputfile.m, doc_cache_create.m,
colorspace_conversion_input_check.m, imageIO.m, argnames.m, vectorize.m,
vectorize.m, normest1.m, inputname.m, nthargout.m, display_info_file.m,
decic.m, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, odeset.m,
check_default_input.m, integrate_adaptive.m, ode_event_handler.m,
runge_kutta_23.m, runge_kutta_23s.m, runge_kutta_45_dorpri.m,
runge_kutta_interpolate.m, starting_stepsize.m, __all_opts__.m, fminbnd.m,
fminsearch.m, fminunc.m, fsolve.m, fzero.m, sqp.m, fplot.m, plotyy.m,
__bar__.m, __ezplot__.m, flat_entry.html, profexport.m, movfun.m, bicg.m,
bicgstab.m, cgs.m, eigs.m, gmres.m, pcg.m, __alltohandles__.m, __sprand__.m,
qmr.m, tfqmr.m, dump_demos.m:
Replace "func", "fun", "fn" in documentation and variable names with "fcn".
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 18:14:56 -0700 |
parents | 796f54d4ddbf |
children | ad8a4102f910 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2010-2022 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)