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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: User-Defined Preferences</title>
<meta name="description" content="GNU Octave: User-Defined Preferences">
<meta name="keywords" content="GNU Octave: User-Defined Preferences">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="GUI-Development.html#GUI-Development" rel="up" title="GUI Development">
<link href="System-Utilities.html#System-Utilities" rel="next" title="System Utilities">
<link href="GUI-Utility-Functions.html#GUI-Utility-Functions" rel="prev" title="GUI Utility Functions">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="User_002dDefined-Preferences"></a>
<div class="header">
<p>
Previous: <a href="GUI-Utility-Functions.html#GUI-Utility-Functions" accesskey="p" rel="prev">GUI Utility Functions</a>, Up: <a href="GUI-Development.html#GUI-Development" accesskey="u" rel="up">GUI Development</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="User_002dDefined-Preferences-1"></a>
<h3 class="section">35.4 User-Defined Preferences</h3>
<a name="XREFgetpref"></a><dl>
<dt><a name="index-getpref"></a>Function File: <em></em> <strong>getpref</strong> <em>(<var>group</var>, <var>pref</var>, <var>default</var>)</em></dt>
<dd><p>Return the preference value corresponding to the named preference
<var>pref</var> in the preference group <var>group</var>.
</p>
<p>The named preference group must be a character string.
</p>
<p>If <var>pref</var> does not exist in <var>group</var> and <var>default</var> is
specified, return <var>default</var>.
</p>
<p>The preference <var>pref</var> may be a character string or a cell array
of character strings. The corresponding default value <var>default</var>
may be any value, or, if <var>pref</var> is a cell array of strings,
<var>default</var> must be a cell array of values with the same size as
<var>pref</var>.
</p>
<p>If neither <var>pref</var> nor <var>default</var> are specified, return a
structure of preferences for the preference group <var>group</var>.
</p>
<p>If no arguments are specified, return a structure containing all
groups of preferences and their values.
</p>
<p><strong>See also:</strong> <a href="#XREFaddpref">addpref</a>, <a href="#XREFsetpref">setpref</a>, <a href="#XREFispref">ispref</a>, <a href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a name="XREFsetpref"></a><dl>
<dt><a name="index-setpref"></a>Function File: <em></em> <strong>setpref</strong> <em>(<var>group</var>, <var>pref</var>, <var>val</var>)</em></dt>
<dd><p>Set a preference <var>pref</var> to the given <var>val</var> in the named
preference group <var>group</var>.
</p>
<p>The named preference group must be a character string.
</p>
<p>The preference <var>pref</var> may be a character string or a cell array
of character strings. The corresponding value <var>val</var> may be any
value, or, if <var>pref</var> is a cell array of strings, <var>val</var>
must be a cell array of values with the same size as <var>pref</var>.
</p>
<p>If the named preference or group does not exist, it is added.
</p>
<p><strong>See also:</strong> <a href="#XREFaddpref">addpref</a>, <a href="#XREFgetpref">getpref</a>, <a href="#XREFispref">ispref</a>, <a href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a name="XREFaddpref"></a><dl>
<dt><a name="index-addpref"></a>Function File: <em></em> <strong>addpref</strong> <em>(<var>group</var>, <var>pref</var>, <var>val</var>)</em></dt>
<dd><p>Add a preference <var>pref</var> and associated value <var>val</var> to the
named preference group <var>group</var>.
</p>
<p>The named preference group must be a character string.
</p>
<p>The preference <var>pref</var> may be a character string or a cell array
of character strings. The corresponding value <var>val</var> may be any
value, or, if <var>pref</var> is a cell array of strings, <var>val</var>
must be a cell array of values with the same size as <var>pref</var>.
</p>
<p><strong>See also:</strong> <a href="#XREFsetpref">setpref</a>, <a href="#XREFgetpref">getpref</a>, <a href="#XREFispref">ispref</a>, <a href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a name="XREFrmpref"></a><dl>
<dt><a name="index-rmpref"></a>Function File: <em></em> <strong>rmpref</strong> <em>(<var>group</var>)</em></dt>
<dt><a name="index-rmpref-1"></a>Function File: <em></em> <strong>rmpref</strong> <em>(<var>group</var>, <var>pref</var>)</em></dt>
<dd><p>Remove the named preference <var>pref</var> from the preference group
<var>group</var>.
</p>
<p>The named preference group must be a character string.
</p>
<p>The preference <var>pref</var> may be a character string or cell array
of strings.
</p>
<p>If <var>pref</var> is not specified, remove the preference group
<var>group</var>.
</p>
<p>It is an error to remove a nonexistent preference or group.
</p>
<p><strong>See also:</strong> <a href="#XREFaddpref">addpref</a>, <a href="#XREFispref">ispref</a>, <a href="#XREFsetpref">setpref</a>, <a href="#XREFgetpref">getpref</a>.
</p></dd></dl>
<a name="XREFispref"></a><dl>
<dt><a name="index-ispref"></a>Function File: <em></em> <strong>ispref</strong> <em>(<var>group</var>, <var>pref</var>)</em></dt>
<dd><p>Return true if the named preference <var>pref</var> exists in the
preference group <var>group</var>.
</p>
<p>The named preference group must be a character string.
</p>
<p>The preference <var>pref</var> may be a character string or a cell array
of character strings.
</p>
<p>If <var>pref</var> is not specified, return true if the preference
group <var>group</var> exists.
</p>
<p><strong>See also:</strong> <a href="#XREFgetpref">getpref</a>, <a href="#XREFaddpref">addpref</a>, <a href="#XREFsetpref">setpref</a>, <a href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a name="XREFprefdir"></a><dl>
<dt><a name="index-prefdir"></a>Command: <em></em> <strong>prefdir</strong></dt>
<dt><a name="index-prefdir-1"></a>Command: <em><var>dir</var> =</em> <strong>prefdir</strong></dt>
<dd><p>Return the directory that contains the preferences for Octave.
</p>
<p>Examples:
</p>
<p>Display the preferences directory
</p>
<div class="example">
<pre class="example">prefdir
</pre></div>
<p>Change to the preferences folder
</p>
<div class="example">
<pre class="example">cd (prefdir)
</pre></div>
<p><strong>See also:</strong> <a href="#XREFgetpref">getpref</a>, <a href="#XREFsetpref">setpref</a>, <a href="#XREFaddpref">addpref</a>, <a href="#XREFrmpref">rmpref</a>, <a href="#XREFispref">ispref</a>.
</p></dd></dl>
<a name="XREFpreferences"></a><dl>
<dt><a name="index-preferences"></a>Command: <em></em> <strong>preferences</strong></dt>
<dd><p>Display the GUI preferences dialog window for Octave.
</p></dd></dl>
<hr>
<div class="header">
<p>
Previous: <a href="GUI-Utility-Functions.html#GUI-Utility-Functions" accesskey="p" rel="prev">GUI Utility Functions</a>, Up: <a href="GUI-Development.html#GUI-Development" accesskey="u" rel="up">GUI Development</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|