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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
########################################################################
##
## Copyright (C) 2002-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} close
## @deftypefnx {} {} close (@var{h})
## @deftypefnx {} {} close @var{figname}
## @deftypefnx {} {} close all
## @deftypefnx {} {} close all hidden
## @deftypefnx {} {} close all force
## @deftypefnx {} {@var{status} =} close (@dots{})
## 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}. The figure to
## close may also be specified by name @var{figname} which is matched against
## the @qcode{"Name"} property of all figures.
##
## If the argument @qcode{"all"} is given then all figures with visible handles
## (HandleVisibility = @qcode{"on"}) are closed.
##
## If the additional argument @qcode{"hidden"} is given then all figures,
## including hidden ones, are closed.
##
## If the additional argument @qcode{"force"} is given then figures are closed
## even when @qcode{"closerequestfcn"} has been altered to prevent closing the
## window.
##
## If the optional output @var{status} is requested then Octave returns 1 if
## the figure windows were closed successfully.
##
## Implementation Note: @code{close} operates by making the handle @var{h} the
## current figure, and then calling the function specified by the
## @qcode{"closerequestfcn"} property of the 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
function status = close (arg1, arg2)
figs = [];
if (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 call close on root object
figs = [];
endif
elseif (nargin == 1)
if (ischar (arg1))
if (strcmpi (arg1, "all"))
figs = get (0, "children");
figs = figs(isfigure (figs));
else
figs = findall ("-depth", 1, "name", arg1, "type", "figure");
endif
elseif (any (isfigure (arg1)))
figs = arg1(isfigure (arg1));
elseif (isempty (arg1))
figs = []; # Silently accept null argument for Matlab compatibility
else
error ('close: first argument must be "all", a figure handle, or a figure name');
endif
elseif (ischar (arg2)
&& (strcmpi (arg2, "hidden") || strcmpi (arg2, "force")))
if (ischar (arg1))
if (strcmpi (arg1, "all"))
figs = allchild (0);
figs = figs(isfigure (figs));
else
figs = findall ("-depth", 1, "name", arg1, "type", "figure");
endif
elseif (any (isfigure (arg1)))
figs = arg1(isfigure (arg1));
elseif (isempty (arg1))
figs = []; # Silently accept null argument for Matlab compatibility
else
error ('close: first argument must be "all", a figure handle, or a figure name');
endif
if (strcmpi (arg2, "force"))
delete (figs);
return;
endif
else
error ('close: second argument must be "hidden" or "force"');
endif
## Save and restore current figure
cf = get (0, "currentfigure");
for hfig = figs(:).'
set (0, "currentfigure", hfig); # make figure current
__go_execute_callback__ (hfig, "closerequestfcn");
endfor
if (isfigure (cf))
set (0, "currentfigure", cf);
endif
if (nargout > 0)
status = 1;
endif
endfunction
%!test
%! ## Test closing gcf
%! hf = figure ("visible", "off");
%! unwind_protect
%! close ();
%! assert (! isfigure (hf));
%! unwind_protect_cleanup
%! if (isfigure (hf))
%! delete (hf);
%! endif
%! end_unwind_protect
%!test
%! ## Test closing specified numeric figure handle
%! hf = figure ("visible", "off");
%! unwind_protect
%! close (hf);
%! assert (! isfigure (hf));
%! unwind_protect_cleanup
%! if (isfigure (hf))
%! delete (hf);
%! endif
%! end_unwind_protect
%!test
%! ## Test closing specified named figure handle
%! hf = figure ("visible", "off", "name", "__foobar__");
%! unwind_protect
%! close __foobar__;
%! assert (! isfigure (hf));
%! unwind_protect_cleanup
%! if (isfigure (hf))
%! delete (hf);
%! endif
%! end_unwind_protect
%!test
%! ## Test forcing the close of a figure
%! hf = figure ("visible", "off", "closerequestfcn", []);
%! unwind_protect
%! close (hf);
%! assert (isfigure (hf)); # figure not deleted
%! close (hf, "force");
%! assert (! isfigure (hf)); # figure finally deleted
%! unwind_protect_cleanup
%! if (isfigure (hf))
%! delete (hf);
%! endif
%! end_unwind_protect
## Test input validation
%!error <first argument must be "all", a figure handle> close ({"all"})
%!error <first argument must be "all", a figure handle> close (-1)
%!error <second argument must be "hidden"> close all hid
%!error <second argument must be "hidden"> close all for
|
