Mercurial > hg > octave-nkf
annotate scripts/plot/gcbo.m @ 9040:dbd0c77e575e
Cleanup documentation file plot.texi
Spellcheck
Stylecheck (Mostly double spaces after periods)
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Sun, 22 Mar 2009 14:40:24 -0700 |
| parents | 85d6296d51e1 |
| children | 16f53d29049f |
| rev | line source |
|---|---|
| 7935 | 1 ## Copyright (C) 2008 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 | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
7935
diff
changeset
|
23 ## executing. If no callback is executing, this function returns the |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
7935
diff
changeset
|
24 ## empty matrix. This handle is obtained from the root object property |
| 7935 | 25 ## "CallbackObject". |
| 26 ## | |
| 27 ## Additionally return the handle of the figure containing the | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
7935
diff
changeset
|
28 ## object whose callback is currently executing. If no callback is |
| 7935 | 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 |