This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchParamProp.html is in libinstpatch-doc 1.0.0-7.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchParamProp</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch02.html" title="Utility objects and functions">
<link rel="prev" href="IpatchSF2VoiceCache.html" title="IpatchSF2VoiceCache">
<link rel="next" href="libinstpatch-IpatchTypeProp.html" title="IpatchTypeProp">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IpatchSF2VoiceCache.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="libinstpatch-IpatchTypeProp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinstpatch-IpatchParamProp.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-IpatchParamProp.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="IpatchParamProp">
<a name="libinstpatch-IpatchParamProp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchParamProp.top_of_page"></a>IpatchParamProp</span></h2>
<p>IpatchParamProp — GParamSpec extended properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchParamProp.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchParamProp.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#IPATCH-PARAM-USER-SHIFT--CAPS"
>IPATCH_PARAM_USER_SHIFT</a>
void                <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-install-property"
>ipatch_param_install_property</a>       (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *prop_spec);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *        <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-find-property"
>ipatch_param_find_property</a>          (const char *name);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> **       <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-list-properties"
>ipatch_param_list_properties</a>        (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *n_properties);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *        <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-set"
>ipatch_param_set</a>                    (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         ...);
void                <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-set-valist"
>ipatch_param_set_valist</a>             (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         va_list args);
void                <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-set-property"
>ipatch_param_set_property</a>           (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *property_name,
                                                         const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
void                <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-get"
>ipatch_param_get</a>                    (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         ...);
void                <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-get-valist"
>ipatch_param_get_valist</a>             (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         va_list args);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-get-property"
>ipatch_param_get_property</a>           (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *property_name,
                                                         <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchParamProp.description"></a><h2>Description</h2>
<p>
Extensions to standard GParamSpec include flags (for
compact single bit data extensions) and GValue based extensions.
An example of usage is the IPATCH_PARAM_UNIQUE flag which indicates
a parameter that should be unique amongst sibling items and the
"string-max-length" integer GValue which specifies a max
length of a GParamSpecString parameter.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchParamProp.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_PARAM_USER_SHIFT">
<a name="IPATCH-PARAM-USER-SHIFT--CAPS"></a><h3>IPATCH_PARAM_USER_SHIFT</h3>
<pre class="programlisting">#define IPATCH_PARAM_USER_SHIFT  (G_PARAM_USER_SHIFT + 12)
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_param_install_property ()">
<a name="ipatch-param-install-property"></a><h3>ipatch_param_install_property ()</h3>
<pre class="programlisting">void                ipatch_param_install_property       (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *prop_spec);</pre>
<p>
Install a new <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> property which can be used to extend existing
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> types or define common parameters shared by all types. An
example property is the "string-max-length" property which defines a
max length for use with <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecString"
><span class="type">GParamSpecString</span></a> properties.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>prop_spec</code></em> :</span></p></td>
<td> Specification for the new <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> property.  Ownership
  of the GParamSpec is taken over by this function.  The name field of
  the GParamSpec should be a static string and is used as the property's
  ID.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_find_property ()">
<a name="ipatch-param-find-property"></a><h3>ipatch_param_find_property ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *        ipatch_param_find_property          (const char *name);</pre>
<p>
Lookup a GParamSpec property by name.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Name of GParamSpec property
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The matching GParamSpec or <code class="literal">NULL</code> if not found.  The GParamSpec is
  internal and should NOT be modified or freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_list_properties ()">
<a name="ipatch-param-list-properties"></a><h3>ipatch_param_list_properties ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> **       ipatch_param_list_properties        (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *n_properties);</pre>
<p>
Get a list of all registered GParamSpec properties.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_properties</code></em> :</span></p></td>
<td> Output: Length of returned array
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> An array of GParamSpecs which should be freed when finished.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_set ()">
<a name="ipatch-param-set"></a><h3>ipatch_param_set ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *        ipatch_param_set                    (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         ...);</pre>
<p>
Set extended parameter properties.  Parameter properties are used to
extend existing <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> types.  "string-max-length" is an example of
an extended property, which is used for <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecString"
><span class="type">GParamSpecString</span></a> parameters to
define the max allowed length.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
<td> Parameter spec to set extended properties of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
<td> Name of first property to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> Value of first property to set and optionally followed by more
  property name/value pairs, terminated with <code class="literal">NULL</code> name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The <em class="parameter"><code>spec</code></em> pointer for convenience, makes it easy to create/install
  a parameter spec and set its properties at the same time.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_set_valist ()">
<a name="ipatch-param-set-valist"></a><h3>ipatch_param_set_valist ()</h3>
<pre class="programlisting">void                ipatch_param_set_valist             (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         va_list args);</pre>
<p>
Like <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-set"
><code class="function">ipatch_param_set()</code></a> but uses a va_list.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
<td> Parameter spec to set extended properties of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
<td> Name of first property to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
<td> Value of first property to set and optionally followed by more
  property name/value pairs, terminated with <code class="literal">NULL</code> name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_set_property ()">
<a name="ipatch-param-set-property"></a><h3>ipatch_param_set_property ()</h3>
<pre class="programlisting">void                ipatch_param_set_property           (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *property_name,
                                                         const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Set a single extended parameter property of a <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
<td> Parameter spec to set an extended property of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
<td> Name of property to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> Value to set the the property to. The value's
  type must be the same as the parameter property's type.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_get ()">
<a name="ipatch-param-get"></a><h3>ipatch_param_get ()</h3>
<pre class="programlisting">void                ipatch_param_get                    (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         ...);</pre>
<p>
Get extended parameter properties.  Parameter properties are used to
extend existing <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> types.  "string-max-length" is an example of
an extended property, which is used for <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecString"
><span class="type">GParamSpecString</span></a> parameters to
define the max allowed length.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
<td> Parameter spec to get extended properties from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
<td> Name of first property to get
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> Pointer to store first property value and optionally followed
  by more property name/value pairs, terminated with <code class="literal">NULL</code> name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_get_valist ()">
<a name="ipatch-param-get-valist"></a><h3>ipatch_param_get_valist ()</h3>
<pre class="programlisting">void                ipatch_param_get_valist             (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *first_property_name,
                                                         va_list args);</pre>
<p>
Like <a
href="../libinstpatch/libinstpatch-IpatchParamProp.html#ipatch-param-get"
><code class="function">ipatch_param_get()</code></a> but uses a va_list.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
<td> Parameter spec to get extended properties from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
<td> Name of first property to get
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
<td> Pointer to store first property value and optionally followed
  by more property name/value pairs, terminated with <code class="literal">NULL</code> name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_param_get_property ()">
<a name="ipatch-param-get-property"></a><h3>ipatch_param_get_property ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_param_get_property           (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *spec,
                                                         const char *property_name,
                                                         <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Get a single extended parameter property from a <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
<td> Parameter spec to get an extended property from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
<td> Name of property to get
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> An initialized value to store the property value in. The value's
  type must be a type that the property can be transformed to.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the parameter property is set, <code class="literal">FALSE</code> otherwise (in which
  case <em class="parameter"><code>value</code></em> will contain the default value for this property).
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>