Mercurial > octave-nkf
annotate scripts/plot/util/allchild.m @ 20626:5fc798a9b32c
maint: Periodic merge of stable to default.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 09 Oct 2015 19:28:05 -0700 |
parents | 777f26aa8e3e |
children |
rev | line source |
---|---|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17868
diff
changeset
|
1 ## Copyright (C) 2008-2015 Bill Denney |
7557 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
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. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
16 ## along with Octave; see the file COPYING. If not, see | |
17 ## <http://www.gnu.org/licenses/>. | |
18 | |
19 ## -*- texinfo -*- | |
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 | 22 ## |
17133
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
23 ## This function is similar to @code{get (h, "children")}, but also returns |
20208
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
24 ## hidden objects (HandleVisibility = @qcode{"off"}). |
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
25 ## |
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
26 ## If @var{handles} is a scalar, @var{h} will be a vector. Otherwise, |
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
27 ## @var{h} will be a cell matrix of the same size as @var{handles} and each |
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
28 ## cell will contain a vector of handles. |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17119
diff
changeset
|
29 ## @seealso{findall, findobj, get, set} |
7557 | 30 ## @end deftypefn |
31 | |
32 ## Author: Bill Denney <bill@denney.ws> | |
33 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
9316
diff
changeset
|
34 function h = allchild (handles) |
7557 | 35 |
17133
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
36 if (nargin != 1) |
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
37 print_usage (); |
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
38 endif |
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
39 |
8262
c44db9bad841
allchild.m: move get showhiddenhandles outside of unwind_protect block
John W. Eaton <jwe@octave.org>
parents:
7557
diff
changeset
|
40 shh = get (0, "showhiddenhandles"); |
7557 | 41 unwind_protect |
42 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
|
43 h = get (handles, "children"); |
7557 | 44 unwind_protect_cleanup |
45 set (0, "showhiddenhandles", shh); | |
46 end_unwind_protect | |
47 | |
48 endfunction | |
13096 | 49 |
13977
08ae07e40d4f
Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents:
13141
diff
changeset
|
50 |
08ae07e40d4f
Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents:
13141
diff
changeset
|
51 %!testif HAVE_FLTK |
17107
dbd64c9a16da
Restore graphics toolkit after %!tests that alter it.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
52 %! toolkit = graphics_toolkit ("fltk"); |
17119
bd50e0660545
test: Add missing semicolons to suppress output in some plot %!tests.
Rik <rik@octave.org>
parents:
17107
diff
changeset
|
53 %! 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
|
54 %! unwind_protect |
13096 | 55 %! l = line; |
17133
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
56 %! kids = allchild (hf); |
17868 | 57 %! assert (get (kids, "type"), {"axes"; "uimenu"; "uimenu"}); |
13096 | 58 %! unwind_protect_cleanup |
59 %! close (hf); | |
13977
08ae07e40d4f
Only run uimenu tests if FLTK toolkit is available (Bug #34908)
Rik <octave@nomad.inbox5.com>
parents:
13141
diff
changeset
|
60 %! graphics_toolkit (toolkit); |
13096 | 61 %! 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
|
62 |
17133
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
63 %!error allchild () |
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
64 %!error allchild (1, 2) |
04c3d56e007a
allchild.m: Add input validation, %!test blocks, and more documentation.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
65 |