annotate scripts/plot/ancestor.m @ 10549:95c3e38098bf

Untabify .m scripts
author Rik <code@nomad.inbox5.com>
date Fri, 23 Apr 2010 11:28:50 -0700
parents 16f53d29049f
children 3df114a44da3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9245
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9040
diff changeset
1 ## Copyright (C) 2007, 2008, 2009 Michael Goffioul
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
3 ## This file is part of Octave.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
13 ## General Public License for more details.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
14 ##
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
18
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type})
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, 'toplevel')
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
22 ## Return the first ancestor of handle object @var{h} whose type matches
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 ## @var{type}, where @var{type} is a character string. If @var{type} is a
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
24 ## cell array of strings, return the first parent whose type matches
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
25 ## any of the given type strings.
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
26 ##
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
27 ## If the handle object @var{h} is of type @var{type}, return @var{h}.
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
28 ##
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
29 ## If @code{"toplevel"} is given as a 3rd argument, return the highest
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
30 ## parent in the object hierarchy that matches the condition, instead
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
31 ## of the first (nearest) one.
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
32 ## @seealso{get, set}
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
33 ## @end deftypefn
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
34
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
35 function p = ancestor (h, type, toplevel)
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
36
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 2 || nargin == 3)
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
38 p = [];
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
39 if (ischar (type))
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
40 type = { type };
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
41 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
42 if (iscellstr (type))
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
43 look_first = true;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
44 if (nargin == 3)
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7016
diff changeset
45 if (ischar (toplevel) && strcmpi (toplevel, "toplevel"))
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
46 look_first = false;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
47 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
48 error ("ancestor: third argument must be \"toplevel\"");
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
49 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
50 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
51 while (true)
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
52 if (isempty (h) || ! ishandle (h))
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
53 break;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
54 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
55 if (any (strcmpi (get (h, "type"), type)))
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
56 p = h;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
57 if (look_first)
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
58 break;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
59 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
60 endif
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
61 h = get (h, "Parent");
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
62 endwhile
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
63 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
64 error ("ancestor: second argument must be a string or cell array of strings");
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
65 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
66 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
67 print_usage ();
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
68 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
69
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
70 endfunction