octave-dspies: scripts/plot/uiputfile.m annotate

annotate scripts/plot/uiputfile.m @ 13697:0f8ff98929b2

Allow a toolkit to provide its own version of UI dialogs. * plot/modules.mk (plot_PRIVATE_FCN_FILES): Add __file_filter__.m, __is_function__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m, __uiputfile_fltk__.m. * plot/uigetdir.m: Rework to remove FLTK-specific stuffs and allow use of toolkit-provided dialogs. Fallback to FLTK dialogs. * plot/uigetfile.m: Likewise. * plot/uiputfile.m: Likewise. * plot/private/__fltk_file_filter__.m: Assumes input is now always a cell array of strings. * plot/private/__file_filter__.m: New file. * plot/private/__is_function__.m: Likewise. * plot/private/uigetdir_fltk__.m: Likewise. * plot/private/uigetfile_fltk__.m: Likewise. * plot/private/uiputfile_fltk__.m: Likewise.

author	Michael Goffioul <michael.goffioul@gmail.com>
date	Thu, 13 Oct 2011 16:46:28 +0100
parents	cb8fd692b600
children	72c96de7a403

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11295 diff changeset	1 ## Copyright (C) 2010-2011 Kai Habel
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	2 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	3 ## This file is part of Octave.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	4 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	8 ## your option) any later version.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	9 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	13 ## General Public License for more details.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	14 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	18
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	19 ## -- texinfo --
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	20 ## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile ()
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	21 ## @deftypefnx {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt})
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	22 ## @deftypefnx {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt}, @var{dialog_name})
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	23 ## @deftypefnx {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt}, @var{dialog_name}, @var{default_file})
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	24 ## Open a GUI dialog for selecting a file. @var{flt} contains a (list of) file
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	25 ## filter string(s) in one of the following formats:
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	26 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	27 ## @table @code
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	28 ## @item "/path/to/filename.ext"
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11583 diff changeset	29 ## If a filename is given the file extension is
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	30 ## extracted and used as filter.
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	31 ## In addition the path is selected as current path and the filename is selected
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	32 ## as default file.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	33 ## Example: uiputfile("myfun.m");
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	34 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	35 ## @item "*.ext"
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11583 diff changeset	36 ## A single file extension.
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	37 ## Example: uiputfile("*.ext");
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	38 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	39 ## @item @{"*.ext","My Description"@}
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	40 ## A 2-column cell array containing the file extension in the 1st column and
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	41 ## a brief description in the 2nd column.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	42 ## Example: uiputfile(@{".ext","My Description";".xyz","XYZ-Format"@});
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	43 ## @end table
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11583 diff changeset	44 ##
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	45 ## The filter string can also contain a semicolon separated list of filter
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	46 ## extensions.
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	47 ## Example: uiputfile(@{".gif;.png;*.jpg", "Supported Picture Formats"@});
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	48 ##
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	49 ## @var{dialog_name} can be used to customize the dialog title.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11583 diff changeset	50 ## If @var{default_file} is given it is preselected in the GUI dialog.
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	51 ## If, in addition, a path is given it is also used as current path.
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	52 ## @end deftypefn
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	53
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	54 ## Author: Kai Habel
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	55
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	56 function [retfile, retpath, retindex] = uiputfile (varargin)
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	57
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	58 defaulttoolkit = get (0, "defaultfigure__graphics_toolkit__");
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	59 funcname = ["__uiputfile_", defaulttoolkit, "__"];
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	60 functype = exist (funcname);
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	61 if (! __is_function__ (funcname))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	62 funcname = "__uiputfile_fltk__";
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	63 if (! __is_function__ (funcname))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	64 error ("uiputfile: fltk graphics toolkit required");
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	65 elseif (! strcmp (defaulttoolkit, "gnuplot"))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	66 warning ("uiputfile: no implementation for toolkit `%s', using `fltk' instead",
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	67 defaulttoolkit);
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	68 endif
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	69 endif
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	70
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	71 if (nargin > 3)
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	72 print_usage ();
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	73 endif
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	74
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	75 defaultvals = {cell(0, 2), # File Filter
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	76 "Save File", # Dialog Title
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	77 "", # Default file name
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	78 [240, 120], # Dialog Position (pixel x/y)
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	79 "create",
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	80 pwd}; # Default directory
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	81
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	82 outargs = cell(6, 1);
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	83 for i = 1 : 6
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	84 outargs{i} = defaultvals{i};
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	85 endfor
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	86
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	87 if (nargin > 0)
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	88 file_filter = varargin{1};
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	89 [outargs{1}, outargs{3}, defdir] = __file_filter__ (file_filter);
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	90 if (length (defdir) > 0)
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	91 outargs{6} = defdir;
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	92 endif
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	93 else
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	94 outargs{1} = __file_filter__ (outargs{1});
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	95 endif
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	96
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	97 if (nargin > 1)
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	98 if (ischar (varargin{2}))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	99 outargs{2} = varargin{2};
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	100 elseif (! isempty (varargin{2}))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	101 print_usage ();
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	102 endif
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	103 endif
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	104
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	105 if (nargin > 2)
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	106 if (ischar (varargin{3}))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	107 [fdir, fname, fext] = fileparts (varargin{3});
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	108 if (! isempty (fdir))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	109 outargs{6} = fdir;
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	110 endif
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	111 if (! isempty (fname) \|\| ! isempty (fext))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	112 outargs{3} = strcat (fname, fext);
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	113 endif
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	114 elseif (! isempty (varargin{3}))
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	115 print_usage ();
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	116 endif
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	117 endif
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	118
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	119 [retfile, retpath, retindex] = feval (funcname, outargs{:});
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	120
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	121 endfunction
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	122
11583 c4c2cd67c440 Fixes for ui file functions, bug#32190 Kai Habel <kai.habel@gmx.de> parents: 11576 diff changeset	123 %!demo
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	124 %! uiputfile({".gif;.png;*.jpg", "Supported Picture Formats"})
13215 cb8fd692b600 Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 12522 diff changeset	125
cb8fd692b600 Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 12522 diff changeset	126 ## Remove from test statistics. No real tests possible.
cb8fd692b600 Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 12522 diff changeset	127 %!test
cb8fd692b600 Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 12522 diff changeset	128 %! assert (1);

Mercurial > octave-dspies

annotate scripts/plot/uiputfile.m @ 13697:0f8ff98929b2