annotate scripts/plot/close.m @ 6977:e78e31f0a236

[project @ 2007-10-08 19:09:32 by jwe]
author jwe
date Mon, 08 Oct 2007 19:09:32 +0000
parents 76e3d985ae56
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2002 John W. Eaton
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
2 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
4 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
9 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
14 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4226
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4226
diff changeset
18 ## 02110-1301, USA.
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
19
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Command} {} close
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
22 ## @deftypefnx {Command} {} close (@var{n})
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Command} {} close all
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
24 ## @deftypefnx {Command} {} close all hidden
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
25 ## Close figure window(s) by calling the function specified by the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
26 ## @code{"closerequestfcn"} property for each figure. By default, the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
27 ## function @code{closereq} is used.
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
28 ## @seealso{closereq}
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
29 ## @end deftypefn
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
30
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
31 ## Author: jwe
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
32
4226
eafca8134ab6 [project @ 2002-12-18 03:26:47 by jwe]
jwe
parents: 4225
diff changeset
33 ## PKG_ADD: mark_as_command close
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
34
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
35 function retval = close (arg1, arg2)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
36
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
37 figs = [];
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
38
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
39 if (nargin == 0)
6278
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
40 ## Close current figure. Don't use gcf because that will open a new
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
41 ## plot window if one doesn't exist.
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
42 figs = get (0, "currentfigure");
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
43 if (! isempty (figs) && figs == 0)
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
44 figs = [];
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
45 endif
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
46 elseif (nargin == 1)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 if (ischar (arg1) && strcmp (arg1, "all"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
48 close_all_figures (false);
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
49 elseif (isfigure (arg1))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
50 figs = arg1;
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
51 else
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
52 error ("close: expecting argument to be \"all\" or a figure handle");
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
53 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
54 elseif (nargin == 2
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5307
diff changeset
55 && ischar (arg1) && strcmp (arg1, "all")
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5307
diff changeset
56 && ischar (arg2) && strcmp (arg2, "hidden"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
57 close_all_figures (true);
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
58 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
59 print_usage ();
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
60 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
61
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
62 for h = figs
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
63 set (0, "currentfigure", h);
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
64 feval (get (h, "closerequestfcn"));
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
65 endfor
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
66
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
67 if (nargout > 0)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
68 retval = 1;
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
69 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
70
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
71 endfunction
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
72
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
73 function close_all_figures (close_hidden_figs)
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
74
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
75 while (! isempty (fig = get (0, "currentfigure")))
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
76 ## handlevisibility = get (fig, "handlevisibility")
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
77 ## if (close_hidden_figs || ! strcmp (handlevisibility, "off"))
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
78 close (fig);
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
79 ## endif
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
80 endwhile
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
81
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
82 endfunction