annotate scripts/plot/close.m @ 10598:6e1674216b99

close.m: No error on "close([])".
author Ben Abbott <bpabbott@mac.com>
date Sun, 02 May 2010 10:20:36 -0400
parents 95c3e38098bf
children be55736a0783
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
1 ## Copyright (C) 2002, 2005, 2006, 2007, 2008, 2009 John W. Eaton
4225
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## your option) any later version.
4225
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
18
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Command} {} close
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
21 ## @deftypefnx {Command} {} close (@var{n})
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Command} {} close all
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
23 ## @deftypefnx {Command} {} close all hidden
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
24 ## 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
25 ## @code{"closerequestfcn"} property for each figure. By default, the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
26 ## function @code{closereq} is used.
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
27 ## @seealso{closereq}
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
28 ## @end deftypefn
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
29
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
30 ## Author: jwe
10598
6e1674216b99 close.m: No error on "close([])".
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
31 ## 2010-05-02 PBig allow empty argument
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
32
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
33 function retval = close (arg1, arg2)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
34
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
35 figs = [];
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
36
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 0)
6278
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
38 ## 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
39 ## plot window if one doesn't exist.
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
40 figs = get (0, "currentfigure");
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
41 if (! isempty (figs) && figs == 0)
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
42 figs = [];
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
43 endif
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
44 elseif (nargin == 1)
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7966
diff changeset
45 if (ischar (arg1) && strcmpi (arg1, "all"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
46 close_all_figures (false);
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 elseif (isfigure (arg1))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
48 figs = arg1;
10598
6e1674216b99 close.m: No error on "close([])".
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
49 elseif (isempty(arg1))
6e1674216b99 close.m: No error on "close([])".
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
50 figs = [];
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
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
55 && ischar (arg1) && strcmpi (arg1, "all")
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
56 && ischar (arg2) && strcmpi (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
7966
5747be3ac497 Implement closereq as real callback execution
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
63 __go_execute_callback__ (h, "closerequestfcn");
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
64 endfor
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
65
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
66 if (nargout > 0)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
67 retval = 1;
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
68 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
69
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
70 endfunction
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
71
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
72 function close_all_figures (close_hidden_figs)
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
73
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
74 while (! isempty (fig = get (0, "currentfigure")))
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
75 ## handlevisibility = get (fig, "handlevisibility")
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7966
diff changeset
76 ## if (close_hidden_figs || ! strcmpi (handlevisibility, "off"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
77 close (fig);
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
78 ## endif
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
79 endwhile
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
80
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
81 endfunction