annotate scripts/plot/close.m @ 14868:5d3a684236b0

maint: Use Octave coding conventions for cuddling parentheses in scripts directory * lin2mu.m, loadaudio.m, wavread.m, accumarray.m, bicubic.m, celldisp.m, colon.m, cplxpair.m, dblquad.m, divergence.m, genvarname.m, gradient.m, int2str.m, interp1.m, interp1q.m, interp2.m, interpn.m, loadobj.m, nthargout.m, __isequal__.m, __splinen__.m, quadgk.m, quadl.m, quadv.m, rat.m, rot90.m, rotdim.m, saveobj.m, subsindex.m, triplequad.m, delaunay3.m, griddata.m, inpolygon.m, tsearchn.m, voronoi.m, get_first_help_sentence.m, which.m, gray2ind.m, pink.m, dlmwrite.m, strread.m, textread.m, textscan.m, housh.m, ishermitian.m, issymmetric.m, krylov.m, logm.m, null.m, rref.m, compare_versions.m, copyfile.m, dump_prefs.m, edit.m, fileparts.m, getappdata.m, isappdata.m, movefile.m, orderfields.m, parseparams.m, __xzip__.m, rmappdata.m, setappdata.m, swapbytes.m, unpack.m, ver.m, fminbnd.m, fminunc.m, fsolve.m, glpk.m, lsqnonneg.m, qp.m, sqp.m, configure_make.m, copy_files.m, describe.m, get_description.m, get_forge_pkg.m, install.m, installed_packages.m, is_architecture_dependent.m, load_package_dirs.m, print_package_description.m, rebuild.m, repackage.m, save_order.m, shell.m, allchild.m, ancestor.m, area.m, axes.m, axis.m, clabel.m, close.m, colorbar.m, comet.m, comet3.m, contour.m, cylinder.m, ezmesh.m, ezsurf.m, findobj.m, fplot.m, hist.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, mesh.m, meshz.m, pareto.m, pcolor.m, peaks.m, plot3.m, plotmatrix.m, plotyy.m, polar.m, print.m, __add_datasource__.m, __add_default_menu__.m, __axes_limits__.m, __bar__.m, __clabel__.m, __contour__.m, __errcomm__.m, __errplot__.m, __ezplot__.m, __file_filter__.m, __fltk_print__.m, __ghostscript__.m, __gnuplot_print__.m, __go_draw_axes__.m, __go_draw_figure__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m, __pie__.m, __plt__.m, __print_parse_opts__.m, __quiver__.m, __scatter__.m, __stem__.m, __tight_eps_bbox__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m, __uiputfile_fltk__.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, ribbon.m, scatter.m, semilogy.m, shading.m, slice.m, subplot.m, surface.m, surfl.m, surfnorm.m, text.m, uigetfile.m, uiputfile.m, whitebg.m, deconv.m, mkpp.m, pchip.m, polyaffine.m, polyder.m, polygcd.m, polyout.m, polyval.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, splinefit.m, addpref.m, getpref.m, setpref.m, ismember.m, setxor.m, arch_fit.m, arch_rnd.m, arch_test.m, autoreg_matrix.m, diffpara.m, fftconv.m, filter2.m, hanning.m, hurst.m, periodogram.m, triangle_sw.m, sinc.m, spectral_xdf.m, spencer.m, stft.m, synthesis.m, unwrap.m, yulewalker.m, bicgstab.m, gmres.m, pcg.m, pcr.m, __sprand_impl__.m, speye.m, spfun.m, sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, bessel.m, factor.m, legendre.m, perms.m, primes.m, magic.m, toeplitz.m, corr.m, cov.m, mean.m, median.m, mode.m, qqplot.m, quantile.m, ranks.m, zscore.m, logistic_regression_likelihood.m, bartlett_test.m, chisquare_test_homogeneity.m, chisquare_test_independence.m, kolmogorov_smirnov_test.m, run_test.m, u_test.m, wilcoxon_test.m, z_test.m, z_test_2.m, bin2dec.m, dec2base.m, mat2str.m, strcat.m, strchr.m, strjust.m, strtok.m, substr.m, untabify.m, assert.m, demo.m, example.m, fail.m, speed.m, test.m, now.m: Use Octave coding conventions for cuddling parentheses in scripts directory.
author Rik <octave@nomad.inbox5.com>
date Tue, 17 Jul 2012 07:08:39 -0700
parents f3d52523cde1
children e5ded64def41
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
1 ## Copyright (C) 2002-2012 John W. Eaton
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
2 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
4 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 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.
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
9 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
14 ##
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 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/>.
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 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10598
diff changeset
20 ## @deftypefn {Command} {} close
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
21 ## @deftypefnx {Command} {} close (@var{n})
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Command} {} close all
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
23 ## @deftypefnx {Command} {} close all hidden
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
24 ## Close figure window(s) by calling the function specified by the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
25 ## @code{"closerequestfcn"} property for each figure. By default, the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
26 ## function @code{closereq} is used.
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6405
diff changeset
27 ## @seealso{closereq}
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
28 ## @end deftypefn
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
29
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
30 ## Author: jwe
10598
6e1674216b99 close.m: No error on "close([])".
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
31 ## 2010-05-02 PBig allow empty argument
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
32
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
33 function retval = close (arg1, arg2)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
34
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
35 figs = [];
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
36
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 0)
6278
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
38 ## Close current figure. Don't use gcf because that will open a new
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
39 ## plot window if one doesn't exist.
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
40 figs = get (0, "currentfigure");
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
41 if (! isempty (figs) && figs == 0)
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
42 figs = [];
300fb48803e3 [project @ 2007-02-07 22:23:37 by jwe]
jwe
parents: 6257
diff changeset
43 endif
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
44 elseif (nargin == 1)
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7966
diff changeset
45 if (ischar (arg1) && strcmpi (arg1, "all"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
46 close_all_figures (false);
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 elseif (isfigure (arg1))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
48 figs = arg1;
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
49 elseif (isempty (arg1))
10598
6e1674216b99 close.m: No error on "close([])".
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
50 figs = [];
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
51 else
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
52 error ("close: expecting argument to be \"all\" or a figure handle");
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
53 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
54 elseif (nargin == 2
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
55 && ischar (arg1) && strcmpi (arg1, "all")
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
56 && ischar (arg2) && strcmpi (arg2, "hidden"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
57 close_all_figures (true);
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
58 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
59 print_usage ();
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
60 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
61
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
62 for h = figs
7966
5747be3ac497 Implement closereq as real callback execution
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
63 __go_execute_callback__ (h, "closerequestfcn");
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
64 endfor
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
65
4225
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
66 if (nargout > 0)
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
67 retval = 1;
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
68 endif
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
69
fa4dfbc33ce5 [project @ 2002-12-18 03:07:48 by jwe]
jwe
parents:
diff changeset
70 endfunction
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
71
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
72 function close_all_figures (close_hidden_figs)
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
73
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
74 while (! isempty (fig = get (0, "currentfigure")))
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
75 ## handlevisibility = get (fig, "handlevisibility")
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7966
diff changeset
76 ## if (close_hidden_figs || ! strcmpi (handlevisibility, "off"))
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
77 close (fig);
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
78 ## endif
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
79 endwhile
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
80
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6278
diff changeset
81 endfunction
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
82
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
83
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
84 %!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: 13123
diff changeset
85 %! hf = figure ("visible", "off");
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
86 %! 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
87 %! close (hf);
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
88 %! objs = findobj ("type", "figure");
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
89 %! assert (isempty (intersect (objs, hf)));
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
90 %! 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
91 %! if (isfigure (hf))
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
92 %! close (hf);
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
93 %! endif
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
94 %! end_unwind_protect
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
95