octave_packages/m/plot/gcbo.m

   1 ## Copyright (C) 2008-2012 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
  23 ## executing.  If no callback is executing, this function returns the
  24 ## empty matrix.  This handle is obtained from the root object property
  25 ## "CallbackObject".
  26 ##
  27 ## Additionally return the handle of the figure containing the
  28 ## object whose callback is currently executing.  If no callback is
  29 ## executing, the second output is also set to the empty matrix.
  30 ##
  31 ##@seealso{gcf, gca, gcbf}
  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 %!test
  46 %! assert (isempty (gcbo ));