Mercurial > octave
view scripts/gui/guidata.m @ 27923:bd51beb6205e
update formatting of copyright notices
* Use <https://octave.org/copyright/> instead of
<https://octave.org/COPYRIGHT.html/>.
* For consistency with other comments in the Octave sources, use
C++-style comments for copyright blocks in C and C++ files.
* Use delimiters above and below copyright blocks that are appropriate
for the language used in the file.
* Eliminate extra spacing inside copyright blocks.
* lex.ll (looks_like_copyright): Also allow newlines and carriage
returns before the word "Copyright".
* scripts/mk-doc.pl (gethelp): Also skip empty comment lines.
* bp-table.cc, type.m: Adjust tests.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 08 Jan 2020 11:59:41 -0500 |
parents | 1891570abac8 |
children | a4268efb7334 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2012-2020 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{data} =} guidata (@var{h}) ## @deftypefnx {} {} guidata (@var{h}, @var{data}) ## Query or set user-custom GUI data. ## ## The GUI data is stored in the figure handle @var{h}. If @var{h} is not a ## figure handle then it's parent figure will be used for storage. ## ## @var{data} must be a single object which means it is usually preferable ## for it to be a data container such as a cell array or struct so that ## additional data items can be added easily. ## ## @seealso{getappdata, setappdata, get, set, getpref, setpref} ## @end deftypefn ## Author: goffioul function dataout = guidata (h, data) if (nargin < 1 || nargin > 2) print_usage (); endif if (! ishghandle (h)) error ("guidata: H must be a valid object handle"); endif h = ancestor (h, "figure"); if (isempty (h)) error ("guidata: no ancestor figure of H found"); endif if (nargin == 1) dataout = get (h, "__guidata__"); else set (h, "__guidata__", data); if (nargout == 1) dataout = data; endif endif endfunction ## Test input validation %!error guidata () %!error guidata (1,2,3) %!error <H must be a valid object handle> guidata ({1}) %!error <no ancestor figure of H found> guidata (0)