/usr/share/gtk-doc/html/libinstpatch/IpatchSF2Zone.html is in libinstpatch-doc 1.0.0-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2Zone</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="ch05.html" title="SoundFont patches">
<link rel="prev" href="IpatchSF2Inst.html" title="IpatchSF2Inst">
<link rel="next" href="libinstpatch-IpatchSF2Gen.html" title="IpatchSF2Gen">
<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="IpatchSF2Inst.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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-IpatchSF2Gen.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSF2Zone.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchSF2Zone.description" class="shortcut">Description</a>
|
<a href="#IpatchSF2Zone.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchSF2Zone.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2Zone">
<a name="IpatchSF2Zone"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSF2Zone.top_of_page"></a>IpatchSF2Zone</span></h2>
<p>IpatchSF2Zone — Abstract base class for SoundFont zones</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSF2Zone.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSF2Zone.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchSF2Zone.html#IpatchSF2Zone-struct"
>IpatchSF2Zone</a>;
#define <a
href="../libinstpatch/IpatchSF2Zone.html#IPATCH-SF2-ZONE-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_SF2_ZONE_UNUSED_FLAG_SHIFT</a>
#define <a
href="../libinstpatch/IpatchSF2Zone.html#IPATCH-SF2-ZONE-GEN-AMT--CAPS"
>IPATCH_SF2_ZONE_GEN_AMT</a> (zone, genid)
#define <a
href="../libinstpatch/IpatchSF2Zone.html#IPATCH-SF2-ZONE-GEN-TEST-FLAG--CAPS"
>IPATCH_SF2_ZONE_GEN_TEST_FLAG</a> (zone, genid)
#define <a
href="../libinstpatch/IpatchSF2Zone.html#IPATCH-SF2-ZONE-GEN-SET-FLAG--CAPS"
>IPATCH_SF2_ZONE_GEN_SET_FLAG</a> (zone, genid)
#define <a
href="../libinstpatch/IpatchSF2Zone.html#IPATCH-SF2-ZONE-GEN-CLEAR-FLAG--CAPS"
>IPATCH_SF2_ZONE_GEN_CLEAR_FLAG</a> (zone, genid)
<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> * <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-first"
>ipatch_sf2_zone_first</a> (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> * <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-next"
>ipatch_sf2_zone_next</a> (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
void <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-set-link-item"
>ipatch_sf2_zone_set_link_item</a> (<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-set-link-item-no-notify"
>ipatch_sf2_zone_set_link_item_no_notify</a>
(<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> **olditem);
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> * <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-get-link-item"
>ipatch_sf2_zone_get_link_item</a> (<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone);
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> * <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-peek-link-item"
>ipatch_sf2_zone_peek_link_item</a> (<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSF2Zone.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
+----IpatchSF2Zone
+----<a
href="../libinstpatch/IpatchSF2IZone.html"
>IpatchSF2IZone</a>
+----<a
href="../libinstpatch/IpatchSF2PZone.html"
>IpatchSF2PZone</a>
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSF2Zone.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSF2Zone implements
<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItemIface"
>IpatchSF2ModItemIface</a>.</p>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSF2Zone.description"></a><h2>Description</h2>
<p>
Zones are children of <a
href="../libinstpatch/IpatchSF2Preset.html"
><span class="type">IpatchSF2Preset</span></a> and <a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a> and define
synthesis parameters and a linked item (<a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a> in the case of
<a
href="../libinstpatch/IpatchSF2PZone.html"
><span class="type">IpatchSF2PZone</span></a> and <a
href="../libinstpatch/IpatchSF2Sample.html"
><span class="type">IpatchSF2Sample</span></a> in the case of <a
href="../libinstpatch/IpatchSF2IZone.html"
><span class="type">IpatchSF2IZone</span></a>).</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSF2Zone.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSF2Zone">
<a name="IpatchSF2Zone-struct"></a><h3>IpatchSF2Zone</h3>
<pre class="programlisting">typedef struct _IpatchSF2Zone IpatchSF2Zone;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_ZONE_UNUSED_FLAG_SHIFT">
<a name="IPATCH-SF2-ZONE-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_SF2_ZONE_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SF2_ZONE_UNUSED_FLAG_SHIFT (IPATCH_ITEM_UNUSED_FLAG_SHIFT + 2)
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_ZONE_GEN_AMT()">
<a name="IPATCH-SF2-ZONE-GEN-AMT--CAPS"></a><h3>IPATCH_SF2_ZONE_GEN_AMT()</h3>
<pre class="programlisting">#define IPATCH_SF2_ZONE_GEN_AMT(zone, genid)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_ZONE_GEN_TEST_FLAG()">
<a name="IPATCH-SF2-ZONE-GEN-TEST-FLAG--CAPS"></a><h3>IPATCH_SF2_ZONE_GEN_TEST_FLAG()</h3>
<pre class="programlisting">#define IPATCH_SF2_ZONE_GEN_TEST_FLAG(zone, genid)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_ZONE_GEN_SET_FLAG()">
<a name="IPATCH-SF2-ZONE-GEN-SET-FLAG--CAPS"></a><h3>IPATCH_SF2_ZONE_GEN_SET_FLAG()</h3>
<pre class="programlisting">#define IPATCH_SF2_ZONE_GEN_SET_FLAG(zone, genid)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_ZONE_GEN_CLEAR_FLAG()">
<a name="IPATCH-SF2-ZONE-GEN-CLEAR-FLAG--CAPS"></a><h3>IPATCH_SF2_ZONE_GEN_CLEAR_FLAG()</h3>
<pre class="programlisting">#define IPATCH_SF2_ZONE_GEN_CLEAR_FLAG(zone, genid)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_zone_first ()">
<a name="ipatch-sf2-zone-first"></a><h3>ipatch_sf2_zone_first ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> * ipatch_sf2_zone_first (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the first item in a zone iterator. A convenience
wrapper for <a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-first"
><code class="function">ipatch_iter_first()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchSF2Zone.html"
><span class="type">IpatchSF2Zone</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first zone in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if empty.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_zone_next ()">
<a name="ipatch-sf2-zone-next"></a><h3>ipatch_sf2_zone_next ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> * ipatch_sf2_zone_next (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the next item in a zone iterator. A convenience wrapper
for <a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-next"
><code class="function">ipatch_iter_next()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchSF2Zone.html"
><span class="type">IpatchSF2Zone</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next zone in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if at the end of
the list.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_zone_set_link_item ()">
<a name="ipatch-sf2-zone-set-link-item"></a><h3>ipatch_sf2_zone_set_link_item ()</h3>
<pre class="programlisting">void ipatch_sf2_zone_set_link_item (<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
Sets the referenced item of a zone (a <a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a> for preset zones,
<a
href="../libinstpatch/IpatchSF2Sample.html"
><span class="type">IpatchSF2Sample</span></a> for instrument zones). The type specific item set routines
for each zone type may be preferred, as this one doesn't do strict type
checking.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td> Zone to set zone item of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> New item for zone to use
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_zone_set_link_item_no_notify ()">
<a name="ipatch-sf2-zone-set-link-item-no-notify"></a><h3>ipatch_sf2_zone_set_link_item_no_notify ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_zone_set_link_item_no_notify
(<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> **olditem);</pre>
<p>
Like <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-set-link-item"
><code class="function">ipatch_sf2_zone_set_link_item()</code></a> but performs no property or item
change notifications (shouldn't normally be used outside of derived types),
and the old value can be retrieved with the <em class="parameter"><code>olditem</code></em> parameter.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td> Zone to set zone item of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> New item for zone to use
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>olditem</code></em> :</span></p></td>
<td> Pointer to store old item pointer or <code class="literal">NULL</code> to ignore. Caller owns
reference if specified.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if property was changed, FALSE otherwise (invalid inputs)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_zone_get_link_item ()">
<a name="ipatch-sf2-zone-get-link-item"></a><h3>ipatch_sf2_zone_get_link_item ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> * ipatch_sf2_zone_get_link_item (<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone);</pre>
<p>
Gets the referenced item from a zone (a <a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a> for preset zones,
<a
href="../libinstpatch/IpatchSF2Sample.html"
><span class="type">IpatchSF2Sample</span></a> for instrument zones). The type specific item set routines
for each zone type may be preferred, as this one doesn't do strict type
checking. The returned item's reference count is incremented and the caller
is responsible for unrefing it with <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td> Zone to get referenced item of
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Zone's referenced item or <code class="literal">NULL</code> if global zone. Remember to
unreference the item with <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> when done with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_zone_peek_link_item ()">
<a name="ipatch-sf2-zone-peek-link-item"></a><h3>ipatch_sf2_zone_peek_link_item ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> * ipatch_sf2_zone_peek_link_item (<a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a> *zone);</pre>
<p>
Like <a
href="../libinstpatch/IpatchSF2Zone.html#ipatch-sf2-zone-get-link-item"
><code class="function">ipatch_sf2_zone_get_link_item()</code></a> but does not add a reference to
the returned item. This function should only be used if a reference
of the returned item is ensured or only the pointer value is of
interest.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td> Zone to get referenced item of
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Zone's linked item. Remember that the item has NOT been referenced.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|