Mercurial > hg > octave-nkf
annotate scripts/plot/findobj.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 18 Jul 2010 20:35:16 -0700 |
| parents | 95c3e38098bf |
| children | fd0a3ac60b0e |
| rev | line source |
|---|---|
| 8920 | 1 ## Copyright (C) 2007, 2008, 2009 Ben Abbott |
| 6935 | 2 ## |
| 7016 | 3 ## This file is part of Octave. |
| 6935 | 4 ## |
| 7016 | 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. | |
| 6935 | 14 ## |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 6935 | 18 |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
20 ## @deftypefn {Function File} {@var{h} =} findobj () |
| 8507 | 21 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}) |
| 22 ## @deftypefnx {Function File} {@var{h} =} findobj ('-property', @var{prop_name}) | |
| 23 ## @deftypefnx {Function File} {@var{h} =} findobj ('-regexp', @var{prop_name}, @var{pattern}) | |
| 6935 | 24 ## @deftypefnx {Function File} {@var{h} =} findobj ('flat', @dots{}) |
| 25 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, @dots{}) | |
| 26 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, '-depth', @var{d}, @dots{}) | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
27 ## Find object with specified property values. The simplest form is |
| 6935 | 28 ## |
| 29 ## @example | |
| 8507 | 30 ## findobj (@var{prop_name}, @var{prop_Value}) |
| 6935 | 31 ## @end example |
| 32 ## | |
| 33 ## @noindent | |
| 34 ## which returns all of the handles to the objects with the name | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
35 ## @var{prop_name} and the name @var{prop_Value}. The search can be limited |
| 6935 | 36 ## to a particular object or set of objects and their descendants by |
| 37 ## passing a handle or set of handles @var{h} as the first argument to | |
| 38 ## @code{findobj}. | |
| 39 ## | |
| 40 ## The depth of hierarchy of objects to which to search to can be limited | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
41 ## with the '-depth' argument. To limit the number depth of the hierarchy |
| 6935 | 42 ## to search to @var{d} generations of children, and example is |
| 43 ## | |
| 44 ## @example | |
| 8507 | 45 ## findobj (@var{h}, '-depth', @var{d}, @var{prop_Name}, @var{prop_Value}) |
| 6935 | 46 ## @end example |
| 47 ## | |
| 48 ## Specifying a depth @var{d} of 0, limits the search to the set of object | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
49 ## passed in @var{h}. A depth @var{d} of 0 is equivalent to the '-flat' |
| 6935 | 50 ## argument. |
| 51 ## | |
| 8507 | 52 ## A specified logical operator may be applied to the pairs of @var{prop_Name} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
53 ## and @var{prop_Value}. The supported logical operators are '-and', '-or', |
| 6935 | 54 ## '-xor', '-not'. |
| 55 ## | |
| 56 ## The objects may also be matched by comparing a regular expression to the | |
| 57 ## property values, where property values that match @code{regexp | |
| 8507 | 58 ## (@var{prop_Value}, @var{pattern})} are returned. Finally, objects may be |
| 6935 | 59 ## matched by property name only, using the '-property' option. |
| 60 ## @seealso{get, set} | |
| 61 ## @end deftypefn | |
| 62 | |
| 7017 | 63 ## Author: Ben Abbott <bpabbott@mac.com> |
| 64 | |
| 6935 | 65 function h = findobj (varargin) |
| 66 | |
| 67 depth = NaN; | |
| 68 if (nargin == 0) | |
| 69 handles = 0; | |
| 70 n1 = 0; | |
| 71 else | |
|
8265
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
72 if (! isempty (varargin{1})) |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
73 if (ishandle (varargin{1}(1))) |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
74 handles = varargin{1}; |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
75 n1 = 2; |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
76 else |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
77 handles = 0; |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
78 n1 = 1; |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
79 endif |
| 6935 | 80 else |
|
8265
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
81 ## Return [](0x1) for compatibility. |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
82 h = zeros (0, 1); |
|
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
83 return; |
| 7151 | 84 endif |
| 6935 | 85 if (n1 <= nargin) |
| 86 if (ischar (varargin{n1})) | |
| 10549 | 87 if (strcmpi (varargin{n1}, "flat")) |
| 88 depth = 0; | |
| 89 n1 = n1 + 1; | |
| 90 elseif (strcmpi (varargin{n1}, "-depth")) | |
| 91 depth = varargin{n1+1}; | |
| 92 n1 = n1 + 2; | |
| 93 endif | |
| 6935 | 94 else |
| 10549 | 95 error ("findobj: properties and options must be strings"); |
| 6935 | 96 endif |
| 97 endif | |
| 98 endif | |
| 99 | |
| 100 if (n1 <= nargin && nargin > 0) | |
| 101 args = varargin(n1 : nargin); | |
| 102 else | |
| 103 args = {}; | |
| 104 endif | |
| 105 | |
| 106 regularexpression = []; | |
| 107 property = []; | |
| 108 logicaloperator = {}; | |
| 109 pname = {}; | |
| 110 pvalue = {}; | |
| 111 np = 1; | |
| 112 na = 1; | |
| 113 | |
| 114 while (na <= numel (args)) | |
| 115 regularexpression(np) = 0; | |
| 116 property(np) = 0; | |
|
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
117 logicaloperator{np} = "and"; |
| 7208 | 118 if (ischar (args{na})) |
|
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
119 if (strcmpi (args{na}, "-regexp")) |
| 10549 | 120 if (na + 2 <= numel (args)) |
| 121 regularexpression(np) = 1; | |
| 122 na = na + 1; | |
| 123 pname{np} = args{na}; | |
| 124 na = na + 1; | |
| 125 pvalue{np} = args{na}; | |
| 126 na = na + 1; | |
| 127 np = np + 1; | |
| 128 else | |
| 129 error ("findobj: inconsistent number of arguments"); | |
| 130 endif | |
|
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
131 elseif (strcmpi (args{na}, "-property")) |
| 10549 | 132 if (na + 1 <= numel (args)) |
| 133 na = na + 1; | |
| 134 property(np) = 1; | |
| 135 pname{np} = args{na}; | |
| 136 na = na + 1; | |
| 137 pvalue{np} = []; | |
| 138 np = np + 1; | |
| 139 else | |
| 140 error ("findobj: inconsistent number of arguments"); | |
| 141 endif | |
| 8506 | 142 elseif (! strcmp (args{na}(1), "-")) |
| 10549 | 143 ## Parameter/value pairs. |
| 144 if (na + 1 <= numel (args)) | |
| 145 pname{np} = args{na}; | |
| 146 na = na + 1; | |
| 147 pvalue{np} = args{na}; | |
| 148 na = na + 1; | |
| 149 if (na <= numel(args)) | |
| 150 if (ischar (args{na})) | |
| 151 if strcmpi(args{na}, "-and") | |
| 152 logicaloperator{np} = "and"; | |
| 153 na = na+1; | |
| 154 elseif strcmpi(args{na}, "-or") | |
| 155 logicaloperator{np} = "or"; | |
| 156 na = na+1; | |
| 157 elseif strcmpi(args{na}, "-xor") | |
| 158 logicaloperator{np} = "xor"; | |
| 159 na = na+1; | |
| 160 elseif strcmpi(args{na}, "-not") | |
| 161 logicaloperator{np} = "not"; | |
| 162 na = na+1; | |
| 163 endif | |
| 164 else | |
| 165 error ("findobj: properties and options must be strings"); | |
| 166 endif | |
| 167 else | |
| 168 logicaloperator{np} = "and"; | |
| 169 endif | |
| 170 np = np + 1; | |
| 171 else | |
| 172 error ("findobj: inconsistent number of arguments"); | |
| 173 endif | |
| 6935 | 174 else |
| 10549 | 175 ## This is sloppy ... but works like Matlab. |
| 176 if strcmpi(args{na}, "-not") | |
| 177 h = []; | |
| 178 return | |
| 179 endif | |
| 180 na = na + 1; | |
| 6935 | 181 endif |
| 182 else | |
| 183 error ("findobj: properties and options must be strings"); | |
| 184 endif | |
| 185 endwhile | |
| 186 | |
| 187 numpairs = np - 1; | |
| 188 | |
| 8506 | 189 ## Load all objects which qualify for being searched. |
| 6935 | 190 idepth = 0; |
| 191 h = handles; | |
| 192 while (numel (handles) && ! (idepth >= depth)) | |
| 193 children = []; | |
| 194 for n = 1 : numel (handles) | |
|
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
195 children = union (children, get(handles(n), "children")); |
| 6935 | 196 endfor |
| 197 handles = children; | |
| 198 h = union (h, children); | |
| 199 idepth = idepth + 1; | |
| 200 endwhile | |
| 201 | |
| 202 keepers = ones (size (h)); | |
| 203 if (numpairs > 0) | |
| 204 for nh = 1 : numel(h) | |
| 205 p = get (h (nh)); | |
| 206 for np = 1 : numpairs | |
| 10549 | 207 fields = fieldnames (p); |
| 208 fieldindex = find (strcmpi (fields, pname{np}), 1); | |
| 209 if (numel (fieldindex)) | |
| 6935 | 210 pname{np} = fields{fieldindex}; |
| 211 if (property(np)) | |
| 212 match = 1; | |
| 213 else | |
| 214 if (regularexpression(np)) | |
| 10549 | 215 match = regexp (p.(pname{np}), pvalue{np}); |
| 6935 | 216 if isempty (match) |
| 217 match = 0; | |
| 7151 | 218 endif |
| 6935 | 219 elseif (numel (p.(pname{np})) == numel (pvalue{np})) |
| 10549 | 220 if (ischar (pvalue{np})) |
| 221 match = strcmpi (pvalue{np}, p.(pname{np})); | |
| 222 else | |
| 223 match = (pvalue{np} == p.(pname{np})); | |
| 224 endif | |
| 6935 | 225 else |
| 10549 | 226 match = 0; |
| 6935 | 227 endif |
| 228 match = all (match); | |
| 229 endif | |
|
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
230 if (strcmpi (logicaloperator{np}, "not")) |
| 6935 | 231 keepers(nh) = ! keepers(nh) & ! match; |
| 232 else | |
| 233 keepers(nh) = feval (logicaloperator{np}, keepers(nh), match); | |
| 234 endif | |
| 10549 | 235 else |
| 236 keepers(nh) = 0; | |
| 237 endif | |
| 6935 | 238 endfor |
| 239 endfor | |
| 240 endif | |
| 241 | |
| 242 h = h (keepers != 0); | |
| 243 h = reshape (h, [numel(h), 1]); | |
| 244 endfunction |