Mercurial > hg > octave-lyh

comparison scripts/plot/struct2hdl.m @ 15007:8f0e3c5bfa5f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Periodic grammarcheck of documentation * fileattrib.m, glpk.m, axis.m, copyobj.m, gco.m, hdl2struct.m, struct2hdl.m, eigs.cc, variables.cc: Periodic grammarcheck of documentation
author Rik <rik@octave.org>
date Tue, 24 Jul 2012 09:34:51 -0700
parents 97ce18b62d0f
children f34bea431e4f
comparison
equal deleted inserted replaced
15006:d8acad691f26 15007:8f0e3c5bfa5f
16 16
17 ## -*- texinfo -*- 17 ## -*- texinfo -*-
18 ## @deftypefn {Function File} {@var{h} =} struct2hdl (@var{s}) 18 ## @deftypefn {Function File} {@var{h} =} struct2hdl (@var{s})
19 ## @deftypefnx {Function File} {@var{h} =} struct2hdl (@var{s}, @var{p}) 19 ## @deftypefnx {Function File} {@var{h} =} struct2hdl (@var{s}, @var{p})
20 ## @deftypefnx {Function File} {@var{h} =} struct2hdl (@var{s}, @var{p}, @var{hilev}) 20 ## @deftypefnx {Function File} {@var{h} =} struct2hdl (@var{s}, @var{p}, @var{hilev})
21 ## Constructs an object from the structure @var{s}. The structure must 21 ## Construct an object from the structure @var{s}. The structure must
22 ## contain the fields "handle", "type", "children", "properties", and 22 ## contain the fields "handle", "type", "children", "properties", and
23 ## "special". If the handle of an existing figure or axes is specified, 23 ## "special". If the handle of an existing figure or axes is specified,
24 ## @var{p}, the new object will be created as a child to that object. 24 ## @var{p}, the new object will be created as a child to that object.
25 ## If no object handle is provided, then a new figure and the necessary 25 ## If no object handle is provided, then a new figure and the necessary
26 ## children will be constructed using the default object values from 26 ## children will be constructed using the default object values from
27 ## the root figure. 27 ## the root figure.
28 ## 28 ##
29 ## A third boolean argument @var{hilev} can be passed to specify wether 29 ## A third boolean argument @var{hilev} can be passed to specify wether
30 ## the function should try to preserve listeners/calbacks e.g for 30 ## the function should try to preserve listeners/calbacks e.g., for
31 ## legends or hggroups. Default is false. 31 ## legends or hggroups. Default is false.
32 ## @seealso{findobj, get, hdl2struct, set} 32 ## @seealso{findobj, get, hdl2struct, set}
33 ## @end deftypefn 33 ## @end deftypefn
34 34
35 ## Author: pdiribarne <pdiribarne@new-host.home> 35 ## Author: pdiribarne <pdiribarne@new-host.home>
36 ## Created: 2012-03-04 36 ## Created: 2012-03-04