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
|
########################################################################
##
## Copyright (C) 2005-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 {} {} clf
## @deftypefnx {} {} clf reset
## @deftypefnx {} {} clf (@var{hfig})
## @deftypefnx {} {} clf (@var{hfig}, "reset")
## @deftypefnx {} {@var{h} =} clf (@dots{})
## Clear the current figure window.
##
## @code{clf} operates by deleting child graphics objects with visible
## handles (HandleVisibility = @qcode{"on"}).
##
## If the optional argument @qcode{"reset"} is specified, delete all child
## objects including those with hidden handles and reset all figure
## properties to their defaults. However, the following properties are not
## reset: Position, Units, PaperPosition, PaperUnits.
##
## If the first argument @var{hfig} is a figure handle, then operate on
## this figure rather than the current figure returned by @code{gcf}.
##
## The optional return value @var{h} is the graphics handle of the figure
## window that was cleared.
## @seealso{cla, close, delete, reset}
## @end deftypefn
function h = clf (varargin)
if (nargin > 2)
print_usage ();
elseif (nargin == 0)
hfig = gcf ();
do_reset = false;
elseif (nargin == 1)
if (isscalar (varargin{1}) && isfigure (varargin{1}))
hfig = varargin{1};
do_reset = false;
elseif (ischar (varargin{1}) && strcmpi (varargin{1}, "reset"))
hfig = gcf ();
do_reset = true;
else
print_usage ();
endif
else
if (isscalar (varargin{1}) && isfigure (varargin{1})
&& ischar (varargin{2}) && strcmpi (varargin{2}, "reset"))
hfig = varargin{1};
do_reset = true;
else
print_usage ();
endif
endif
if (do_reset)
## Delete all the children, including the ones with hidden handles,
## except default menus and toolbar.
kids = allchild (hfig);
if (! isempty (kids))
tags = get (kids, "tag");
## It's possible for a figure to have just one child and then get
## will return a single value instead of a cell array.
if (! iscell (tags))
tags = {tags};
endif
ismenu = cellfun (@(s) strncmp (s, "__default_menu_", 15), tags);
istoolbar = cellfun (@(s) strncmp (s, "__default_toolbar_menu_", 18), tags);
delete (kids(! ismenu & ! istoolbar));
endif
reset (hfig);
if (! isempty (kids))
## Recover figure listeners which have been deleted
__add_default_menu__ (hfig, kids(ismenu), kids(istoolbar));
endif
__set_default_mouse_modes__ (hfig);
else
## Select only the chilren with visible handles.
delete (get (hfig, "children"));
## Also delete the annotation axes
hover = findall (hfig, "-depth", 1, "tag", "scribeoverlay");
delete (hover);
endif
if (nargout > 0)
h = hfig;
endif
endfunction
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! l = line ();
%! assert (! isempty (get (gcf, "children")));
%! clf;
%! assert (isempty (get (gcf, "children")));
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! clf;
%! assert (isempty (get (gcf, "children")));
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! set (0, "defaultfigurevisible", "off");
%! hf = figure ("visible", "off");
%! unwind_protect
%! plot (1:10);
%! set (hf, "papertype", "tabloid");
%! clf (hf);
%! assert (isempty (get (gcf, "children")));
%! assert (get (hf, "papertype"), "tabloid");
%! plot (1:10);
%! clf (hf, "reset");
%! kids = get (hf, "children");
%! assert (isempty (get (gcf, "children")));
%! assert (get (hf, "papertype"), "usletter");
%! unwind_protect_cleanup
%! set (0, "defaultfigurevisible", "remove");
%! close (hf);
%! end_unwind_protect
|
