Mercurial > hg > octave-nkf

comparison scripts/plot/util/gcbo.m @ 19705:bf27e21f0bfb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge default to temporary audio-gsoc branch.
author John W. Eaton <jwe@octave.org>
date Wed, 31 Dec 2014 14:59:42 -0500
parents d63878346099
children 446c46af4b42
comparison
equal deleted inserted replaced
19704:dac3191a5301 19705:bf27e21f0bfb
1 ## Copyright (C) 2008-2013 Michael Goffioul
2 ##
3 ## This file is part of Octave.
4 ##
5 ## Octave is free software; you can redistribute it and/or modify it
6 ## under the terms of the GNU General Public License as published by
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
9 ##
10 ## Octave is distributed in the hope that it will be useful, but
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ## General Public License for more details.
14 ##
15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>.
18
19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{h} =} gcbo ()
21 ## @deftypefnx {Function File} {[@var{h}, @var{fig}] =} gcbo ()
22 ## Return a handle to the object whose callback is currently executing.
23 ##
24 ## If no callback is executing, this function returns the empty matrix. This
25 ## handle is obtained from the root object property @qcode{"CallbackObject"}.
26 ##
27 ## When called with a second output argument, return the handle of the figure
28 ## containing the object whose callback is currently executing. If no callback
29 ## is executing the second output is also set to the empty matrix.
30 ##
31 ## @seealso{gcbf, gco, gca, gcf, get, set}
32 ## @end deftypefn
33
34 function [h, fig] = gcbo ()
35
36 h = get (0, "callbackobject");
37 fig = [];
38
39 if (! isempty (h) && nargout > 1)
40 fig = ancestor (h, "figure");
41 endif
42
43 endfunction
44
45
46 %!test
47 %! assert (isempty (gcbo));
48