~ubuntu-branches/ubuntu/precise/dee/precise

« back to all changes in this revision

Viewing changes to doc/reference/dee-1.0/html/DeeSharedModel.html

  • Committer: Package Import Robot
  • Author(s): Didier Roche
  • Date: 2012-02-17 13:30:49 UTC
  • mfrom: (1.1.16)
  • Revision ID: package-import@ubuntu.com-20120217133049-2bfcyh5r507q8jyy
Tags: 1.0.4-0ubuntu1
* New upstream release.
  - DeeModel support insert_sorted() and find_sorted() (LP: #913128)

Show diffs side-by-side

added added

removed removed

Lines of Context:
39
39
<div class="refnamediv"><table width="100%"><tr>
40
40
<td valign="top">
41
41
<h2><span class="refentrytitle"><a name="DeeSharedModel.top_of_page"></a>DeeSharedModel</span></h2>
42
 
<p>DeeSharedModel — A <span class="type">DeeModel</span> that can synchronize with other
 
42
<p>DeeSharedModel — A <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> that can synchronize with other
43
43
   <a class="link" href="DeeSharedModel.html" title="DeeSharedModel"><span class="type">DeeSharedModel</span></a> objects across D-Bus.</p>
44
44
</td>
45
45
<td valign="top" align="right"></td>
59
59
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="DeeSharedModel.html#dee-shared-model-get-swarm-name" title="dee_shared_model_get_swarm_name ()">dee_shared_model_get_swarm_name</a>     (<em class="parameter"><code><a class="link" href="DeeSharedModel.html" title="DeeSharedModel"><span class="type">DeeSharedModel</span></a> *self</code></em>);
60
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="DeeSharedModel.html#dee-shared-model-is-leader" title="dee_shared_model_is_leader ()">dee_shared_model_is_leader</a>          (<em class="parameter"><code><a class="link" href="DeeSharedModel.html" title="DeeSharedModel"><span class="type">DeeSharedModel</span></a> *self</code></em>);
61
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="DeeSharedModel.html#dee-shared-model-is-synchronized" title="dee_shared_model_is_synchronized ()">dee_shared_model_is_synchronized</a>    (<em class="parameter"><code><a class="link" href="DeeSharedModel.html" title="DeeSharedModel"><span class="type">DeeSharedModel</span></a> *self</code></em>);
62
 
<span class="returnvalue">DeeModel</span> *          <a class="link" href="DeeSharedModel.html#dee-shared-model-new" title="dee_shared_model_new ()">dee_shared_model_new</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
63
 
<span class="returnvalue">DeeModel</span> *          <a class="link" href="DeeSharedModel.html#dee-shared-model-new-for-peer" title="dee_shared_model_new_for_peer ()">dee_shared_model_new_for_peer</a>       (<em class="parameter"><code><a class="link" href="DeePeer.html" title="DeePeer"><span class="type">DeePeer</span></a> *peer</code></em>);
64
 
<span class="returnvalue">DeeModel</span> *          <a class="link" href="DeeSharedModel.html#dee-shared-model-new-with-back-end" title="dee_shared_model_new_with_back_end ()">dee_shared_model_new_with_back_end</a>  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
65
 
                                                         <em class="parameter"><code><span class="type">DeeModel</span> *back_end</code></em>);
 
62
<a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          <a class="link" href="DeeSharedModel.html#dee-shared-model-new" title="dee_shared_model_new ()">dee_shared_model_new</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
 
63
<a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          <a class="link" href="DeeSharedModel.html#dee-shared-model-new-for-peer" title="dee_shared_model_new_for_peer ()">dee_shared_model_new_for_peer</a>       (<em class="parameter"><code><a class="link" href="DeePeer.html" title="DeePeer"><span class="type">DeePeer</span></a> *peer</code></em>);
 
64
<a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          <a class="link" href="DeeSharedModel.html#dee-shared-model-new-with-back-end" title="dee_shared_model_new_with_back_end ()">dee_shared_model_new_with_back_end</a>  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
65
                                                         <em class="parameter"><code><a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> *back_end</code></em>);
66
66
</pre>
67
67
</div>
68
68
<div class="refsect1">
78
78
<a name="DeeSharedModel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
79
79
<p>
80
80
DeeSharedModel implements
81
 
 DeeModel and  DeeSerializable.</p>
 
81
 <a class="link" href="DeeModel.html" title="DeeModel">DeeModel</a> and  <a class="link" href="DeeSerializable.html" title="DeeSerializable">DeeSerializable</a>.</p>
82
82
</div>
83
83
<div class="refsect1">
84
84
<a name="DeeSharedModel.properties"></a><h2>Properties</h2>
261
261
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            dee_shared_model_is_synchronized    (<em class="parameter"><code><a class="link" href="DeeSharedModel.html" title="DeeSharedModel"><span class="type">DeeSharedModel</span></a> *self</code></em>);</pre>
262
262
<p>
263
263
Check if the model is synchronized with its peers. Before modifying a
264
 
shared model in any way (except <a class="link" href="dee-1.0-DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a>) you should wait for
 
264
shared model in any way (except <a class="link" href="DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a>) you should wait for
265
265
it to become synchronized. This is normally done by waiting for the
266
266
"notify::synchronized" signal.
267
267
</p>
286
286
<hr>
287
287
<div class="refsect2">
288
288
<a name="dee-shared-model-new"></a><h3>dee_shared_model_new ()</h3>
289
 
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *          dee_shared_model_new                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 
289
<pre class="programlisting"><a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          dee_shared_model_new                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
290
290
<p>
291
291
Create a new empty shared model without any column schema associated.
292
292
The column schema will be set in one of two ways: firstly you may set it
293
 
manually with <a class="link" href="dee-1.0-DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a> or secondly it will be set once
 
293
manually with <a class="link" href="DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a> or secondly it will be set once
294
294
the first rows are exchanged with a peer model.
295
295
</p>
296
296
<p>
320
320
<hr>
321
321
<div class="refsect2">
322
322
<a name="dee-shared-model-new-for-peer"></a><h3>dee_shared_model_new_for_peer ()</h3>
323
 
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *          dee_shared_model_new_for_peer       (<em class="parameter"><code><a class="link" href="DeePeer.html" title="DeePeer"><span class="type">DeePeer</span></a> *peer</code></em>);</pre>
 
323
<pre class="programlisting"><a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          dee_shared_model_new_for_peer       (<em class="parameter"><code><a class="link" href="DeePeer.html" title="DeePeer"><span class="type">DeePeer</span></a> *peer</code></em>);</pre>
324
324
<p>
325
325
Create a new empty shared model without any column schema associated.
326
326
The column schema will be set in one of two ways: firstly you may set it
327
 
manually with <a class="link" href="dee-1.0-DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a> or secondly it will be set once
 
327
manually with <a class="link" href="DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a> or secondly it will be set once
328
328
the first rows are exchanged with a peer model.
329
329
</p>
330
330
<p>
354
354
<hr>
355
355
<div class="refsect2">
356
356
<a name="dee-shared-model-new-with-back-end"></a><h3>dee_shared_model_new_with_back_end ()</h3>
357
 
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *          dee_shared_model_new_with_back_end  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
358
 
                                                         <em class="parameter"><code><span class="type">DeeModel</span> *back_end</code></em>);</pre>
 
357
<pre class="programlisting"><a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          dee_shared_model_new_with_back_end  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
358
                                                         <em class="parameter"><code><a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> *back_end</code></em>);</pre>
359
359
<p>
360
360
Create a new shared model storing all data in <em class="parameter"><code>back_end</code></em>.
361
361
</p>
374
374
</tr>
375
375
<tr>
376
376
<td><p><span class="term"><em class="parameter"><code>back_end</code></em> :</span></p></td>
377
 
<td>The <span class="type">DeeModel</span> that will actually store
 
377
<td>The <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> that will actually store
378
378
the model data. Ownership of the ref to <em class="parameter"><code>back_end</code></em> is transfered to
379
379
the shared model. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
380
380
</td>
407
407
</p>
408
408
<p>
409
409
You should not modify a <a class="link" href="DeeSharedModel.html" title="DeeSharedModel"><span class="type">DeeSharedModel</span></a> that is not synchronized. Before
410
 
modifying the model in any way (except calling <a class="link" href="dee-1.0-DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a>)
 
410
modifying the model in any way (except calling <a class="link" href="DeeModel.html#dee-model-set-schema" title="dee_model_set_schema ()"><code class="function">dee_model_set_schema()</code></a>)
411
411
you should wait for it to become synchronized.
412
412
</p>
413
413
<p>Default value: FALSE</p>