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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>User-Defined Preferences (GNU Octave (version 10.3.0))</title>
<meta name="description" content="User-Defined Preferences (GNU Octave (version 10.3.0))">
<meta name="keywords" content="User-Defined Preferences (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="GUI-Development.html" rel="up" title="GUI Development">
<link href="Octave-Workspace-Windows.html" rel="next" title="Octave Workspace Windows">
<link href="GUI-Utility-Functions.html" rel="prev" title="GUI Utility Functions">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="section-level-extent" id="User_002dDefined-Preferences">
<div class="nav-panel">
<p>
Next: <a href="Octave-Workspace-Windows.html" accesskey="n" rel="next">Octave Workspace Windows</a>, Previous: <a href="GUI-Utility-Functions.html" accesskey="p" rel="prev">GUI Utility Functions</a>, Up: <a href="GUI-Development.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="User_002dDefined-Preferences-1"><span>35.5 User-Defined Preferences<a class="copiable-link" href="#User_002dDefined-Preferences-1"> ¶</a></span></h3>
<a class="anchor" id="XREFgetpref"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getpref"><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">getpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", "<var class="var">pref</var>")</code><a class="copiable-link" href="#index-getpref"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-getpref-1"><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">getpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", "<var class="var">pref</var>", <var class="var">default</var>)</code><a class="copiable-link" href="#index-getpref-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-getpref-2"><span><code class="def-type">{<var class="var">val1</var>, <var class="var">val2</var>, …} =</code> <strong class="def-name">getpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", {"<var class="var">pref1</var>", "<var class="var">pref2"</var>, …})</code><a class="copiable-link" href="#index-getpref-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-getpref-3"><span><code class="def-type"><var class="var">prefstruct</var> =</code> <strong class="def-name">getpref</strong> <code class="def-code-arguments">("<var class="var">group</var>")</code><a class="copiable-link" href="#index-getpref-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-getpref-4"><span><code class="def-type"><var class="var">prefstruct</var> =</code> <strong class="def-name">getpref</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-getpref-4"> ¶</a></span></dt>
<dd><p>Return the preference value corresponding to the named preference <var class="var">pref</var>
in the preference group <var class="var">group</var>.
</p>
<p>The named preference group must be a string.
</p>
<p>If <var class="var">pref</var> does not exist in <var class="var">group</var> and <var class="var">default</var> is specified,
create the preference with value <var class="var">default</var> and return <var class="var">default</var>.
</p>
<p>The preference <var class="var">pref</var> may be a string or cell array of strings. If it
is a cell array of strings then a cell array of preferences is returned.
</p>
<p>The corresponding default value <var class="var">default</var> may be any Octave value,
.e.g., double, struct, cell array, object, etc. Or, if <var class="var">pref</var> is a cell
array of strings then <var class="var">default</var> must be a cell array of values with the
same size as <var class="var">pref</var>.
</p>
<p>If neither <var class="var">pref</var> nor <var class="var">default</var> are specified, return a structure
of preferences for the preference group <var class="var">group</var>.
</p>
<p>If no arguments are specified, return a structure containing all groups of
preferences and their values.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFaddpref">addpref</a>, <a class="ref" href="#XREFsetpref">setpref</a>, <a class="ref" href="#XREFispref">ispref</a>, <a class="ref" href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a class="anchor" id="XREFsetpref"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-setpref"><span><strong class="def-name">setpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", "<var class="var">pref</var>", <var class="var">val</var>)</code><a class="copiable-link" href="#index-setpref"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-setpref-1"><span><strong class="def-name">setpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", {"<var class="var">pref1</var>", "<var class="var">pref2</var>", …}, {<var class="var">val1</var>, <var class="var">val2</var>, …})</code><a class="copiable-link" href="#index-setpref-1"> ¶</a></span></dt>
<dd><p>Set the preference <var class="var">pref</var> to the given <var class="var">val</var> in the named preference
group <var class="var">group</var>.
</p>
<p>The named preference group must be a string.
</p>
<p>The preference <var class="var">pref</var> may be a string or a cell array of strings.
</p>
<p>The corresponding value <var class="var">val</var> may be any Octave value, .e.g., double,
struct, cell array, object, etc. Or, if <var class="var">pref</var> is a cell array of
strings then <var class="var">val</var> must be a cell array of values with the same size as
<var class="var">pref</var>.
</p>
<p>If the named preference or group does not exist, it is added.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFaddpref">addpref</a>, <a class="ref" href="#XREFgetpref">getpref</a>, <a class="ref" href="#XREFispref">ispref</a>, <a class="ref" href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a class="anchor" id="XREFaddpref"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-addpref"><span><strong class="def-name">addpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", "<var class="var">pref</var>", <var class="var">val</var>)</code><a class="copiable-link" href="#index-addpref"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-addpref-1"><span><strong class="def-name">addpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", {"<var class="var">pref1</var>", "<var class="var">pref2</var>", …}, {<var class="var">val1</var>, <var class="var">val2</var>, …})</code><a class="copiable-link" href="#index-addpref-1"> ¶</a></span></dt>
<dd><p>Add the preference <var class="var">pref</var> and associated value <var class="var">val</var> to the named
preference group <var class="var">group</var>.
</p>
<p>The named preference group must be a string.
</p>
<p>The preference <var class="var">pref</var> may be a string or a cell array of strings. An
error will be issued if the preference already exists.
</p>
<p>The corresponding value <var class="var">val</var> may be any Octave value, .e.g., double,
struct, cell array, object, etc. Or, if <var class="var">pref</var> is a cell array of
strings then <var class="var">val</var> must be a cell array of values with the same size as
<var class="var">pref</var>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFsetpref">setpref</a>, <a class="ref" href="#XREFgetpref">getpref</a>, <a class="ref" href="#XREFispref">ispref</a>, <a class="ref" href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a class="anchor" id="XREFrmpref"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-rmpref"><span><strong class="def-name">rmpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", "<var class="var">pref</var>")</code><a class="copiable-link" href="#index-rmpref"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-rmpref-1"><span><strong class="def-name">rmpref</strong> <code class="def-code-arguments">("<var class="var">group</var>", {"<var class="var">pref1</var>", "<var class="var">pref2</var>", …})</code><a class="copiable-link" href="#index-rmpref-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-rmpref-2"><span><strong class="def-name">rmpref</strong> <code class="def-code-arguments">("<var class="var">group</var>")</code><a class="copiable-link" href="#index-rmpref-2"> ¶</a></span></dt>
<dd><p>Remove the named preference <var class="var">pref</var> from the preference group
<var class="var">group</var>.
</p>
<p>The named preference group must be a string.
</p>
<p>The preference <var class="var">pref</var> may be a string or cell array of strings.
</p>
<p>If <var class="var">pref</var> is not specified, remove the preference group <var class="var">group</var>.
</p>
<p>It is an error to remove a nonexistent preference or group.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFaddpref">addpref</a>, <a class="ref" href="#XREFispref">ispref</a>, <a class="ref" href="#XREFsetpref">setpref</a>, <a class="ref" href="#XREFgetpref">getpref</a>.
</p></dd></dl>
<a class="anchor" id="XREFispref"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-ispref"><span><code class="def-type"><var class="var">tf</var> =</code> <strong class="def-name">ispref</strong> <code class="def-code-arguments">("<var class="var">group</var>", "<var class="var">pref</var>")</code><a class="copiable-link" href="#index-ispref"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-ispref-1"><span><code class="def-type"><var class="var">tf</var> =</code> <strong class="def-name">ispref</strong> <code class="def-code-arguments">("<var class="var">group</var>", {"<var class="var">pref1</var>", "<var class="var">pref2"</var>, …})</code><a class="copiable-link" href="#index-ispref-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-ispref-2"><span><code class="def-type"><var class="var">tf</var> =</code> <strong class="def-name">ispref</strong> <code class="def-code-arguments">("<var class="var">group</var>")</code><a class="copiable-link" href="#index-ispref-2"> ¶</a></span></dt>
<dd><p>Return true if the named preference <var class="var">pref</var> exists in the preference
group <var class="var">group</var>.
</p>
<p>The named preference group must be a string.
</p>
<p>The preference <var class="var">pref</var> may be a string or a cell array of strings.
</p>
<p>If <var class="var">pref</var> is not specified, return true if the preference group
<var class="var">group</var> exists.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetpref">getpref</a>, <a class="ref" href="#XREFaddpref">addpref</a>, <a class="ref" href="#XREFsetpref">setpref</a>, <a class="ref" href="#XREFrmpref">rmpref</a>.
</p></dd></dl>
<a class="anchor" id="XREFprefdir"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-prefdir"><span><code class="def-type"><var class="var">dir</var> =</code> <strong class="def-name">prefdir</strong><a class="copiable-link" href="#index-prefdir"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-prefdir-1"><span><code class="def-type"><var class="var">dir</var> =</code> <strong class="def-name">prefdir</strong> <code class="def-code-arguments">(1)</code><a class="copiable-link" href="#index-prefdir-1"> ¶</a></span></dt>
<dd><p>Return the directory that holds the preferences for Octave.
</p>
<p>Examples:
</p>
<p>Display the preferences directory
</p>
<div class="example">
<pre class="example-preformatted">prefdir
</pre></div>
<p>Change to the preferences folder
</p>
<div class="example">
<pre class="example-preformatted">cd (prefdir)
</pre></div>
<p>If called with an argument, the preferences directory is created if it
doesn’t already exist.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetpref">getpref</a>, <a class="ref" href="#XREFsetpref">setpref</a>, <a class="ref" href="#XREFaddpref">addpref</a>, <a class="ref" href="#XREFrmpref">rmpref</a>, <a class="ref" href="#XREFispref">ispref</a>.
</p></dd></dl>
<a class="anchor" id="XREFpreferences"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-preferences"><span><strong class="def-name">preferences</strong><a class="copiable-link" href="#index-preferences"> ¶</a></span></dt>
<dd><p>Display the GUI preferences dialog window for Octave.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Octave-Workspace-Windows.html">Octave Workspace Windows</a>, Previous: <a href="GUI-Utility-Functions.html">GUI Utility Functions</a>, Up: <a href="GUI-Development.html">GUI Development</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
