File: IpatchList.html

package info (click to toggle)
libinstpatch 1.0.0-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 8,148 kB
  • ctags: 7,030
  • sloc: ansic: 37,958; sh: 10,747; makefile: 361; python: 27
file content (191 lines) | stat: -rw-r--r-- 7,691 bytes parent folder | download | duplicates (4)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchList</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="libinstpatch-IpatchIter.html" title="IpatchIter">
<link rel="next" href="IpatchConverter.html" title="IpatchConverter">
<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="libinstpatch-IpatchIter.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="IpatchConverter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchList.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchList.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchList.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchList">
<a name="IpatchList"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchList.top_of_page"></a>IpatchList</span></h2>
<p>IpatchList — An object containing a list of object pointers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchList.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchList.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchList.html#IpatchList-struct"
>IpatchList</a>;
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *        <a
href="../libinstpatch/IpatchList.html#ipatch-list-new"
>ipatch_list_new</a>                     (void);
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *        <a
href="../libinstpatch/IpatchList.html#ipatch-list-duplicate"
>ipatch_list_duplicate</a>               (<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *list);
void                <a
href="../libinstpatch/IpatchList.html#ipatch-list-init-iter"
>ipatch_list_init_iter</a>               (<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *list,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchList.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>
   +----IpatchList
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchList.description"></a><h2>Description</h2>
<p>
An object which defines a list of object pointers.  A <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> reference
is held to all objects until the <a
href="../libinstpatch/IpatchList.html"
><span class="type">IpatchList</span></a> itself is released.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchList.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchList">
<a name="IpatchList-struct"></a><h3>IpatchList</h3>
<pre class="programlisting">typedef struct {
  GList *items;			/* list of GObject items */
} IpatchList;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_list_new ()">
<a name="ipatch-list-new"></a><h3>ipatch_list_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *        ipatch_list_new                     (void);</pre>
<p>
Create a new object list object. <a
href="../libinstpatch/IpatchList.html"
><span class="type">IpatchList</span></a> objects are often used to
duplicate multi-thread sensitive object lists, so they can be iterated over
at one's own leasure.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New object list container object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_list_duplicate ()">
<a name="ipatch-list-duplicate"></a><h3>ipatch_list_duplicate ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *        ipatch_list_duplicate               (<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *list);</pre>
<p>
Duplicate an object list.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Object list to duplicate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New duplicate object list with a ref count of one which the
  caller owns.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_list_init_iter ()">
<a name="ipatch-list-init-iter"></a><h3>ipatch_list_init_iter ()</h3>
<pre class="programlisting">void                ipatch_list_init_iter               (<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> *list,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Initializes a user supplied iterator (usually stack allocated) to iterate
over the object <em class="parameter"><code>list</code></em>. Further operations on <em class="parameter"><code>iter</code></em> will use the <em class="parameter"><code>list</code></em>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> List object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Iterator to initialize
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>