1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
########################################################################
##
## Copyright (C) 2007-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{parent} =} ancestor (@var{h}, @var{type})
## @deftypefnx {} {@var{parent} =} ancestor (@var{h}, @var{type}, "toplevel")
## Return the first ancestor of handle object @var{h} whose type matches
## @var{type}, where @var{type} is a character string.
##
## If @var{type} is a cell array of strings, return the first parent whose
## type matches any of the given type strings.
##
## If the handle object @var{h} itself is of type @var{type}, return @var{h}.
##
## If @qcode{"toplevel"} is given as a third argument, return the highest
## parent in the object hierarchy that matches the condition, instead
## of the first (nearest) one.
## @seealso{findobj, findall, allchild}
## @end deftypefn
function p = ancestor (h, type, toplevel)
if (nargin < 2)
print_usage ();
endif
if (ischar (type))
type = { type };
elseif (! iscellstr (type))
error ("ancestor: TYPE must be a string or cell array of strings");
endif
find_first = true;
if (nargin == 3)
if (ischar (toplevel) && strcmpi (toplevel, "toplevel"))
find_first = false;
else
error ('ancestor: third argument must be "toplevel"');
endif
endif
if (isempty (h))
p = [];
else
p = cell (numel (h), 1);
h = num2cell (h);
for nh = 1:numel (h)
while (true)
if (isempty (h{nh}) || ! ishghandle (h{nh}))
break;
endif
if (any (strcmpi (get (h{nh}, "type"), type)))
p{nh} = h{nh};
if (find_first)
break;
endif
endif
h{nh} = get (h{nh}, "parent");
endwhile
endfor
if (nh == 1)
p = p{1};
endif
endif
endfunction
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! hl = line ();
%! assert (ancestor (hl, "axes"), gca);
%! assert (ancestor (hl, "figure"), hf);
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! hg1 = hggroup ("parent", gca);
%! hg2 = hggroup ("parent", hg1);
%! hl = line ("parent", hg2);
%! assert (ancestor (hl, "line"), hl);
%! assert (ancestor (hl, "axes"), gca);
%! assert (ancestor (hl, "figure"), hf);
%! assert (ancestor (hl, "hggroup"), hg2);
%! assert (ancestor (hl, "hggroup", "toplevel"), hg1);
%! assert (ancestor (hl, {"hggroup", "axes"}), hg2);
%! assert (ancestor (hl, {"hggroup", "axes"}, "toplevel"), gca);
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!assert (ancestor ([], "axes"), [])
%!error <Invalid call> ancestor ()
%!error <TYPE must be a string> ancestor (1,2)
%!error <third argument must be "toplevel"> ancestor (1, "axes", "foo")
|
