1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
## Copyright (C) 2012-2013 John W. Eaton
##
## 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} {} getpref (@var{group}, @var{pref}, @var{default})
## Return the preference value corresponding to the named preference
## @var{pref} in the preference group @var{group}.
##
## The named preference group must be a character string.
##
## If @var{pref} does not exist in @var{group} and @var{default} is
## specified, return @var{default}.
##
## The preference @var{pref} may be a character string or a cell array
## of character strings. The corresponding default value @var{default}
## may be any value, or, if @var{pref} is a cell array of strings,
## @var{default} must be a cell array of values with the same size as
## @var{pref}.
##
## If neither @var{pref} nor @var{default} are specified, return a
## structure of preferences for the preference group @var{group}.
##
## If no arguments are specified, return a structure containing all
## groups of preferences and their values.
## @seealso{addpref, setpref, ispref, rmpref}
## @end deftypefn
## Author: jwe
function retval = getpref (group, pref, default)
if (nargin == 0)
retval = loadprefs ();
elseif (nargin == 1)
if (ischar (group))
prefs = loadprefs ();
if (isfield (prefs, group))
retval = prefs.(group);
else
retval = [];
endif
else
error ("expecting group to be a character string");
endif
elseif (nargin == 2 || nargin == 3)
grp = getpref (group);
if (ischar (pref))
if (isfield (grp, pref))
retval = grp.(pref);
elseif (nargin == 3)
retval = default;
else
error ("preference %s does not exist in group %s", pref, group);
endif
elseif (iscellstr (pref))
if (nargin == 2 || size_equal (pref, default))
for i = 1:numel (pref)
if (isfield (grp, pref{i}))
retval.(pref) = grp.(pref{i});
elseif (nargin == 3)
retval.(pref) = default{i};
else
error ("preference %s does not exist in group %s", pref{i}, group);
endif
endfor
else
error ("size mismatch for pref and default");
endif
else
error ("expecting pref to be a character string or cellstr");
endif
else
print_usage ();
endif
endfunction
%% Testing these functions will require some care to avoid wiping out
%% existing (or creating unwanted) preferences for the user running the
%% tests.
|