Mercurial > hg > octave-nkf

annotate scripts/plot/util/clf.m @ 20787:40ed9b46a800

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
new octave_value::string_value method with optional error message * ov.h (octave_value::string_vector): New method. ov-base.cc, ov-base.h (octave_base_value::string_vector): New default method. ov-str-mat.cc, ov-str-mat.h (octave_char_matrix_str::string_value): New method.
author John W. Eaton <jwe@octave.org>
date Thu, 08 Oct 2015 16:43:22 -0400
parents 9fc020886ae9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19790
diff changeset
1 ## Copyright (C) 2005-2015 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 -*-
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17092
diff changeset
20 ## @deftypefn {Command} {} clf
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17092
diff changeset
21 ## @deftypefnx {Command} {} clf reset
8250
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")
13316
959944e9d927 fix clf docstring typo from previous change
John W. Eaton <jwe@octave.org>
parents: 13313
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} clf (@dots{})
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
25 ## Clear the current figure window.
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
26 ##
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
27 ## @code{clf} operates by deleting child graphics objects with visible
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
28 ## handles (HandleVisibility = @qcode{"on"}).
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
29 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
30 ## If the optional argument @qcode{"reset"} is specified, delete all child
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
31 ## objects including those with hidden handles and reset all figure
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
32 ## properties to their defaults. However, the following properties are not
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
33 ## reset: Position, Units, PaperPosition, PaperUnits.
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 ##
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 ## If the first argument @var{hfig} is a figure handle, then operate on
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
36 ## this figure rather than the current figure returned by @code{gcf}.
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
37 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
38 ## The optional return value @var{h} is the graphics handle of the figure
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
39 ## window that was cleared.
17443
0aa77acf22f5 doc: Add seealso references between cla, clf, reset functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
40 ## @seealso{cla, close, delete, reset}
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
41 ## @end deftypefn
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
42
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
43 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
44
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
45 function h = clf (varargin)
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
46
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
47 if (nargin > 2)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
48 print_usage ();
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
49 elseif (nargin == 0)
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
50 hfig = gcf;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
51 do_reset = false;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
52 elseif (nargin == 1)
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
53 if (isscalar (varargin{1}) && isfigure (varargin{1}))
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
54 hfig = varargin{1};
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
55 do_reset = false;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
56 elseif (ischar (varargin{1}) && strcmpi (varargin{1}, "reset"))
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
57 hfig = gcf;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
58 do_reset = true;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
59 else
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
60 print_usage ();
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
61 endif
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
62 else
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
63 if (isscalar (varargin{1}) && isfigure (varargin{1})
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
64 && ischar (varargin{2}) && strcmpi (varargin{2}, "reset"))
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
65 hfig = varargin{1};
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
66 do_reset = true;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
67 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
68 print_usage ();
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
69 endif
8610
85c9906abfd1 use endif and endfor instead of end
John W. Eaton <jwe@octave.org>
parents: 8250
diff changeset
70 endif
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
71
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
72 if (do_reset)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
73 ## Select all the children, including the one with hidden handles.
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
74 delete (allchild (hfig));
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
75 reset (hfig);
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
76 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
77 ## Select only the chilren with visible handles.
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
78 delete (get (hfig, "children"));
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19946
diff changeset
79
19946
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19898
diff changeset
80 ## Also delete the annotation axes
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19898
diff changeset
81 hover = findall (hfig, "-depth", 1, "tag", "scribeoverlay");
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19898
diff changeset
82 delete (hover);
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
83 endif
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
84
13313
467276f9a366 clf: return figure handle
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
85 if (nargout > 0)
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
86 h = hfig;
13313
467276f9a366 clf: return figure handle
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
87 endif
467276f9a366 clf: return figure handle
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
88
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
89 endfunction
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
90
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
91
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
92 %!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
93 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
94 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
95 %! l = line;
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
96 %! assert (! isempty (get (gcf, "children")));
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
97 %! clf;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
98 %! assert (isempty (get (gcf, "children")));
13111
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
99 %! unwind_protect_cleanup
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
100 %! close (hf);
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
101 %! end_unwind_protect
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
102
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
103 %!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
104 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
105 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
106 %! clf;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
107 %! assert (isempty (get (gcf, "children")));
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
108 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
109 %! close (hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
110 %! end_unwind_protect
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
111
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
112 %!xtest
19946
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19898
diff changeset
113 %! set (0, "defaultfigurevisible", "off")
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
114 %! hf = figure ("visible", "off");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
115 %! unwind_protect
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
116 %! plot (1:10);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
117 %! set (hf, "papertype", "tabloid");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
118 %! clf (hf);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
119 %! assert (isempty (get (gcf, "children")));
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
120 %! assert (get (hf, "papertype"), "tabloid");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
121 %! plot (1:10);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
122 %! clf (hf, "reset");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
123 %! kids = get (hf, "children");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
124 %! assert (isempty (get (gcf, "children")));
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
125 %! assert (get (hf, "papertype"), "usletter");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
126 %! unwind_protect_cleanup
19946
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19898
diff changeset
127 %! set (0, "defaultfigurevisible", "remove")
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
128 %! close (hf);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
129 %! end_unwind_protect
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
130