1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
## Copyright (C) 2002-2013 John W. Eaton
##
## 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 {Command} {} close
## @deftypefnx {Command} {} close (@var{h})
## @deftypefnx {Command} {} close all
## @deftypefnx {Command} {} close all hidden
## Close figure window(s).
##
## When called with no arguments, close the current figure. This is equivalent
## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector
## of graphics handles, then close each figure in @var{h}.
##
## If the argument @qcode{"all"} is given then all figures with visible handles
## (HandleVisibility = @qcode{"on"}) are closed.
##
## If the argument @qcode{"all hidden"} is given then all figures, including
## hidden ones, are closed.
##
## Implementation Note: @code{close} operates by calling the function specified
## by the @qcode{"closerequestfcn"} property for each figure. By default, the
## function @code{closereq} is used. It is possible that the function invoked
## will delay or abort removing the figure. To remove a figure without
## executing any callback functions use @code{delete}. When writing a callback
## function to close a window do not use @code{close} to avoid recursion.
##
## @seealso{closereq, delete}
## @end deftypefn
## Author: jwe
## 2010-05-02 PBig allow empty argument
function retval = close (arg1, arg2)
figs = [];
if (nargin > 2)
print_usage ();
elseif (nargin == 0)
## Close current figure.
## Can't use gcf because it opens a new plot window if one does not exist.
figs = get (0, "currentfigure");
if (figs == 0) # don't close root figure
figs = [];
endif
elseif (nargin == 1)
if (ischar (arg1) && strcmpi (arg1, "all"))
figs = (get (0, "children"))';
figs = figs(isfigure (figs));
elseif (isfigure (arg1))
figs = arg1;
elseif (isempty (arg1))
figs = [];
else
error ('close: first argument must be "all" or a figure handle');
endif
elseif ( ischar (arg1) && strcmpi (arg1, "all")
&& ischar (arg2) && strcmpi (arg2, "hidden"))
figs = (allchild (0))';
figs = figs(isfigure (figs));
else
error ('close: expecting argument to be "all hidden"');
endif
for h = figs
__go_execute_callback__ (h, "closerequestfcn");
endfor
if (nargout > 0)
retval = 1;
endif
endfunction
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! close (hf);
%! objs = findobj ("type", "figure");
%! assert (! any (objs == hf));
%! unwind_protect_cleanup
%! if (isfigure (hf))
%! close (hf);
%! endif
%! end_unwind_protect
%!error close (1,2,3)
%!error <first argument must be "all" or a figure> close ({"all"})
%!error <first argument must be "all" or a figure> close ("all_and_more")
%!error <first argument must be "all" or a figure> close (-1)
%!error <expecting argument to be "all hidden"> close "all" hid"
|
