Mercurial > hg > octave-lyh
annotate scripts/plot/gcbo.m @ 17194:c954b0a396a2
comet.m: Speed up animation by using low-level graphic commands.
* scripts/plot/comet.m: Speed up animation by using low-level graphic
commands.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 05 Aug 2013 15:44:02 -0700 |
| parents | eaab03308c0b |
| children | bc924baa2c4e |
| 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 | 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 -*- | |
|
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 | 21 ## @deftypefnx {Function File} {[@var{h}, @var{fig}] =} gcbo () |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
22 ## Return a handle to the object whose callback is currently executing. |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
23 ## |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
24 ## If no callback is executing, this function returns the empty matrix. This |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
25 ## handle is obtained from the root object property "CallbackObject". |
| 7935 | 26 ## |
| 16808 | 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. | |
| 7935 | 30 ## |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
31 ## @seealso{gcbf, gco, gca, gcf, get, set} |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
32 ## @end deftypefn |
| 7935 | 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 | |
|
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 |