annotate scripts/plot/util/gcbo.m @ 33670:9dd2a8e7e0d5 default tip @

uifigure.m: Make sure variable exists before it is used (bug #65459). * scripts/gui/uifigure.m: The variable "props" might have been used before it existed. Make sure it exists for all code paths.
author Markus Mützel <markus.muetzel@gmx.de>
date Mon, 24 Jun 2024 10:29:15 +0200
parents 2e484f9f1f18
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31706
diff changeset
3 ## Copyright (C) 2008-2024 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## This file is part of Octave.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## (at your option) any later version.
7935
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 ## 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
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 ## GNU General Public License for more details.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 ## 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
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## @deftypefn {} {@var{h} =} gcbo ()
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 ## @deftypefnx {} {[@var{h}, @var{fig}] =} gcbo ()
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
29 ## Return a handle to the object whose callback is currently executing.
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
30 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
31 ## If no callback is executing, this function returns the empty matrix. This
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
32 ## handle is obtained from the root object property @qcode{"CallbackObject"}.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ##
16808
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 ## When called with a second output argument, return the handle of the figure
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 ## containing the object whose callback is currently executing. If no callback
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 14363
diff changeset
36 ## is executing the second output is also set to the empty matrix.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
38 ## @seealso{gcbf, gco, gca, gcf, get, set}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
39 ## @end deftypefn
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 function [h, fig] = gcbo ()
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 h = get (0, "callbackobject");
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 fig = [];
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 if (! isempty (h) && nargout > 1)
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 fig = ancestor (h, "figure");
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 endif
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 endfunction
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
51
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
52
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
53 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
54 %! assert (isempty (gcbo));