Mercurial > hg > octave-lyh

comparison scripts/plot/close.m @ 17452:ffa7f1caab4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 bc924baa2c4e
children
comparison
equal deleted inserted replaced
17451:0aa77acf22f5 17452:ffa7f1caab4e
21 ## @deftypefnx {Command} {} close (@var{h}) 21 ## @deftypefnx {Command} {} close (@var{h})
22 ## @deftypefnx {Command} {} close all 22 ## @deftypefnx {Command} {} close all
23 ## @deftypefnx {Command} {} close all hidden 23 ## @deftypefnx {Command} {} close all hidden
24 ## Close figure window(s). 24 ## Close figure window(s).
25 ## 25 ##
26 ## @code{close} operates by calling the function specified by the
27 ## @qcode{"closerequestfcn"} property for each figure. By default, the function
28 ## @code{closereq} is used.
29 ##
30 ## When called with no arguments, close the current figure. This is equivalent 26 ## When called with no arguments, close the current figure. This is equivalent
31 ## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector 27 ## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector
32 ## of graphics handles, then close each figure in @var{h}. 28 ## of graphics handles, then close each figure in @var{h}.
33 ## 29 ##
34 ## If the argument @qcode{"all"} is given then all figures with visible handles 30 ## If the argument @qcode{"all"} is given then all figures with visible handles
35 ## (HandleVisibility = @qcode{"on"}) are closed. 31 ## (HandleVisibility = @qcode{"on"}) are closed.
36 ## 32 ##
37 ## If the argument @qcode{"all hidden"} is given then all figures, including 33 ## If the argument @qcode{"all hidden"} is given then all figures, including
38 ## hidden ones, are closed. 34 ## hidden ones, are closed.
39 ## 35 ##
40 ## Implementation Note: @code{close} calls a function to dispose of the figure. 36 ## Implementation Note: @code{close} operates by calling the function specified
41 ## It is possible that the function will delay or abort removing the figure. 37 ## by the @qcode{"closerequestfcn"} property for each figure. By default, the
42 ## To remove a figure without executing any callback functions use 38 ## function @code{closereq} is used. It is possible that the function invoked
43 ## @code{delete}. 39 ## will delay or abort removing the figure. To remove a figure without
40 ## executing any callback functions use @code{delete}. When writing a callback
41 ## function to close a window do not use @code{close} to avoid recursion.
44 ## 42 ##
45 ## @seealso{closereq, delete} 43 ## @seealso{closereq, delete}
46 ## @end deftypefn 44 ## @end deftypefn
47 45
48 ## Author: jwe 46 ## Author: jwe