annotate scripts/plot/gcbo.m @ 14872:c2dbdeaa25df

maint: use rows() and columns() to clarify m-files. * gradient.m, interp1q.m, rat.m, tsearchn.m, image.m, imwrite.m, area.m, contourc.m, hist.m, isocolors.m, isonormals.m, meshz.m, print.m, __bar__.m, __go_draw_axes__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m, __print_parse_opts__.m, __quiver__.m, rose.m, shrinkfaces.m, stairs.m, surfnorm.m, tetramesh.m, text.m, deconv.m, spline.m, intersect.m, setdiff.m, setxor.m, union.m, periodogram.m, pcg.m, perms.m: Replace size (x,1) with rows (x) and size(x,2) with columns(x).
author Rik <octave@nomad.inbox5.com>
date Tue, 17 Jul 2012 13:34:19 -0700
parents f3d52523cde1
children 772f51539af8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13123
diff changeset
1 ## Copyright (C) 2008-2012 Michael Goffioul
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} gcbo ()
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 ## @deftypefnx {Function File} {[@var{h}, @var{fig}] =} gcbo ()
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
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
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 ## "CallbackObject".
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
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
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 ## executing, the second output is also set to the empty matrix.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 ##@seealso{gcf, gca, gcbf}
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 ##@end deftypefn
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 function [h, fig] = gcbo ()
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 h = get (0, "callbackobject");
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 fig = [];
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 if (! isempty (h) && nargout > 1)
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 fig = ancestor (h, "figure");
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 endif
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 endfunction
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
44
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
46 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
47 %! assert (isempty (gcbo));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48