octave: scripts/plot/util/close.m annotate

annotate scripts/plot/util/close.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 2002-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26878 diff changeset	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26878 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26878 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26878 diff changeset	5 ##
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	6 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	7 ## This file is part of Octave.
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24420 diff changeset	9 ## Octave is free software: you can redistribute it and/or modify it
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	10 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24420 diff changeset	11 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## (at your option) any later version.
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	13 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	14 ## Octave is distributed in the hope that it will be useful, but
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## GNU General Public License for more details.
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	18 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	19 ## 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	20 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24420 diff changeset	21 ## <https://www.gnu.org/licenses/>.
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	22
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20144 diff changeset	24 ## @deftypefn {} {} close
24420 e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	25 ## @deftypefnx {} {} close (@var{h})
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	26 ## @deftypefnx {} {} close @var{figname}
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20144 diff changeset	27 ## @deftypefnx {} {} close all
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20144 diff changeset	28 ## @deftypefnx {} {} close all hidden
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20144 diff changeset	29 ## @deftypefnx {} {} close all force
17093 e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	30 ## Close figure window(s).
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	31 ##
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	32 ## When called with no arguments, close the current figure. This is equivalent
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17093 diff changeset	33 ## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	34 ## of graphics handles, then close each figure in @var{h}. The figure to
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	35 ## close may also be specified by name @var{figname} which is matched against
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	36 ## the @qcode{"Name"} property of all figures.
17093 e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	37 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17135 diff changeset	38 ## If the argument @qcode{"all"} is given then all figures with visible handles
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17135 diff changeset	39 ## (HandleVisibility = @qcode{"on"}) are closed.
17093 e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	40 ##
24420 e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	41 ## If the additional argument @qcode{"hidden"} is given then all figures,
e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	42 ## including hidden ones, are closed.
17093 e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	43 ##
24420 e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	44 ## If the additional argument @qcode{"force"} is given then figures are closed
e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	45 ## even when @qcode{"closerequestfcn"} has been altered to prevent closing the
e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	46 ## window.
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	47 ##
24404 9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	48 ## Implementation Note: @code{close} operates by making the handle @var{h} the
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	49 ## current figure, and then calling the function specified by the
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	50 ## @qcode{"closerequestfcn"} property of the figure. By default, the function
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	51 ## @code{closereq} is used. It is possible that the function invoked will
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	52 ## delay or abort removing the figure. To remove a figure without executing
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	53 ## any callback functions use @code{delete}. When writing a callback function
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	54 ## to close a window do not use @code{close} to avoid recursion.
17093 e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	55 ##
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	56 ## @seealso{closereq, delete}
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	57 ## @end deftypefn
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	58
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	59 function retval = close (arg1, arg2)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	60
6405 b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe] jwe parents: 6278 diff changeset	61 figs = [];
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe] jwe parents: 6278 diff changeset	62
17093 e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	63 if (nargin > 2)
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	64 print_usage ();
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	65 elseif (nargin == 0)
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	66 ## Close current figure.
e5ded64def41 close.m: Fix close to remove hidden figures with "all hidden" argument. Rik <rik@octave.org> parents: 14868 diff changeset	67 ## Can't use gcf because it opens a new plot window if one does not exist.
6278 300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe] jwe parents: 6257 diff changeset	68 figs = get (0, "currentfigure");
26878 3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object". Rik <rik@octave.org> parents: 26376 diff changeset	69 if (figs == 0) # don't call close on root object
6278 300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe] jwe parents: 6257 diff changeset	70 figs = [];
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe] jwe parents: 6257 diff changeset	71 endif
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	72 elseif (nargin == 1)
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	73 if (ischar (arg1))
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	74 if (strcmpi (arg1, "all"))
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	75 figs = get (0, "children");
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	76 figs = figs(isfigure (figs));
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	77 else
24420 e1390a99a993 close.m: update cset 9213b8166af9 for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 24405 diff changeset	78 figs = findall ("-depth", 1, "name", arg1, "type", "figure");
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	79 endif
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	80 elseif (any (isfigure (arg1)))
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	81 figs = arg1(isfigure (arg1));
20144 3797df921988 close.m: Silently accept null argument for Matlab compatibility. Rik <rik@octave.org> parents: 20115 diff changeset	82 elseif (isempty (arg1))
3797df921988 close.m: Silently accept null argument for Matlab compatibility. Rik <rik@octave.org> parents: 20115 diff changeset	83 figs = []; # Silently accept null argument for Matlab compatibility
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	84 else
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	85 error ('close: first argument must be "all", a figure handle, or a figure name');
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	86 endif
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	87 elseif (ischar (arg2)
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	88 && (strcmpi (arg2, "hidden") \|\| strcmpi (arg2, "force")))
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	89 if (ischar (arg1))
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	90 if (strcmpi (arg1, "all"))
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	91 figs = allchild (0);
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	92 figs = figs(isfigure (figs));
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	93 else
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	94 figs = findall ("-depth", 1, "name", arg1, "type", "figure");
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	95 endif
21838 30d4645ecb98 close.m: Allow 'force' argument with figure handles (bug #48173). Rik <rik@octave.org> parents: 21656 diff changeset	96 elseif (any (isfigure (arg1)))
30d4645ecb98 close.m: Allow 'force' argument with figure handles (bug #48173). Rik <rik@octave.org> parents: 21656 diff changeset	97 figs = arg1(isfigure (arg1));
30d4645ecb98 close.m: Allow 'force' argument with figure handles (bug #48173). Rik <rik@octave.org> parents: 21656 diff changeset	98 elseif (isempty (arg1))
30d4645ecb98 close.m: Allow 'force' argument with figure handles (bug #48173). Rik <rik@octave.org> parents: 21656 diff changeset	99 figs = []; # Silently accept null argument for Matlab compatibility
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	100 else
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	101 error ('close: first argument must be "all", a figure handle, or a figure name');
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	102 endif
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	103 if (strcmpi (arg2, "force"))
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	104 delete (figs);
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	105 return;
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	106 endif
17135 723a08d266d2 close.m: Add input validation for 2 input args and %!error test blocks. Rik <rik@octave.org> parents: 17122 diff changeset	107 else
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	108 error ('close: second argument must be "hidden" or "force"');
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	109 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	110
24404 9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	111 ## Save and restore current figure
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	112 cf = get (0, "currentfigure");
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	113
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	114 for hfig = figs(:).'
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	115 set (0, "currentfigure", hfig); # make figure current
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	116 __go_execute_callback__ (hfig, "closerequestfcn");
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	117 endfor
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	118
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	119 if (isfigure (cf))
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	120 set (0, "currentfigure", cf);
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	121 endif
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	122
4225 fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	123 if (nargout > 0)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	124 retval = 1;
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	125 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	126
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe] jwe parents: diff changeset	127 endfunction
6405 b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe] jwe parents: 6278 diff changeset	128
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	129
13123 6efa1a691713 Add further tests for scripts/plot. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	130 %!test
24404 9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	131 %! ## Test closing gcf
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	132 %! hf = figure ("visible", "off");
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	133 %! unwind_protect
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	134 %! close ();
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	135 %! assert (! isfigure (hf));
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	136 %! unwind_protect_cleanup
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	137 %! if (isfigure (hf))
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	138 %! delete (hf);
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	139 %! endif
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	140 %! end_unwind_protect
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	141
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	142 %!test
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	143 %! ## Test closing specified numeric figure handle
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: 13123 diff changeset	144 %! hf = figure ("visible", "off");
13123 6efa1a691713 Add further tests for scripts/plot. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	145 %! unwind_protect
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: 13123 diff changeset	146 %! close (hf);
24404 9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	147 %! assert (! isfigure (hf));
13123 6efa1a691713 Add further tests for scripts/plot. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	148 %! unwind_protect_cleanup
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: 13123 diff changeset	149 %! if (isfigure (hf))
24404 9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	150 %! delete (hf);
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	151 %! endif
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	152 %! end_unwind_protect
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	153
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	154 %!test
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	155 %! ## Test closing specified named figure handle
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	156 %! hf = figure ("visible", "off", "name", "__foobar__");
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	157 %! unwind_protect
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	158 %! close __foobar__;
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	159 %! assert (! isfigure (hf));
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	160 %! unwind_protect_cleanup
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	161 %! if (isfigure (hf))
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	162 %! delete (hf);
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	163 %! endif
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	164 %! end_unwind_protect
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	165
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	166 %!test
24404 9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	167 %! ## Test forcing the close of a figure
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	168 %! hf = figure ("visible", "off", "closerequestfcn", []);
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	169 %! unwind_protect
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	170 %! close (hf);
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	171 %! assert (isfigure (hf)); # figure not deleted
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	172 %! close (hf, "force");
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	173 %! assert (! isfigure (hf)); # figure finally deleted
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	174 %! unwind_protect_cleanup
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	175 %! if (isfigure (hf))
9213b8166af9 Reimplement close() for figures for better Matlab compatibility (bug #52621). Rik <rik@octave.org> parents: 23220 diff changeset	176 %! delete (hf);
13123 6efa1a691713 Add further tests for scripts/plot. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	177 %! endif
6efa1a691713 Add further tests for scripts/plot. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	178 %! end_unwind_protect
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	179
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	180 ## Test input validation
17135 723a08d266d2 close.m: Add input validation for 2 input args and %!error test blocks. Rik <rik@octave.org> parents: 17122 diff changeset	181 %!error close (1,2,3)
24405 77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	182 %!error <first argument must be "all", a figure handle> close ({"all"})
77b6e0cd22b1 close.m: Allow a figure to be specified by name. Rik <rik@octave.org> parents: 24404 diff changeset	183 %!error <first argument must be "all", a figure handle> close (-1)
20115 7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	184 %!error <second argument must be "hidden"> close all hid
7e0e8fb16201 Overhaul close.m to add "force" argument (bug #44324) Rik <rik@octave.org> parents: 19697 diff changeset	185 %!error <second argument must be "hidden"> close all for

Mercurial > octave

annotate scripts/plot/util/close.m @ 27919:1891570abac8