Mercurial > octave
view scripts/plot/uigetfile.m @ 15466:d174210ce1ec stable
use ' instead of ` in error messages, warnings and most comments
* intro.txi, io.txi, munge-texi.cc, octave.texi, cmd-edit.cc,
data-conv.cc, file-ops.cc, glob-match.h, kpse.cc, oct-env.cc,
oct-locbuf.h, oct-md5.cc, oct-rand.cc, general/interp2.m, doc.m,
get_first_help_sentence.m, help.m, print_usage.m,
__additional_help_message__.m, type.m, unimplemented.m, which.m,
cast.m, dir.m, license.m, mkoctfile.m, recycle.m, tempdir.m,
optimset.m, pkg/pkg.m, closereq.m, colstyle.m, __fltk_print__.m,
__gnuplot_print__.m, __go_draw_figure__.m, __pie__.m, __pltopt__.m,
__print_parse_opts__.m, uigetdir.m, uigetfile.m, uiputfile.m, stft.m,
mean.m, anova.m, cor_test.m, t_test_regression.m, __magick_read__.cc,
dlmread.cc, schur.cc, data.cc, debug.cc, defun-dld.h, defun.cc,
defun.h, dynamic-ld.cc, error.cc, error.h, gl-render.cc, graphics.cc,
gripes.cc, input.cc, lex.ll, load-path.cc, load-save.cc, ls-hdf5.cc,
ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-ascii.cc,
ls-oct-binary.cc, oct-hist.cc, oct-parse.yy, oct-stream.cc,
oct-stream.h, octave.cc, ov-base-diag.cc, ov-base.cc, ov-class.cc,
ov-colon.h, ov-struct.cc, ov-typeinfo.cc, ov.cc, pager.cc,
pr-output.cc, pt-binop.cc, pt-eval.cc, pt-id.cc, pt-idx.cc,
pt-misc.cc, pt-unop.cc, symtab.cc, symtab.h, toplev.cc, txt-eng-ft.cc,
utils.cc, variables.cc, test_eval-catch.m, test_try.m:
Use ' instead of ` in error messages, warnings, and most comments.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 01 Oct 2012 17:18:49 -0400 |
parents | 72c96de7a403 |
children | 049e8bbff782 |
line wrap: on
line source
## Copyright (C) 2010-2012 Kai Habel ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uigetfile () ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}) ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}) ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}, @var{default_file}) ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{}, "Position", [@var{px} @var{py}]) ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{}, "MultiSelect", @var{mode}) ## ## Open a GUI dialog for selecting a file. It returns the filename @var{fname}, ## the path to this file @var{fpath}, and the filter index @var{fltidx}. ## @var{flt} contains a (list of) file filter string(s) in one of the following ## formats: ## ## @table @asis ## @item "/path/to/filename.ext" ## If a filename is given then the file extension is extracted and used as ## filter. In addition, the path is selected as current path and the filename ## is selected as default file. Example: @code{uigetfile ("myfun.m")} ## ## @item A single file extension "*.ext" ## Example: @code{uigetfile ("*.ext")} ## ## @item A 2-column cell array ## containing a file extension in the first column and a brief description ## in the second column. ## Example: @code{uigetfile (@{"*.ext", "My Description";"*.xyz", ## "XYZ-Format"@})} ## ## The filter string can also contain a semicolon separated list of filter ## extensions. ## Example: @code{uigetfile (@{"*.gif;*.png;*.jpg", "Supported Picture ## Formats"@})} ## @end table ## ## @var{dialog_name} can be used to customize the dialog title. ## If @var{default_file} is given then it will be selected in the GUI dialog. ## If, in addition, a path is given it is also used as current path. ## ## The screen position of the GUI dialog can be set using the "Position" key ## and a 2-element vector containing the pixel coordinates. ## Two or more files can be selected when setting the "MultiSelect" key to "on". ## In that case @var{fname} is a cell array containing the files. ## @end deftypefn ## Author: Kai Habel function [retfile, retpath, retindex] = uigetfile (varargin) defaulttoolkit = get (0, "defaultfigure__graphics_toolkit__"); funcname = ["__uigetfile_", defaulttoolkit, "__"]; functype = exist (funcname); if (! __is_function__ (funcname)) funcname = "__uigetfile_fltk__"; if (! __is_function__ (funcname)) error ("uigetfile: fltk graphics toolkit required"); elseif (! strcmp (defaulttoolkit, "gnuplot")) warning ("uigetfile: no implementation for toolkit '%s', using 'fltk' instead", defaulttoolkit); endif endif if (nargin > 7) error ("uigetfile: number of input arguments must be less than eight"); endif defaultvals = {cell(0, 2), # File Filter "Open File", # Dialog Title "", # Default file name [240, 120], # Dialog Position (pixel x/y) "off", # MultiSelect on/off pwd}; # Default directory outargs = cell (6, 1); for i = 1 : 6 outargs{i} = defaultvals{i}; endfor idx1 = idx2 = []; if (length (varargin) > 0) for i = 1 : length (varargin) val = varargin{i}; if (ischar (val)) if (strncmpi (val, "multiselect", 11)) idx1 = i; elseif (strncmpi (val, "position", 8)) idx2 = i; endif endif endfor endif stridx = [idx1, idx2, 0]; if (length (stridx) > 1) stridx = min (stridx(1 : end - 1)); endif args = varargin; if (stridx) args = varargin(1 : stridx - 1); endif len = length (args); if (len > 0) file_filter = args{1}; [outargs{1}, outargs{3}, defdir] = __file_filter__ (file_filter); if (length (defdir) > 0) outargs{6} = defdir; endif else outargs{1} = __file_filter__ (outargs{1}); endif if (len > 1) if (ischar (args{2})) if (length (args{2}) > 0) outargs{2} = args{2}; endif elseif (! isempty (args{2})) print_usage (); endif endif if (len > 2) if (ischar (args{3})) [fdir, fname, fext] = fileparts (args{3}); if (length (fdir) > 0) outargs{6} = fdir; endif if (length (fname) > 0 || length (fext) > 0) outargs{3} = strcat (fname, fext); endif elseif (! isempty (args{3})) print_usage (); endif endif if (stridx) ## we have string arguments ("position" or "multiselect") ## check for even number of remaining arguments, prop/value pair(s) if (rem (nargin - stridx + 1, 2)) error ("uigetfile: expecting property/value pairs"); endif for i = stridx : 2 : nargin prop = varargin{i}; val = varargin{i + 1}; if (strncmp (tolower (prop), "position", 8)) if (ismatrix (val) && length(val) == 2) outargs{4} = val; else error ("uigetfile: expecting 2-element vector for position argument"); endif elseif (strncmp (tolower (prop), "multiselect", 11)) if (ischar (val)) outargs{5} = tolower (val); else error ("uigetfile: expecting string argument (on/off) for multiselect"); endif else error ("uigetfile: unknown argument"); endif endfor endif [retfile, retpath, retindex] = feval (funcname, outargs{:}); endfunction %!demo %! uigetfile({"*.gif;*.png;*.jpg", "Supported Picture Formats"}) ## Remove from test statistics. No real tests possible. %!test %! assert (1);