octave_packages/m/general/display.m

   1 ## Copyright (C) 2008-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} display (@var{a})
  21 ## Display the contents of an object.  If @var{a} is an object of the
  22 ## class "myclass", then @code{display} is called in a case like
  23 ##
  24 ## @example
  25 ## myclass (@dots{})
  26 ## @end example
  27 ##
  28 ## @noindent
  29 ## where Octave is required to display the contents of a variable of the
  30 ## type "myclass".
  31 ##
  32 ## @seealso{class, subsref, subsasgn}
  33 ## @end deftypefn
  34
  35 function idx = display (a)
  36
  37   if (nargin != 1)
  38     print_usage ();
  39   endif
  40
  41   ## Only reason we got here is that there was no overloaded display()
  42   ## function for object a.  This may mean it is a built-in.
  43   str = disp (a);
  44   if (isempty (strfind (str, "<class ")))
  45     disp (str);
  46   else
  47     error ('display: not defined for class "%s"', class (a));
  48   endif
  49
  50 endfunction