Mercurial > hg > octave-nkf

annotate scripts/plot/util/isfigure.m @ 19069:afab3a2f57e7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update docstring for exist(). * variables.cc (Fexist): Update documentation string.
author Rik <rik@octave.org>
date Sun, 29 Jun 2014 12:58:22 -0700
parents d63878346099
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
1 ## Copyright (C) 2005-2013 John W. Eaton
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
2 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
4 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
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: 6895
diff changeset
8 ## your option) any later version.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
9 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
14 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 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: 6895
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: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
18
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} isfigure (@var{h})
17094
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
21 ## Return true if @var{h} is a figure graphics handle and false otherwise.
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
22 ##
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
23 ## If @var{h} is a matrix then return a logical array which is true where
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
24 ## the elements of @var{h} are figure graphics handles and false where
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
25 ## they are not.
17123
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents: 17094
diff changeset
26 ## @seealso{isaxes, ishandle}
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
28
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
29 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
30
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
31 function retval = isfigure (h)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
32
17094
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
33 if (nargin != 1)
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 print_usage ();
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 endif
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
36
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
37 hlist = ishandle (h);
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
38 if (any (hlist))
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
39 retval(hlist) = strcmp (get (h(hlist), "type"), "figure");
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
40 else
17094
60228ef13f20 isfigure.m: Expand to allow matrix inputs and return a logical array.
Rik <rik@octave.org>
parents: 14363
diff changeset
41 retval = hlist;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
42 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
43
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
44 endfunction
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
45
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
47 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13123
diff changeset
48 %! 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
49 %! unwind_protect
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13123
diff changeset
50 %! assert (isfigure (hf));
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
51 %! assert (! isfigure (-hf));
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
52 %! unwind_protect_cleanup
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
53 %! close (hf);
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
54 %! end_unwind_protect
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
55