view scripts/miscellaneous/getappdata.m @ 18479:85d31344fb23 stable rc-3-8-1-2

3.8.1 release candidate 2 * configure.ac (OCTAVE_VERSION): Bump to 3.8.1-rc2. (OCTAVE_MINOR_VERSION): Bump to 1-rc2. (OCTAVE_RELEASE_DATE): Set to 2014-02-14.
author John W. Eaton <jwe@octave.org>
date Mon, 17 Feb 2014 02:20:39 -0500
parents 0a8c35ae5ce1
children 7bbe3658c5ef 446c46af4b42
line wrap: on
line source

## Copyright (C) 2010-2013 Ben Abbott
##
## 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
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {@var{value} =} getappdata (@var{h}, @var{name})
## @deftypefnx {Function File} {@var{appdata} =} getappdata (@var{h})
## 
## Return the @var{value} for named application data for the object(s) with
## handle(s) @var{h}.
## 
## @code{getappdata(@var{h})} returns a structure, @var{appdata}, whose fields
## correspond to the appdata properties.
##
## @seealso{setappdata, guidata, get, set, getpref, setpref}
## @end deftypefn

## Author: Ben Abbott <bpabbott@mac.com>
## Created: 2010-07-15

function val = getappdata (h, name)

  if (all (ishandle (h)) && nargin == 2 && ischar (name))
    ## FIXME - Is there a better way to handle non-existent appdata
    ## and missing fields?
    val = cell (numel (h), 1);
    appdata = struct ();
    for nh = 1:numel (h)
      try
        appdata = get (h(nh), "__appdata__");
      end_try_catch
      if (! isfield (appdata, name))
        appdata.(name) = [];
      endif
      val(nh) = {appdata.(name)};
    endfor
    if (nh == 1)
      val = val{1};
    endif
  elseif (ishandle (h) && numel (h) == 1 && nargin == 1)
    try
      val = get (h, "__appdata__");
    catch
      val = struct ();
    end_try_catch
  else
    error ("getappdata: invalid input");
  endif

endfunction