Mercurial > octave-nkf
annotate scripts/plot/util/isprop.m @ 18533:ea0d4dea1a17 stable
doc: Update documentation for functions in octave-value dir.
* ov-bool-mat.cc (Flogical): Document that input must be numeric.
Document incompatibility with Matlab regarding complex inputs.
* ov-cell.cc (Fcell): Add seealso references.
* ov-cell.cc (Fcellstr): Document that trailing spaces are trimmed.
Add seealso references.
* ov-cell.cc (Fstruct2cell): Use lowercase names in @var references.
* ov-class.cc (Fismethod): Add seealso reference to isprop.
* ov-class.cc (Fsuperiorto): Add seealso reference to inferiorto.
* ov-class.cc (Finferiorto): Add seealso reference to superiorto.
* ov-fcn-handle.cc (Ffunctions): Add table to documentation describing return
values.
* ov-fcn-handle.cc (Ffunc2str): Add seealso links to str2func, functions.
* ov-fcn-handle.cc (Fstr2func): Add seealso links to func2str, inline.
* ov-fcn-handle.cc (Fis_function_handle): Add seealso links to functions.
* ov-fcn-inline.cc (Finline): Add note that the use of inline is discouraged.
Add seealso link to str2func.
* ov-int16.cc (Fint16): Add seealso links to docstring.
* ov-int32.cc (Fint32): Add seealso links to docstring.
* ov-int64.cc (Fint64): Add seealso links to docstring.
* ov-int8.cc (Fint8): Add seealso links to docstring.
* ov-oncleanup.cc (FonCleanup): clarify docstring by using "function" rather
than "action" for what gets called when onCleanup object is destroyed.
* ov-struct.cc (Fstruct): Add additional calling forms. Add seealso links.
* ov-struct.cc (Fisfield): Add additional calling forms. Add seealso link.
* ov-struct.cc (Fnfields): Add seealso link.
* ov-struct.cc (Fcell2struct): Add additional calling forms. Add seealso link.
* ov-struct.cc (Frmfield): Emphasize that a copy of the struct is returned.
Add seealso link.
* ov-struct.cc (Fstruct_levels_to_print): Add seealso link to
print_struct_array_contents.
* ov-struct.cc (Fprint_struct_array_contents): Add seealso link to
struct_levels_to_print.
* ov-typeinfo.cc (Ftypeinfo): Add seealso links to class, isa.
* ov-uint16.cc (Fuint16): Add seealso links to docstring.
* ov-uint32.cc (Fuint32): Add seealso links to docstring.
* ov-uint64.cc (Fuint64): Add seealso links to docstring.
* ov-uint8.cc (Fuint8): Add seealso links to docstring.
* ov-usr-fcn.cc (Fnargin): Add example based on 'union' function.
* ov-usr-fcn.cc (Fnargout): Add example based on 'imread' function.
* ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring.
* ov.cc (Fsubsref): Rephrase one sentence.
* fieldnames.m: Add more functions to seealso links.
* getfield.m: Re-order seealso links.
* setfield.m: Re-order seealso links.
* isprop.m Add ismethod, isobject to seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 01 Mar 2014 21:50:13 -0800 |
| parents | d63878346099 |
| children | 2631484789cf |
| rev | line source |
|---|---|
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17572
diff
changeset
|
1 ## Copyright (C) 2010-2013 Ben Abbott |
| 11374 | 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 -*- | |
| 17488 | 20 ## @deftypefn {Function File} {@var{res} =} isprop (@var{h}, "@var{prop}") |
|
11431
0d9640d755b1
Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents:
11374
diff
changeset
|
21 ## Return true if @var{prop} is a property of the object with handle @var{h}. |
| 17488 | 22 ## |
| 23 ## @var{h} may also be an array of handles in which case @var{res} will be a | |
| 24 ## logical array indicating whether each handle has the property @var{prop}. | |
|
18533
ea0d4dea1a17
doc: Update documentation for functions in octave-value dir.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
25 ## @seealso{get, set, ismethod, isobject} |
| 11374 | 26 ## @end deftypefn |
| 27 | |
| 28 ## Author: Ben Abbott <bpabbott@mac.com> | |
| 29 | |
| 30 function res = isprop (h, prop) | |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
31 |
| 17488 | 32 if (nargin != 2) |
| 11374 | 33 print_usage (); |
| 34 endif | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
35 |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
36 if (! all (ishandle (h))) |
| 17488 | 37 error ("isprop: H must be a graphics handle or vector of handles"); |
| 11374 | 38 elseif (! ischar (prop)) |
| 17488 | 39 error ("isprop: PROP name must be a string"); |
| 11374 | 40 endif |
| 41 | |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
42 res = false (size (h)); |
| 17488 | 43 for i = 1:numel (res) |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
44 try |
| 17488 | 45 v = get (h(i), prop); |
| 46 res(i) = true; | |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
47 end_try_catch |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
48 endfor |
| 11374 | 49 endfunction |
| 50 | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
51 |
| 11374 | 52 %!assert (isprop (0, "foobar"), false) |
| 53 %!assert (isprop (0, "screenpixelsperinch"), true) | |
|
13214
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
54 %!assert (isprop (zeros (2, 3), "visible"), true (2, 3)) |
|
7715aca4bce1
Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
55 |
| 17488 | 56 %!error isprop () |
| 57 %!error isprop (1) | |
| 58 %!error isprop (1,2,3) | |
| 59 %!error <H must be a graphics handle> isprop ({1}, "visible") | |
| 60 %!error <PROP name must be a string> isprop (0, {"visible"}) | |
| 61 |