~ubuntu-branches/ubuntu/vivid/libinfinity/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libinfgtk/html/libinfgtk-0.5-inf-gtk-browser-model.html

  • Committer: Bazaar Package Importer
  • Author(s): Philipp Kern
  • Date: 2011-08-05 20:09:57 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20110805200957-wpk147f6xnwnkhj8
Tags: 0.5.1-1
New upstream bugfix release, which fixes a crash in infinoted.

Show diffs side-by-side

added added

removed removed

Lines of Context:
50
50
enum                <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModelStatus">InfGtkBrowserModelStatus</a>;
51
51
enum                <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModelColumn" title="enum InfGtkBrowserModelColumn">InfGtkBrowserModelColumn</a>;
52
52
<span class="returnvalue">void</span>                <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#inf-gtk-browser-model-set-browser" title="inf_gtk_browser_model_set_browser ()">inf_gtk_browser_model_set_browser</a>   (<em class="parameter"><code><a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model</code></em>,
53
 
                                                         <em class="parameter"><code><span class="type">GtkTreePath</span> *path</code></em>,
54
 
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>);
 
53
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
 
55
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>);
56
56
<span class="returnvalue">void</span>                <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#inf-gtk-browser-model-resolve" title="inf_gtk_browser_model_resolve ()">inf_gtk_browser_model_resolve</a>       (<em class="parameter"><code><a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfDiscovery.html"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfDiscovery.html#InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);
59
 
<span class="returnvalue">gboolean</span>            <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#inf-gtk-browser-model-browser-iter-to-tree-iter" title="inf_gtk_browser_model_browser_iter_to_tree_iter ()">inf_gtk_browser_model_browser_iter_to_tree_iter</a>
 
57
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfDiscovery.html"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
 
58
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfDiscovery.html#InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#inf-gtk-browser-model-browser-iter-to-tree-iter" title="inf_gtk_browser_model_browser_iter_to_tree_iter ()">inf_gtk_browser_model_browser_iter_to_tree_iter</a>
60
60
                                                        (<em class="parameter"><code><a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model</code></em>,
61
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowserIter.html"><span class="type">InfcBrowserIter</span></a> *browser_iter</code></em>,
63
 
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *tree_iter</code></em>);
 
61
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>,
 
62
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfcBrowserIter.html"><span class="type">InfcBrowserIter</span></a> *browser_iter</code></em>,
 
63
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *tree_iter</code></em>);
64
64
</pre>
65
65
</div>
66
66
<div class="refsect1">
78
78
<a name="libinfgtk-0.5-inf-gtk-browser-model.prerequisites"></a><h2>Prerequisites</h2>
79
79
<p>
80
80
InfGtkBrowserModel requires
81
 
 GtkTreeModel and  GObject.</p>
 
81
 <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html">GtkTreeModel</a> and  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
82
82
</div>
83
83
<div class="refsect1">
84
84
<a name="libinfgtk-0.5-inf-gtk-browser-model.implementations"></a><h2>Known Implementations</h2>
89
89
<div class="refsect1">
90
90
<a name="libinfgtk-0.5-inf-gtk-browser-model.signals"></a><h2>Signals</h2>
91
91
<pre class="synopsis">
92
 
  "<a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel-set-browser" title='The "set-browser" signal'>set-browser</a>"                                    : <code class="literal">Run Last</code>
 
92
  "<a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel-set-browser" title='The "set-browser" signal'>set-browser</a>"                                    : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
93
93
</pre>
94
94
</div>
95
95
<div class="refsect1">
151
151
<div class="refsect2">
152
152
<a name="inf-gtk-browser-model-set-browser"></a><h3>inf_gtk_browser_model_set_browser ()</h3>
153
153
<pre class="programlisting"><span class="returnvalue">void</span>                inf_gtk_browser_model_set_browser   (<em class="parameter"><code><a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model</code></em>,
154
 
                                                         <em class="parameter"><code><span class="type">GtkTreePath</span> *path</code></em>,
155
 
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>,
156
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>);</pre>
 
154
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
 
155
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
 
156
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>);</pre>
157
157
<p>
158
158
Emits the <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel-set-browser" title='The "set-browser" signal'><span class="type">"set-browser"</span></a> signal. This is supposed to only
159
159
be called by implementations of <a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> whenever they set or
168
168
</tr>
169
169
<tr>
170
170
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
171
 
<td>A <span class="type">GtkTreePath</span> to a top-level row.</td>
 
171
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> to a top-level row.</td>
172
172
</tr>
173
173
<tr>
174
174
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
175
 
<td>A <span class="type">GtkTreeIter</span> pointing to the same row.</td>
 
175
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the same row.</td>
176
176
</tr>
177
177
<tr>
178
178
<td><p><span class="term"><em class="parameter"><code>browser</code></em> :</span></p></td>
179
 
<td>The new <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a> to set.</td>
 
179
<td>The new <a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a> to set.</td>
180
180
</tr>
181
181
</tbody>
182
182
</table></div>
185
185
<div class="refsect2">
186
186
<a name="inf-gtk-browser-model-resolve"></a><h3>inf_gtk_browser_model_resolve ()</h3>
187
187
<pre class="programlisting"><span class="returnvalue">void</span>                inf_gtk_browser_model_resolve       (<em class="parameter"><code><a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model</code></em>,
188
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfDiscovery.html"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
189
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfDiscovery.html#InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);</pre>
 
188
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfDiscovery.html"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
 
189
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfDiscovery.html#InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);</pre>
190
190
<p>
191
191
Resolves <em class="parameter"><code>info</code></em> and adds the resulting connection to the model. If that
192
192
connection is already contained, the original (newly resolved) entry
202
202
</tr>
203
203
<tr>
204
204
<td><p><span class="term"><em class="parameter"><code>discovery</code></em> :</span></p></td>
205
 
<td>A <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfDiscovery.html"><span class="type">InfDiscovery</span></a> added to <em class="parameter"><code>store</code></em>.</td>
 
205
<td>A <a href="../libinfinity-0.5/InfDiscovery.html"><span class="type">InfDiscovery</span></a> added to <em class="parameter"><code>store</code></em>.</td>
206
206
</tr>
207
207
<tr>
208
208
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
209
 
<td>A <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfDiscovery.html#InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> discovered by <em class="parameter"><code>discovery</code></em>.</td>
 
209
<td>A <a href="../libinfinity-0.5/InfDiscovery.html#InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> discovered by <em class="parameter"><code>discovery</code></em>.</td>
210
210
</tr>
211
211
</tbody>
212
212
</table></div>
214
214
<hr>
215
215
<div class="refsect2">
216
216
<a name="inf-gtk-browser-model-browser-iter-to-tree-iter"></a><h3>inf_gtk_browser_model_browser_iter_to_tree_iter ()</h3>
217
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            inf_gtk_browser_model_browser_iter_to_tree_iter
 
217
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_gtk_browser_model_browser_iter_to_tree_iter
218
218
                                                        (<em class="parameter"><code><a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model</code></em>,
219
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>,
220
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowserIter.html"><span class="type">InfcBrowserIter</span></a> *browser_iter</code></em>,
221
 
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *tree_iter</code></em>);</pre>
 
219
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a> *browser</code></em>,
 
220
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfcBrowserIter.html"><span class="type">InfcBrowserIter</span></a> *browser_iter</code></em>,
 
221
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *tree_iter</code></em>);</pre>
222
222
<p>
223
223
Sets <em class="parameter"><code>tree_iter</code></em> to point to the same node <em class="parameter"><code>browser_iter</code></em> refers to
224
224
within the model. If <em class="parameter"><code>browser</code></em> is not known to <em class="parameter"><code>model</code></em>, i.e. its connection
225
 
was never added to <em class="parameter"><code>model</code></em>, then the function returns <code class="literal">FALSE</code> and
 
225
was never added to <em class="parameter"><code>model</code></em>, then the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and
226
226
<em class="parameter"><code>tree_iter</code></em> is left untouched.
227
227
</p>
228
228
<div class="variablelist"><table border="0">
234
234
</tr>
235
235
<tr>
236
236
<td><p><span class="term"><em class="parameter"><code>browser</code></em> :</span></p></td>
237
 
<td>A <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a>.</td>
 
237
<td>A <a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a>.</td>
238
238
</tr>
239
239
<tr>
240
240
<td><p><span class="term"><em class="parameter"><code>browser_iter</code></em> :</span></p></td>
241
 
<td>A <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowserIter.html"><span class="type">InfcBrowserIter</span></a> pointing into <em class="parameter"><code>browser</code></em>.</td>
 
241
<td>A <a href="../libinfinity-0.5/InfcBrowserIter.html"><span class="type">InfcBrowserIter</span></a> pointing into <em class="parameter"><code>browser</code></em>.</td>
242
242
</tr>
243
243
<tr>
244
244
<td><p><span class="term"><em class="parameter"><code>tree_iter</code></em> :</span></p></td>
245
 
<td>A <span class="type">GtkTreeIter</span> that will be set by this function.</td>
 
245
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> that will be set by this function.</td>
246
246
</tr>
247
247
<tr>
248
248
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
257
257
<div class="refsect2">
258
258
<a name="InfGtkBrowserModel-set-browser"></a><h3>The <code class="literal">"set-browser"</code> signal</h3>
259
259
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="libinfgtk-0.5-inf-gtk-browser-model.html#InfGtkBrowserModel"><span class="type">InfGtkBrowserModel</span></a> *model,
260
 
                                                        <span class="type">GtkTreePath</span>        *path,
261
 
                                                        <span class="type">GtkTreeIter</span>        *iter,
262
 
                                                        <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a>        *browser,
263
 
                                                        <span class="type">gpointer</span>            user_data)      : <code class="literal">Run Last</code></pre>
 
260
                                                        <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>        *path,
 
261
                                                        <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>        *iter,
 
262
                                                        <a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a>        *browser,
 
263
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
264
264
<p>
265
265
This signal is emitted every time a new browser is inserted to the
266
266
model. This means either that a completely new item was inserted, or
276
276
</tr>
277
277
<tr>
278
278
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
279
 
<td>A <span class="type">GtkTreePath</span> pointing to the newly created browser.</td>
 
279
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the newly created browser.</td>
280
280
</tr>
281
281
<tr>
282
282
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
283
 
<td>A <span class="type">GtkTreeIter</span> pointing to the newly created browser.</td>
 
283
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the newly created browser.</td>
284
284
</tr>
285
285
<tr>
286
286
<td><p><span class="term"><em class="parameter"><code>browser</code></em> :</span></p></td>
287
 
<td>The newly created <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfcBrowser.html"><span class="type">InfcBrowser</span></a>.</td>
 
287
<td>The newly created <a href="../libinfinity-0.5/InfcBrowser.html"><span class="type">InfcBrowser</span></a>.</td>
288
288
</tr>
289
289
<tr>
290
290
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>