Mercurial > hg > octave-lyh

annotate scripts/plot/guidata.m @ 17495:995decfed6cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
guidata.m: Overhaul function to use modern Octave conventions. * scripts/plot/guidata.m: Match variable names in function header to documentation. Place input validation first. Add %!error input validation blocks.
author Rik <rik@octave.org>
date Wed, 25 Sep 2013 10:23:30 -0700
parents 1c89599167a6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13943
diff changeset
1 ## Copyright (C) 2012 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 -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
20 ## @deftypefn {Function File} {@var{data} =} guidata (@var{h})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
21 ## @deftypefnx {Function File} {} guidata (@var{h}, @var{data})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
22 ## Query or set user-custom GUI data.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
23 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
24 ## The GUI data is stored in the figure handle @var{h}. If @var{h} is not a
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
25 ## figure handle then it's parent figure will be used for storage.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
26 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
27 ## @var{data} must be a single object which means it is usually preferable
17495
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
28 ## for it to be a data container such as a cell array or struct so that
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
29 ## additional data items can be added easily.
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
30 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
31 ## @seealso{getappdata, setappdata, get, set, getpref, setpref}
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
32 ## @end deftypefn
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
33
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
34 ## Author: goffioul
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
35
17495
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
36 function dataout = guidata (h, data)
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
37
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
38 if (nargin < 1 || nargin > 2)
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
39 print_usage ();
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
40 endif
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
41
17495
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
42 if (! ishandle (h))
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
43 error ("guidata: H must be a valid object handle");
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
44 endif
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
45 h = ancestor (h, "figure");
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
46 if (isempty (h))
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
47 error ("guidata: no ancestor figure of H found");
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
48 endif
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
49
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
50 if (nargin == 1)
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
51 dataout = get (h, "__guidata__");
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
52 else
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
53 set (h, "__guidata__", data);
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
54 if (nargout == 1)
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
55 dataout = data;
13699
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
56 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
57 endif
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
58
dd9b32af0a01 Implement guidata/guihandles.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
59 endfunction
17346
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17126
diff changeset
60
17495
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
61
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
62 %% Test input validation
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
63 %!error guidata ()
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
64 %!error guidata (1,2,3)
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
65 %!error <H must be a valid object handle> guidata ({1})
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
66 %!error <no ancestor figure of H found> guidata (0)
995decfed6cc guidata.m: Overhaul function to use modern Octave conventions.
Rik <rik@octave.org>
parents: 17346
diff changeset
67