Mercurial > octave-nkf
view scripts/plot/closereq.m @ 17444:ffa7f1caab4e
Clarify relationship of close, closereq.
Recode closereq to put input validation first.
* scripts/plot/close.m: Change docstring to place details of implementation at
the end.
* scripts/plot/closereq.m: Put input validation first.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 19 Sep 2013 12:01:12 -0700 |
parents | 1c89599167a6 |
children |
line wrap: on
line source
## Copyright (C) 2005-2012 John W. Eaton ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} closereq () ## Close the current figure and delete all graphics objects associated with it. ## ## By default, the @qcode{"closerequestfcn"} property of a new plot figure ## points to this function. ## @seealso{close, delete} ## @end deftypefn ## Author: jwe function closereq () if (nargin != 0) print_usage (); endif cf = gcbf (); if (isempty (cf)) warning ("closereq: calling closereq from octave prompt is not supported, use 'close' instead"); cf = get (0, "currentfigure"); endif if (! isempty (cf) && isfigure (cf)) delete (cf); endif endfunction