Mercurial > hg > octave-lyh

annotate scripts/plot/allchild.m @ 17137:04c3d56e007a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
allchild.m: Add input validation, %!test blocks, and more documentation. * scripts/plot/allchild.m: Add input validation, %!test blocks, and more documentation.
author Rik <rik@octave.org>
date Thu, 01 Aug 2013 08:17:24 -0700
parents eaab03308c0b
children bc924baa2c4e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
1 ## Copyright (C) 2008-2012 Bill Denney
7557
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 ##
17137
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
23 ## This function is similar to @code{get (h, "children")}, but also returns
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
24 ## hidden objects ("HandleVisibility" = "off"). If @var{handles} is a scalar,
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
25 ## @var{h} will be a vector. Otherwise, @var{h} will be a cell matrix of the
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
26 ## same size as @var{handles} and each cell will contain a vector of handles.
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17123
diff changeset
27 ## @seealso{findall, findobj, get, set}
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
28 ## @end deftypefn
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
29
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
30 ## Author: Bill Denney <bill@denney.ws>
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
31
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 9316
diff changeset
32 function h = allchild (handles)
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
33
17137
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
34 if (nargin != 1)
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
35 print_usage ();
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
36 endif
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
37
8262
c44db9bad841 allchild.m: move get showhiddenhandles outside of unwind_protect block
John W. Eaton <jwe@octave.org>
parents: 7557
diff changeset
38 shh = get (0, "showhiddenhandles");
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
39 unwind_protect
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
40 set (0, "showhiddenhandles", "on");
13977
08ae07e40d4f Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
41 h = get (handles, "children");
7557
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
42 unwind_protect_cleanup
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
43 set (0, "showhiddenhandles", shh);
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
44 end_unwind_protect
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
45
2ba84879f961 allchild.m, findall.m: new functions
bill@denney.ws
parents:
diff changeset
46 endfunction
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
47
13977
08ae07e40d4f Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
48
08ae07e40d4f Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
49 %!testif HAVE_FLTK
17111
dbd64c9a16da Restore graphics toolkit after %!tests that alter it.
Rik <rik@octave.org>
parents: 14868
diff changeset
50 %! toolkit = graphics_toolkit ("fltk");
17123
bd50e0660545 test: Add missing semicolons to suppress output in some plot %!tests.
Rik <rik@octave.org>
parents: 17111
diff changeset
51 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
52 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
53 %! l = line;
17137
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
54 %! kids = allchild (hf);
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
55 %! assert (get (kids, "type"), {"axes"; "uimenu"; "uimenu"; "uimenu"});
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
56 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
57 %! close (hf);
13977
08ae07e40d4f Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
58 %! graphics_toolkit (toolkit);
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
59 %! end_unwind_protect
13977
08ae07e40d4f Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
60
17137
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
61 %!error allchild ()
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
62 %!error allchild (1, 2)
04c3d56e007a allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents: 17126
diff changeset
63