Mercurial > octave
view scripts/plot/util/close.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2002-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} close ## @deftypefnx {} {} close (@var{h}) ## @deftypefnx {} {} close @var{figname} ## @deftypefnx {} {} close all ## @deftypefnx {} {} close all hidden ## @deftypefnx {} {} close all force ## @deftypefnx {} {@var{status} =} close (@dots{}) ## Close figure window(s). ## ## When called with no arguments, close the current figure. This is equivalent ## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector ## of graphics handles, then close each figure in @var{h}. The figure to ## close may also be specified by name @var{figname} which is matched against ## the @qcode{"Name"} property of all figures. ## ## If the argument @qcode{"all"} is given then all figures with visible handles ## (HandleVisibility = @qcode{"on"}) are closed. ## ## If the additional argument @qcode{"hidden"} is given then all figures, ## including hidden ones, are closed. ## ## If the additional argument @qcode{"force"} is given then figures are closed ## even when @qcode{"closerequestfcn"} has been altered to prevent closing the ## window. ## ## If the optional output @var{status} is requested then Octave returns 1 if ## the figure windows were closed successfully. ## ## Implementation Note: @code{close} operates by making the handle @var{h} the ## current figure, and then calling the function specified by the ## @qcode{"closerequestfcn"} property of the figure. By default, the function ## @code{closereq} is used. It is possible that the function invoked will ## delay or abort removing the figure. To remove a figure without executing ## any callback functions use @code{delete}. When writing a callback function ## to close a window do not use @code{close} to avoid recursion. ## ## @seealso{closereq, delete} ## @end deftypefn function status = close (arg1, arg2) figs = []; if (nargin == 0) ## Close current figure. ## Can't use gcf because it opens a new plot window if one does not exist. figs = get (0, "currentfigure"); if (figs == 0) # don't call close on root object figs = []; endif elseif (nargin == 1) if (ischar (arg1)) if (strcmpi (arg1, "all")) figs = get (0, "children"); figs = figs(isfigure (figs)); else figs = findall ("-depth", 1, "name", arg1, "type", "figure"); endif elseif (any (isfigure (arg1))) figs = arg1(isfigure (arg1)); elseif (isempty (arg1)) figs = []; # Silently accept null argument for Matlab compatibility else error ('close: first argument must be "all", a figure handle, or a figure name'); endif elseif (ischar (arg2) && (strcmpi (arg2, "hidden") || strcmpi (arg2, "force"))) if (ischar (arg1)) if (strcmpi (arg1, "all")) figs = allchild (0); figs = figs(isfigure (figs)); else figs = findall ("-depth", 1, "name", arg1, "type", "figure"); endif elseif (any (isfigure (arg1))) figs = arg1(isfigure (arg1)); elseif (isempty (arg1)) figs = []; # Silently accept null argument for Matlab compatibility else error ('close: first argument must be "all", a figure handle, or a figure name'); endif if (strcmpi (arg2, "force")) delete (figs); return; endif else error ('close: second argument must be "hidden" or "force"'); endif ## Save and restore current figure cf = get (0, "currentfigure"); for hfig = figs(:).' set (0, "currentfigure", hfig); # make figure current __go_execute_callback__ (hfig, "closerequestfcn"); endfor if (isfigure (cf)) set (0, "currentfigure", cf); endif if (nargout > 0) status = 1; endif endfunction %!test %! ## Test closing gcf %! hf = figure ("visible", "off"); %! unwind_protect %! close (); %! assert (! isfigure (hf)); %! unwind_protect_cleanup %! if (isfigure (hf)) %! delete (hf); %! endif %! end_unwind_protect %!test %! ## Test closing specified numeric figure handle %! hf = figure ("visible", "off"); %! unwind_protect %! close (hf); %! assert (! isfigure (hf)); %! unwind_protect_cleanup %! if (isfigure (hf)) %! delete (hf); %! endif %! end_unwind_protect %!test %! ## Test closing specified named figure handle %! hf = figure ("visible", "off", "name", "__foobar__"); %! unwind_protect %! close __foobar__; %! assert (! isfigure (hf)); %! unwind_protect_cleanup %! if (isfigure (hf)) %! delete (hf); %! endif %! end_unwind_protect %!test %! ## Test forcing the close of a figure %! hf = figure ("visible", "off", "closerequestfcn", []); %! unwind_protect %! close (hf); %! assert (isfigure (hf)); # figure not deleted %! close (hf, "force"); %! assert (! isfigure (hf)); # figure finally deleted %! unwind_protect_cleanup %! if (isfigure (hf)) %! delete (hf); %! endif %! end_unwind_protect ## Test input validation %!error <first argument must be "all", a figure handle> close ({"all"}) %!error <first argument must be "all", a figure handle> close (-1) %!error <second argument must be "hidden"> close all hid %!error <second argument must be "hidden"> close all for