Mercurial > hg > octave-nkf

annotate scripts/gui/guihandles.m @ 20706:1339ad3c9faa stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typo in str2func docstring. * ov-fcn-handle.cc (Ffunc2str): Fix typo where 'a' should be '@'.
author Rik <rik@octave.org>
date Tue, 22 Sep 2015 02:06:17 -0700
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19790
diff changeset
1 ## Copyright (C) 2012-2015 Michael Goffioul
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
2 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
3 ## This file is part of Octave.
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
4 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
8 ## your option) any later version.
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
9 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
13 ## General Public License for more details.
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
14 ##
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
18
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
20 ## @deftypefn {Function File} {@var{hdata} =} guihandles (@var{h})
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
21 ## @deftypefnx {Function File} {@var{hdata} =} guihandles
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
22 ## Return a structure of object handles for the figure associated with
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
23 ## handle @var{h}.
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
24 ##
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
25 ## If no handle is specified the current figure returned by @code{gcf} is used.
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
26 ##
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
27 ## The fieldname for each entry of @var{hdata} is taken from the @qcode{"tag"}
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
28 ## property of the graphic object. If the tag is empty then the handle is not
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
29 ## returned. If there are multiple graphic objects with the same tag then
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
30 ## the entry in @var{hdata} will be a vector of handles. @code{guihandles}
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
31 ## includes all possible handles, including those for
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
32 ## which @qcode{"HandleVisibility"} is @qcode{"off"}.
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
33 ## @seealso{guidata, findobj, findall, allchild}
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
34 ## @end deftypefn
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
35
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
36 ## Author: goffioul
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
37
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
38 function hdata = guihandles (h)
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
39
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
40 if (nargin > 2)
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
41 print_usage ();
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
42 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
43
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
44 if (nargin == 1)
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
45 if (! ishandle (h))
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
46 error ("guidata: H must be a valid object handle");
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
47 endif
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
48 h = ancestor (h, "figure");
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
49 if (isempty (h))
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
50 error ("guidata: no ancestor figure of H found");
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
51 endif
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
52 else
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
53 h = gcf ();
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
54 endif
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
55
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
56 hdata = __make_guihandles_struct__ (h, []);
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
57
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
58 endfunction
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
59
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
60 function hdata = __make_guihandles_struct__ (h, hdata)
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
61
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
62 tag = get (h, "tag");
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
63 if (! isempty (tag))
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
64 if (isfield (hdata, tag))
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
65 hdata.(tag) = [hdata.(tag), h];
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
66 else
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
67 try
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
68 hdata.(tag) = h;
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
69 catch
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
70 end_try_catch
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
71 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
72 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
73
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
74 kids = allchild (h);
17485
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
75 for hkid = kids'
edd15fceff14 guihandles.m: Overhaul function.
Rik <rik@octave.org>
parents: 17338
diff changeset
76 hdata = __make_guihandles_struct__ (hkid, hdata);
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
77 endfor
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
78
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
79 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
80