1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
########################################################################
##
## Copyright (C) 2012-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{s} =} hdl2struct (@var{h})
## Return a structure, @var{s}, whose fields describe the properties
## of the object, and its children, associated with the handle, @var{h}.
##
## The fields of the structure @var{s} are @qcode{"type"}, @qcode{"handle"},
## @qcode{"properties"}, @qcode{"children"}, and @qcode{"special"}.
## @seealso{struct2hdl, hgsave, findobj}
## @end deftypefn
function s = hdl2struct (h)
if (nargin < 1 || ! ishghandle (h))
print_usage ();
endif
hiddenh = get (0, "showhiddenhandles");
unwind_protect
set (0, "showhiddenhandles", "off");
## main object
s.handle = h;
s.type = get (h, "type");
s.properties = getprops (h);
s.children = [];
s.special = [];
## Process, in reverse order, all children except for
## legends, colorbars, uimenu, and hggroup children
ii = 0;
allkids = get (h, "children");
if (! strcmp (s.type, "hggroup"))
hnot = findobj (h, "-depth", 1, "tag", "legend", "-or", "tag", "colorbar",
"-or", "type", "uimenu");
kids = allkids(! ismember (allkids, hnot));
if (strcmp (s.type, "axes"))
## Check for polar plots with special "polar_grid" object
## FIXME: A hack to fix bug #62093.
kids = [kids; findall(h, "tag", "polar_grid")];
## Add legend markers which are normally hidden
if (strcmp (s.properties.tag, "legend"))
kids = [kids; findall(h, "-depth", 1, "type", "line", "-property", "markertruesize")];
endif
endif
nkids = length (kids);
for i = nkids:-1:1
s.children(++ii) = hdl2struct (kids(i));
endfor
endif
## Add non "children" children objects (title, xlabel, ...) and
## hggroup children and tag them in "special"
if (strcmp (s.type, "hggroup"))
special = allkids;
else
special = [];
endif
special = [special getspecial(h)];
nsp = length (special);
while (nsp)
ii += 1;
s.children(ii) = hdl2struct (special(nsp));
s.special(nsp) = ii;
nsp -= 1;
endwhile
if (strcmp (s.type, "axes") ...
&& ! any (strcmp (get (h, "tag"), {'colorbar', 'legend'})))
## look for legends and colorbars among axes brothers and add them
## to the children list
try
lg = get (h, "__legend_handle__");
catch
lg = [];
end_try_catch
nlg = length (lg);
if (nlg == 1)
ii += 1;
s.children(ii) = hdl2struct (lg);
elseif (nlg > 1)
## FIXME: Unreachable code now. Delete?
error ("hdl2struct: more than one legend found");
endif
try
cb = get (h, "__colorbar_handle__");
catch
cb = [];
end_try_catch
ncb = length (cb);
if (ncb == 1)
ii += 1;
s.children(ii) = hdl2struct (cb);
elseif (ncb > 1)
## FIXME: Unreachable code now. Delete?
error ("hdl2struct: more than one colorbar found");
endif
endif
unwind_protect_cleanup
set (0, "showhiddenhandles", hiddenh);
end_unwind_protect
endfunction
function hlist = getspecial (h)
## return handles to special children
hlist = [];
regkids = get (h, "children");
## inline version of allchild() for performance
set (0, "showhiddenhandles", "on");
allkids = get (h, "children");
set (0, "showhiddenhandles", "off");
speckids = ! ismember (allkids, regkids);
hlist = allkids(speckids);
hlist = hlist(:).'; # return row vector
endfunction
function propstruct = getprops (h)
persistent excluded;
if (isempty (excluded))
excluded = cell2struct (repmat ({[]}, 1, 17),
{"beingdeleted", "busyaction", "buttondownfcn", ...
"children", "clipping", "contextmenu", ...
"createfcn", "deletefcn", "handlevisibility", ...
"hittest", "interruptible", "parent", ...
"selected" , "selectionhighlight", ...
"selectedobject", "type", "uicontextmenu"}, 2);
endif
obj = get (h);
## get useful properties rejecting readonly, children, handles ...
fields = fieldnames (obj);
tf = isfield (excluded, fields);
propstruct = rmfield (obj, fields(tf));
## hidden properties
hidden_props = {"__appdata__", "__autopos_tag__", "looseinset", ...
"positionmode", "rotationmode", ...
"horizontalalignmentmode", "verticalalignmentmode"};
for prop = hidden_props
try
val = get (h, prop{1});
propstruct.(prop{1}) = val;
end_try_catch
endfor
endfunction
## FIXME: need validation tests
## FIXME: Need to test code for legends, colorbars.
|
