octave_packages/m/prefs/ispref.m

   1 ## Copyright (C) 2012 John W. Eaton
   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} {} ispref (@var{group}, @var{pref})
  21 ## Return true if the named preference @var{pref} exists in the
  22 ## preference group @var{group}.
  23 ##
  24 ## The named preference group must be a character string.
  25 ##
  26 ## The preference @var{pref} may be a character string or a cell array
  27 ## of character strings.
  28 ##
  29 ## If @var{pref} is not specified, return true if the preference
  30 ## group @var{group} exists.
  31 ## @seealso{getpref, addpref, setpref, rmpref}
  32 ## @end deftypefn
  33
  34 ## Author: jwe
  35
  36 function retval = ispref (group, pref)
  37
  38   if (nargin == 1)
  39     retval = isfield (loadprefs (), group);
  40   elseif (nargin == 2)
  41     prefs = loadprefs ();
  42     if (isfield (prefs, group))
  43       grp = prefs.(group);
  44       if (ischar (pref) || iscellstr (pref))
  45         retval = isfield (grp, pref);
  46       else
  47         retval = false;
  48       endif
  49     else
  50       retval = false;
  51     endif
  52   else
  53     print_usage ();
  54   endif
  55
  56 endfunction
  57
  58 %% Testing these functions will require some care to avoid wiping out
  59 %% existing (or creating unwanted) preferences for the user running the
  60 %% tests.