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

annotate scripts/gui/uiputfile.m @ 18971:f084aab05cd9

Move checks for graphics_toolkit GUI functions to own script. * __get_funcname__.m: New function to buid the function name from basename and graphics_toolkit. * uigetdir.m, uigetfile.m, uiputfile.m: Adapt to use __get_funcname__ with basename = mfilename ()

author	Andreas Weber <andy.weber.aw@gmail.com>
date	Thu, 31 Jul 2014 00:03:56 +0200
parents	bb2a03f9ed20
children

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17572 diff changeset	1 ## Copyright (C) 2010-2013 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 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	27 ## @table @asis
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	28 ## @item @qcode{"/path/to/filename.ext"}
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	29 ## If a filename is given the file extension is extracted and used as filter.
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	30 ## In addition the path is selected as current path and the filename is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	31 ## selected as default file. Example: @code{uiputfile ("myfun.m")}
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	32 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	33 ## @item @qcode{"*.ext"}
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11583 diff changeset	34 ## A single file extension.
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	35 ## Example: @code{uiputfile ("*.ext")}
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	36 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	37 ## @item @code{@{"*.ext", "My Description"@}}
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	38 ## 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	39 ## a brief description in the 2nd column.
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	40 ## Example: @code{uiputfile (@{".ext","My Description";".xyz",
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	41 ## "XYZ-Format"@})}
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	42 ## @end table
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11583 diff changeset	43 ##
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	44 ## 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	45 ## extensions.
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	46 ## Example: @code{uiputfile (@{".gif;.png;*.jpg",
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16581 diff changeset	47 ## "Supported Picture Formats"@})}
11283 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.
15532 95d7475a0a89 doc: Add seealso links between uigetfile, uiputfile, uigetdir. Rik <rik@octave.org> parents: 15467 diff changeset	52 ## @seealso{uigetfile, uigetdir}
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	53 ## @end deftypefn
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	54
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	55 ## Author: Kai Habel
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	56
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	57 function [retfile, retpath, retindex] = uiputfile (varargin)
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	58
18971 f084aab05cd9 Move checks for graphics_toolkit GUI functions to own script. Andreas Weber <andy.weber.aw@gmail.com> parents: 18970 diff changeset	59 funcname = __get_funcname__ (mfilename ());
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	60
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	61 if (nargin > 3)
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	62 print_usage ();
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	63 endif
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	64
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	65 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	66 "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	67 "", # 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	68 [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	69 "create",
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	70 pwd}; # Default directory
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	71
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	72 outargs = cell (6, 1);
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	73 for i = 1 : 6
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	74 outargs{i} = defaultvals{i};
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	75 endfor
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	76
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	77 if (nargin > 0)
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	78 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	79 [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	80 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	81 outargs{6} = defdir;
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	82 endif
13697 0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	83 else
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	84 outargs{1} = __file_filter__ (outargs{1});
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	85 endif
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	86
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	87 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	88 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	89 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	90 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	91 print_usage ();
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	92 endif
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	93 endif
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	94
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	95 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	96 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	97 [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	98 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	99 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	100 endif
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	101 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	102 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	103 endif
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	104 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	105 print_usage ();
0f8ff98929b2 Allow a toolkit to provide its own version of UI dialogs. Michael Goffioul <michael.goffioul@gmail.com> parents: 13215 diff changeset	106 endif
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	107 endif
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	108
16581 fa4a035e0cf4 Add octave_link uiputfile implementation John Donoghue <john.donoghue@ieee.org> parents: 15532 diff changeset	109 if (__octave_link_enabled__ ())
fa4a035e0cf4 Add octave_link uiputfile implementation John Donoghue <john.donoghue@ieee.org> parents: 15532 diff changeset	110 [retfile, retpath, retindex] = __octave_link_file_dialog__ (outargs{:});
fa4a035e0cf4 Add octave_link uiputfile implementation John Donoghue <john.donoghue@ieee.org> parents: 15532 diff changeset	111 else
fa4a035e0cf4 Add octave_link uiputfile implementation John Donoghue <john.donoghue@ieee.org> parents: 15532 diff changeset	112 [retfile, retpath, retindex] = feval (funcname, outargs{:});
fa4a035e0cf4 Add octave_link uiputfile implementation John Donoghue <john.donoghue@ieee.org> parents: 15532 diff changeset	113 endif
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12183 diff changeset	114
11283 58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	115 endfunction
58f175d39a7a GUI file functions Kai Habel <kai.habel@gmx.de> parents: diff changeset	116
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	117
11583 c4c2cd67c440 Fixes for ui file functions, bug#32190 Kai Habel <kai.habel@gmx.de> parents: 11576 diff changeset	118 %!demo
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	119 %! uiputfile ({'.gif;.png;*.jpg', 'Supported Picture Formats'});
13215 cb8fd692b600 Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 12522 diff changeset	120
cb8fd692b600 Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 12522 diff changeset	121 ## Remove from test statistics. No real tests possible.
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	122 %!assert (1)
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123

Mercurial > octave-dspies

annotate scripts/gui/uiputfile.m @ 18971:f084aab05cd9