annotate scripts/plot/allchild.m @ 11469:c776f063fefe

Overhaul m-script files to use common variable name between code and documentation.
author Rik <octave@nomad.inbox5.com>
date Sun, 09 Jan 2011 12:41:21 -0800
parents c539ec5726e7
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
1 ## Copyright (C) 2008 Bill Denney
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
2 ##
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
3 ## This file is part of Octave.
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
4 ##
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
8 ## your option) any later version.
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
9 ##
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
13 ## General Public License for more details.
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
14 ##
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
18
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
19 ## -*- texinfo -*-
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} allchild (@var{handles})
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8262
diff changeset
21 ## Find all children, including hidden children, of a graphics object.
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
22 ##
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
23 ## This function is similar to @code{get (h, "children")}, but also
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
24 ## returns hidden objects. If @var{handles} is a scalar,
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8262
diff changeset
25 ## @var{h} will be a vector. Otherwise, @var{h} will be a cell matrix
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8262
diff changeset
26 ## of the same size as @var{handles} and each cell will contain a
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
27 ## vector of handles.
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
28 ## @seealso{get, set, findall, findobj}
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
29 ## @end deftypefn
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
30
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
31 ## Author: Bill Denney <bill@denney.ws>
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
32
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
33 function h = allchild (handles)
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
34
8262
c44db9bad841 allchild.m: move get showhiddenhandles outside of unwind_protect block
John W. Eaton <jwe@octave.org>
parents: 7557
diff changeset
35 shh = get (0, "showhiddenhandles");
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
36 unwind_protect
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
37 set (0, "showhiddenhandles", "on");
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
38 if (isscalar (handles))
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
39 h = get (handles, "children");
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
40 else
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
41 h = cell (size (handles));
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
42 for i = 1:numel (handles)
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
43 h{i} = get (handles, "children");
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
44 endfor
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
45 endif
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
46 unwind_protect_cleanup
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
47 set (0, "showhiddenhandles", shh);
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
48 end_unwind_protect
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
49
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
50 endfunction