Mercurial > hg > octave-lyh

annotate scripts/plot/clf.m @ 13124:2ea1658ad049

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Don't use explicit figure number for tests to avoid interference with any figures opened by user. (plot/allchild.m, plot/ancestor.m, plot/cla.m, plot/clf.m, plot/close.m, plot/findall.m, plot/findobj.m, plot/gca.m, plot/gcf.m, plot/hggroup.m, plot/isfigure.m, plot/line.m, plot/loglog.m, plot/patch.m, plot/semilogx.m, plot/semilogy.m, plot/surface.m, plot/view.m, plot/whitebg.m, plot/xlim.m, plot/ylim.m, plot/zlim.m): Don't use explicit figure numer 1232 any more.
author Kai Habel <kai.habel@gmx.de>
date Sun, 11 Sep 2011 18:48:06 +0200
parents ebb42fb2da04
children e81ddf9cacd5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
1 ## Copyright (C) 2005-2011 John W. Eaton
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
2 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
4 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e0e48ea2a93c [project @ 2006-01-13 21:17:37 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.
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
9 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
14 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 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/>.
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
18
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
20 ## @deftypefn {Function File} {} clf ()
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
21 ## @deftypefnx {Function File} {} clf ("reset")
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
22 ## @deftypefnx {Function File} {} clf (@var{hfig})
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
23 ## @deftypefnx {Function File} {} clf (@var{hfig}, "reset")
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
24 ## Clear the current figure window. @code{clf} operates by deleting child
9752
51c21837686f Period spellcheck of Octave documentation to check and fix newly added DOCSTRINGS
Rik <rdrider0-list@yahoo.com>
parents: 9316
diff changeset
25 ## graphics objects with visible handles (@code{handlevisibility} = on).
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
26 ## If @var{hfig} is specified operate on it instead of the current figure.
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## If the optional argument @code{"reset"} is specified, all objects including
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
28 ## those with hidden handles are deleted.
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
29 ## @seealso{cla, close, delete}
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
30 ## @end deftypefn
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
31
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
32 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
33
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
34 function clf (varargin)
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
35
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
36 if (nargin > 2)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
37 print_usage ();
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
38 elseif (nargin > 1)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
39 if (isfigure (varargin{1}) && ischar (varargin{2})
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9752
diff changeset
40 && strcmpi (varargin{2}, "reset"))
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
41 oldfig = gcf;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
42 hfig = varargin{1};
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
43 do_reset = true;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
44 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
45 print_usage ();
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
46 endif
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
47 elseif (nargin == 1)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
48 if (isfigure (varargin{1}))
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
49 oldfig = gcf;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
50 hfig = varargin{1};
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
51 do_reset = false;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
52 elseif (ischar (varargin{1}) && strcmpi (varargin{1}, "reset"))
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
53 hfig = gcf;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
54 oldfig = hfig;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
55 do_reset = true;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
56 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
57 print_usage ();
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
58 endif
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
59 else
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
60 hfig = gcf;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
61 oldfig = hfig;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
62 do_reset = false;
8610
85c9906abfd1 use endif and endfor instead of end
John W. Eaton <jwe@octave.org>
parents: 8250
diff changeset
63 endif
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
64
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
65 if (do_reset)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
66 ## Select all the children, including the one with hidden handles.
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
67 hc = allchild (hfig);
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
68 reset (hfig);
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
69 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
70 ## Select only the chilren with visible handles.
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
71 hc = get (hfig, "children");
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
72 endif
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
73
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
74 ## Delete the children.
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
75 delete (hc);
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
76
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
77 endfunction
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
78
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
79 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13111
diff changeset
80 %! hf = figure ("visible", "off");
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
81 %! unwind_protect
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
82 %! l = line;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
83 %! assert (!isempty (get (gcf, "children")));
13111
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
84 %! unwind_protect_cleanup
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
85 %! close (hf);
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
86 %! end_unwind_protect
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
87
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
88 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13111
diff changeset
89 %! hf = figure ("visible", "off");
13111
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
90 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
91 %! clf;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
92 %! assert (isempty (get (gcf, "children")));
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
93 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
94 %! close (hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
95 %! end_unwind_protect