view scripts/plot/gcbf.m @ 16808:772f51539af8

doc: Add gco() to documentation. * doc/interpreter/plot.txi: Add gco() to manual. * scripts/plot/gco.m: Add seealso links to docstring. * scripts/plot/gcbf.m: Re-arrange seealso links. Improve docstring. * scripts/plot/gcbo.m: Rewrite second paragraph of docstring. Add seealso link to gco.
author Rik <rik@octave.org>
date Sat, 22 Jun 2013 11:16:04 -0700
parents f3d52523cde1
children eaab03308c0b
line wrap: on
line source

## Copyright (C) 2008-2012 Michael Goffioul
##
## 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} {@var{fig} =} gcbf ()
## Return a handle to the figure containing the object whose callback
## is currently executing.  If no callback is executing, this function
## returns the empty matrix.  The handle returned by this function is
## the same as the second output argument of @code{gcbo}.
##
##@seealso{gcbo, gcf, gca}
##@end deftypefn

function fig = gcbf ()

  [dummy, fig] = gcbo ();

endfunction


%!assert (isempty (gcbf))