← Back to branch summary

~ubuntu-branches/ubuntu/trusty/dee/trusty-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Didier Roche
  • Date: 2012-04-12 11:33:08 UTC
  • mfrom: (1.1.19)
  • Revision ID: package-import@ubuntu.com-20120412113308-cr9nobarsigs0xak
Tags: 1.0.10-0ubuntu1
https://launchpad.net/bugs/963991
https://launchpad.net/bugs/938382
https://launchpad.net/bugs/953978
* New upstream release.
  - unity-music-daemon crashed with SIGSEGV in find_term_real() from
    dee_tree_index_lookup() from dee_index_lookup() from
    unity_music_lens_rhythmbox_collection_search() (LP: #963991)
  - unity-applications-daemon crashed with SIGSEGV in
    g_variant_get_type_info() (LP: #938382)
  - unity-applications-daemon crashed with SIGSEGV in
    g_variant_type_info_check() (LP: #953978)
* debian/control:
  - update Standards-Version to latest

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/dee-1.0/html/DeeIndex.html
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
37
37
<h2><span class="refentrytitle"><a name="DeeIndex.top_of_page"></a>DeeIndex</span></h2>
38
 
<p>DeeIndex — An inverted index interface for smart access to a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a></p>
 
38
<p>DeeIndex — An inverted index interface for smart access to a <a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="type">DeeModel</span></a></p>
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
47
47
struct              <a class="link" href="DeeIndex.html#DeeIndex-struct" title="struct DeeIndex">DeeIndex</a>;
48
48
struct              <a class="link" href="DeeIndex.html#DeeIndexClass" title="struct DeeIndexClass">DeeIndexClass</a>;
49
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="DeeIndex.html#DeeIndexIterFunc" title="DeeIndexIterFunc ()">*DeeIndexIterFunc</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> *key</code></em>,
50
 
                                                         <em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *rows</code></em>,
 
50
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/dee-1.0/DeeResultSet.html"><span class="type">DeeResultSet</span></a> *rows</code></em>,
51
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
52
52
enum                <a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag">DeeTermMatchFlag</a>;
53
53
<span class="returnvalue">void</span>                <a class="link" href="DeeIndex.html#dee-index-foreach" title="dee_index_foreach ()">dee_index_foreach</a>                   (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
55
55
                                                         <em class="parameter"><code><a class="link" href="DeeIndex.html#DeeIndexIterFunc" title="DeeIndexIterFunc ()"><span class="type">DeeIndexIterFunc</span></a> func</code></em>,
56
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
57
57
<a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="returnvalue">DeeAnalyzer</span></a> *       <a class="link" href="DeeIndex.html#dee-index-get-analyzer" title="dee_index_get_analyzer ()">dee_index_get_analyzer</a>              (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);
58
 
<a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          <a class="link" href="DeeIndex.html#dee-index-get-model" title="dee_index_get_model ()">dee_index_get_model</a>                 (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);
 
58
<a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="returnvalue">DeeModel</span></a> *          <a class="link" href="DeeIndex.html#dee-index-get-model" title="dee_index_get_model ()">dee_index_get_model</a>                 (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);
59
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="DeeIndex.html#dee-index-get-n-rows" title="dee_index_get_n_rows ()">dee_index_get_n_rows</a>                (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);
60
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="DeeIndex.html#dee-index-get-n-rows-for-term" title="dee_index_get_n_rows_for_term ()">dee_index_get_n_rows_for_term</a>       (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
61
61
                                                         <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> *term</code></em>);
63
63
<a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="returnvalue">DeeModelReader</span></a> *    <a class="link" href="DeeIndex.html#dee-index-get-reader" title="dee_index_get_reader ()">dee_index_get_reader</a>                (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);
64
64
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="DeeIndex.html#dee-index-get-supported-term-match-flags" title="dee_index_get_supported_term_match_flags ()">dee_index_get_supported_term_match_flags</a>
65
65
                                                        (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);
66
 
<a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="returnvalue">DeeResultSet</span></a> *      <a class="link" href="DeeIndex.html#dee-index-lookup" title="dee_index_lookup ()">dee_index_lookup</a>                    (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
 
66
<a href="/usr/share/gtk-doc/html/dee-1.0/DeeResultSet.html"><span class="returnvalue">DeeResultSet</span></a> *      <a class="link" href="DeeIndex.html#dee-index-lookup" title="dee_index_lookup ()">dee_index_lookup</a>                    (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
67
67
                                                         <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> *term</code></em>,
68
68
                                                         <em class="parameter"><code><a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag"><span class="type">DeeTermMatchFlag</span></a> flags</code></em>);
69
 
<a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      <a class="link" href="DeeIndex.html#dee-index-lookup-one" title="dee_index_lookup_one ()">dee_index_lookup_one</a>                (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
 
69
<a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      <a class="link" href="DeeIndex.html#dee-index-lookup-one" title="dee_index_lookup_one ()">dee_index_lookup_one</a>                (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
70
70
                                                         <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> *term</code></em>);
71
71
</pre>
72
72
</div>
83
83
<a name="DeeIndex.properties"></a><h2>Properties</h2>
84
84
<pre class="synopsis">
85
85
  "<a class="link" href="DeeIndex.html#DeeIndex--analyzer" title='The "analyzer" property'>analyzer</a>"                 <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a>*          : Read / Write / Construct Only
86
 
  "<a class="link" href="DeeIndex.html#DeeIndex--model" title='The "model" property'>model</a>"                    <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>*             : Read / Write / Construct Only
 
86
  "<a class="link" href="DeeIndex.html#DeeIndex--model" title='The "model" property'>model</a>"                    <a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="type">DeeModel</span></a>*             : Read / Write / Construct Only
87
87
  "<a class="link" href="DeeIndex.html#DeeIndex--reader" title='The "reader" property'>reader</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only
88
88
</pre>
89
89
</div>
90
90
<div class="refsect1">
91
91
<a name="DeeIndex.description"></a><h2>Description</h2>
92
92
<p>
93
 
<a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> is an interface for doing key based access to a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>.
 
93
<a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> is an interface for doing key based access to a <a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="type">DeeModel</span></a>.
94
94
A key in the index is known as a <span class="emphasis"><em>term</em></span> and each term is
95
 
mapped to a set of matching <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a>s.
 
95
mapped to a set of matching <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a>s.
96
96
</p>
97
97
<p>
98
98
The terms are calculated by means of a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> which extracts a set of
143
143
<div class="refsect2">
144
144
<a name="DeeIndexIterFunc"></a><h3>DeeIndexIterFunc ()</h3>
145
145
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*DeeIndexIterFunc)                 (<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> *key</code></em>,
146
 
                                                         <em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *rows</code></em>,
 
146
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/dee-1.0/DeeResultSet.html"><span class="type">DeeResultSet</span></a> *rows</code></em>,
147
147
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);</pre>
148
148
<p>
149
149
The signature of the function passed to <a class="link" href="DeeIndex.html#dee-index-foreach" title="dee_index_foreach ()"><code class="function">dee_index_foreach()</code></a>.
165
165
</tr>
166
166
<tr>
167
167
<td><p><span class="term"><em class="parameter"><code>rows</code></em> :</span></p></td>
168
 
<td>A <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a>. Do not free or modify.</td>
 
168
<td>A <a href="/usr/share/gtk-doc/html/dee-1.0/DeeResultSet.html"><span class="type">DeeResultSet</span></a>. Do not free or modify.</td>
169
169
</tr>
170
170
<tr>
171
171
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
278
278
<hr>
279
279
<div class="refsect2">
280
280
<a name="dee-index-get-model"></a><h3>dee_index_get_model ()</h3>
281
 
<pre class="programlisting"><a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          dee_index_get_model                 (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
 
281
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="returnvalue">DeeModel</span></a> *          dee_index_get_model                 (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
282
282
<p>
283
283
Get the model being indexed by this index
284
284
</p>
291
291
</tr>
292
292
<tr>
293
293
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
294
 
<td>The <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> being indexed by this index. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
294
<td>The <a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="type">DeeModel</span></a> being indexed by this index. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
295
295
</td>
296
296
</tr>
297
297
</tbody>
316
316
<tr>
317
317
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
318
318
<td>The number of rows in the index. Note that this may less than or
319
 
equal to <a class="link" href="DeeModel.html#dee-model-get-n-rows" title="dee_model_get_n_rows ()"><code class="function">dee_model_get_n_rows()</code></a>.</td>
 
319
equal to <a class="link" href="dee-1.0-DeeModel.html#dee-model-get-n-rows" title="dee_model_get_n_rows ()"><code class="function">dee_model_get_n_rows()</code></a>.</td>
320
320
</tr>
321
321
</tbody>
322
322
</table></div>
415
415
<hr>
416
416
<div class="refsect2">
417
417
<a name="dee-index-lookup"></a><h3>dee_index_lookup ()</h3>
418
 
<pre class="programlisting"><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="returnvalue">DeeResultSet</span></a> *      dee_index_lookup                    (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
 
418
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/dee-1.0/DeeResultSet.html"><span class="returnvalue">DeeResultSet</span></a> *      dee_index_lookup                    (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
419
419
                                                         <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> *term</code></em>,
420
420
                                                         <em class="parameter"><code><a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag"><span class="type">DeeTermMatchFlag</span></a> flags</code></em>);</pre>
421
421
<div class="variablelist"><table border="0">
436
436
</tr>
437
437
<tr>
438
438
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
439
 
<td>A <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a>. Free 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>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
439
<td>A <a href="/usr/share/gtk-doc/html/dee-1.0/DeeResultSet.html"><span class="type">DeeResultSet</span></a>. Free 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>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
440
440
</td>
441
441
</tr>
442
442
</tbody>
445
445
<hr>
446
446
<div class="refsect2">
447
447
<a name="dee-index-lookup-one"></a><h3>dee_index_lookup_one ()</h3>
448
 
<pre class="programlisting"><a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      dee_index_lookup_one                (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
 
448
<pre class="programlisting"><a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      dee_index_lookup_one                (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
449
449
                                                         <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> *term</code></em>);</pre>
450
450
<p>
451
451
Convenience function in for cases where you have a priori guarantee that
470
470
</tr>
471
471
<tr>
472
472
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
473
 
<td>A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the matching
 
473
<td>A <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the matching
474
474
row or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case no rows matches <em class="parameter"><code>term</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
475
475
</td>
476
476
</tr>
491
491
<hr>
492
492
<div class="refsect2">
493
493
<a name="DeeIndex--model"></a><h3>The <code class="literal">"model"</code> property</h3>
494
 
<pre class="programlisting">  "model"                    <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>*             : Read / Write / Construct Only</pre>
 
494
<pre class="programlisting">  "model"                    <a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="type">DeeModel</span></a>*             : Read / Write / Construct Only</pre>
495
495
<p>
496
 
The <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> being indexed
 
496
The <a href="/usr/share/gtk-doc/html/dee-1.0/DeeModel.html"><span class="type">DeeModel</span></a> being indexed
497
497
</p>
498
498
</div>
499
499
<hr>