octave_packages/m/prefs/setpref.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} {} setpref (@var{group}, @var{pref}, @var{val})
  21 ## Set a preference @var{pref} to the given @var{val} in the named
  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.  The corresponding value @var{val} may be any
  28 ## value, or, if @var{pref} is a cell array of strings, @var{val}
  29 ## must be a cell array of values with the same size as @var{pref}.
  30 ##
  31 ## If the named preference or group does not exist, it is added.
  32 ## @seealso{addpref, getpref, ispref, rmpref}
  33 ## @end deftypefn
  34
  35 ## Author: jwe
  36
  37 function setpref (group, pref, val)
  38
  39   if (nargin == 3)
  40     if (ischar (group))
  41       prefs = loadprefs ();
  42       if (ischar (pref))
  43         prefs.(group).(pref) = val;
  44       elseif (iscellstr (pref))
  45         if (size_equal (pref, val))
  46           for i = 1:numel(pref)
  47             prefs.(group).(pref{i}) = val;
  48           endfor
  49         else
  50           error ("size mismatch for pref and val");
  51         endif
  52       else
  53         error ("expecting pref to be a character string or cellstr");
  54       endif
  55       saveprefs (prefs);
  56     else
  57       error ("expecting group to be a character string");
  58     endif
  59   else
  60     print_usage ();
  61   endif
  62
  63 endfunction
  64
  65 %% Testing these functions will require some care to avoid wiping out
  66 %% existing (or creating unwanted) preferences for the user running the
  67 %% tests.