6851
|
1 ## Copyright (C) 2007 Michael Goffioul |
|
2 ## |
7016
|
3 ## This file is part of Octave. |
6851
|
4 ## |
7016
|
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. |
6851
|
14 ## |
|
15 ## You should have received a copy of the GNU General Public License |
7016
|
16 ## along with Octave; see the file COPYING. If not, see |
|
17 ## <http://www.gnu.org/licenses/>. |
6851
|
18 |
|
19 ## -*- texinfo -*- |
|
20 ## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}) |
|
21 ## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, 'toplevel') |
|
22 ## Return the first ancestor of handle object @var{h} whose type matches |
|
23 ## @var{type}, where @var{type} is a character string. If @var{type} is a |
|
24 ## cell array of strings, return the first parent whose type matches |
|
25 ## any of the given type strings. |
|
26 ## |
|
27 ## If the handle object @var{h} is of type @var{type}, return @var{h}. |
|
28 ## |
|
29 ## If @code{"toplevel"} is given as a 3rd argument, return the highest |
|
30 ## parent in the object hierarchy that matches the condition, instead |
|
31 ## of the first (nearest) one. |
|
32 ## @seealso{get, set} |
|
33 ## @end deftypefn |
|
34 |
|
35 function p = ancestor (h, type, toplevel) |
|
36 |
|
37 if (nargin == 2 || nargin == 3) |
|
38 p = []; |
|
39 if (ischar (type)) |
|
40 type = { type }; |
|
41 endif |
|
42 if (iscellstr (type)) |
|
43 look_first = true; |
|
44 if (nargin == 3) |
|
45 if (ischar (toplevel) && strcmp (toplevel, "toplevel")) |
|
46 look_first = false; |
|
47 else |
|
48 error ("ancestor: third argument must be \"toplevel\""); |
|
49 endif |
|
50 endif |
|
51 while (true) |
|
52 if (isempty (h) || ! ishandle (h)) |
|
53 break; |
|
54 endif |
|
55 if (any (strcmpi (get (h, "type"), type))) |
|
56 p = h; |
|
57 if (look_first) |
|
58 break; |
|
59 endif |
|
60 endif |
|
61 h = get (h, "Parent"); |
|
62 endwhile |
|
63 else |
|
64 error ("ancestor: second argument must be a string or cell array of strings"); |
|
65 endif |
|
66 else |
|
67 print_usage (); |
|
68 endif |
|
69 |
|
70 endfunction |