Mercurial > octave-nkf
annotate scripts/plot/cla.m @ 17081:86067af51d5e
Truly reset axes so that all properties are set to default.
* libinterp/corefcn/graphics.cc: Add missing defaults for some
properties when axis is reset.
* scripts/plot/cla.m: Redo docstring. Simplify code. Call __go_axes_init__ to
do resetting of axes. Add %!test block.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 25 Jul 2013 11:24:03 -0700 |
parents | f3d52523cde1 |
children | eaab03308c0b |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
1 ## Copyright (C) 2008-2012 Ben Abbott |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
2 ## |
11104 | 3 ## This file is part of Octave. |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
15 ## You should have received a copy of the GNU General Public License |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
16 ## along with Octave; see the file COPYING. If not, see |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
18 |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
19 ## -*- texinfo -*- |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
20 ## @deftypefn {Function File} {} cla |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
21 ## @deftypefnx {Function File} {} cla reset |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
22 ## @deftypefnx {Function File} {} cla (@var{hax}) |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
23 ## @deftypefnx {Function File} {} cla (@var{hax}, "reset") |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
24 ## Clear the current axes by deleting child graphic objects with visible |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
25 ## handles (HandleVisibility = "on"). |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
26 ## |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
27 ## If the optional argument "reset" is specified, delete all child objects |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
28 ## including those with hidden handles and reset all axis properties to |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
29 ## their defaults. However, the following properties are not reset: |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
30 ## Position, Units. |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
31 ## |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
32 ## If an axes object handle @var{hax} is specified, operate on it instead of |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
33 ## the current axes. |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
34 ## @seealso{clf} |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
35 ## @end deftypefn |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
36 |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
37 ## Author: Ben Abbott <bpabbott@mac.com> |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
38 ## Created: 2008-10-03 |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
39 |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
40 function cla (varargin) |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
41 |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
42 if (nargin > 2) |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
43 print_usage (); |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
44 elseif (nargin == 0) |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
45 hax = gca; |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
46 do_reset = false; |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
47 elseif (nargin == 1) |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
48 if (isscalar (varargin{1}) && ishandle (varargin{1}) |
10549 | 49 && strcmp (get (varargin{1}, "type"), "axes")) |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
50 hax = varargin{1}; |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
51 do_reset = false; |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
52 elseif (ischar (varargin{1}) && strcmpi (varargin{1}, "reset")) |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
53 hax = gca; |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
54 do_reset = true; |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
55 else |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
56 print_usage (); |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
57 endif |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
58 else |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
59 if (isscalar (varargin{1}) && ishandle (varargin{1}) |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
60 && strcmp (get (varargin{1}, "type"), "axes") |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
61 && ischar (varargin{2}) && strcmpi (varargin{2}, "reset")) |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
62 hax = varargin{1}; |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
63 do_reset = true; |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
64 else |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
65 print_usage (); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
66 endif |
8610
85c9906abfd1
use endif and endfor instead of end
John W. Eaton <jwe@octave.org>
parents:
8285
diff
changeset
|
67 endif |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
68 |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
69 if (! do_reset) |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
70 delete (get (hax, "children")); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
71 else |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
72 __go_axes_init__ (hax, "replace"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
73 __request_drawnow__ (); |
8264
bca580bbda02
cla.m: Fix error when no children to clear.
Ben Abbott <bpabbott@mac.com>
parents:
8199
diff
changeset
|
74 endif |
8199
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
75 |
ec1b4cd5fbbb
cla.m: Add matlab function cla().
Ben Abbott <bpabbott@mac.com>
parents:
diff
changeset
|
76 endfunction |
8264
bca580bbda02
cla.m: Fix error when no children to clear.
Ben Abbott <bpabbott@mac.com>
parents:
8199
diff
changeset
|
77 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
78 |
8264
bca580bbda02
cla.m: Fix error when no children to clear.
Ben Abbott <bpabbott@mac.com>
parents:
8199
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"); |
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13124
diff
changeset
|
81 %! unwind_protect |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
82 %! plot (1:10); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
83 %! cla (); |
8264
bca580bbda02
cla.m: Fix error when no children to clear.
Ben Abbott <bpabbott@mac.com>
parents:
8199
diff
changeset
|
84 %! kids = get (gca, "children"); |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
85 %! cla (); |
8264
bca580bbda02
cla.m: Fix error when no children to clear.
Ben Abbott <bpabbott@mac.com>
parents:
8199
diff
changeset
|
86 %! unwind_protect_cleanup |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
87 %! close (hf); |
8264
bca580bbda02
cla.m: Fix error when no children to clear.
Ben Abbott <bpabbott@mac.com>
parents:
8199
diff
changeset
|
88 %! end_unwind_protect |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
89 %! assert (numel (kids), 0); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
90 |
17081
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
91 %!test |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
92 %! hf = figure ("visible", "off"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
93 %! unwind_protect |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
94 %! hax = gca; |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
95 %! plot (hax, 1:10); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
96 %! set (hax, "interpreter", "tex"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
97 %! cla (hax); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
98 %! kids = get (hax, "children"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
99 %! assert (numel (kids), 0); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
100 %! assert (get (hax, "interpreter"), "tex"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
101 %! plot (hax, 1:10); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
102 %! cla (hax, "reset"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
103 %! kids = get (hax, "children"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
104 %! assert (numel (kids), 0); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
105 %! assert (get (hax, "interpreter"), "none"); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
106 %! unwind_protect_cleanup |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
107 %! close (hf); |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
108 %! end_unwind_protect |
86067af51d5e
Truly reset axes so that all properties are set to default.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
109 |