Mercurial > octave

annotate scripts/gui/guihandles.m @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2012-2020 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
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
6 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
7 ## This file is part of Octave.
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24423
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
10 ## 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: 24423
diff changeset
11 ## 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
12 ## (at your option) any later version.
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
13 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
18 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
20 ## 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: 24423
diff changeset
21 ## <https://www.gnu.org/licenses/>.
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
22
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## @deftypefn {} {@var{hdata} =} guihandles (@var{h})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
25 ## @deftypefnx {} {@var{hdata} =} guihandles
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
26 ## Return a structure of object handles for the figure associated with
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
27 ## handle @var{h}.
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
28 ##
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
29 ## If no handle is specified the current figure returned by @code{gcf} is used.
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
30 ##
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
31 ## The fieldname for each entry of @var{hdata} is taken from the @qcode{"tag"}
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
32 ## property of the graphic object. If the tag is empty then the handle is not
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
33 ## returned. If there are multiple graphic objects with the same tag then
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
34 ## the entry in @var{hdata} will be a vector of handles. @code{guihandles}
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
35 ## includes all possible handles, including those for
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
36 ## which @qcode{"HandleVisibility"} is @qcode{"off"}.
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
37 ## @seealso{guidata, findobj, findall, allchild}
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
38 ## @end deftypefn
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
39
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
40 ## Author: goffioul
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
41
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
42 function hdata = guihandles (h)
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
43
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
44 if (nargin > 2)
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
45 print_usage ();
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
46 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
47
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
48 if (nargin == 1)
24423
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 23220
diff changeset
49 if (! ishghandle (h))
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
50 error ("guidata: H must be a valid object handle");
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
51 endif
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
52 h = ancestor (h, "figure");
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
53 if (isempty (h))
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
54 error ("guidata: no ancestor figure of H found");
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
55 endif
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
56 else
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
57 h = gcf ();
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
58 endif
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
59
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
60 hdata = __make_guihandles_struct__ (h, []);
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
61
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
62 endfunction
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
63
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
64 function hdata = __make_guihandles_struct__ (h, hdata)
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
65
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
66 tag = get (h, "tag");
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
67 if (! isempty (tag))
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
68 if (isfield (hdata, tag))
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
69 hdata.(tag) = [hdata.(tag), h];
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
70 else
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
71 try
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
72 hdata.(tag) = h;
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
73 catch
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
74 end_try_catch
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
75 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
76 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
77
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
78 kids = allchild (h);
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
79 for hkid = kids'
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
80 hdata = __make_guihandles_struct__ (hkid, hdata);
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
81 endfor
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
82
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
83 endfunction