libdee-doc 1.2.7+17.10.20170616-0ubuntu4 / usr / share / gtk-doc / html / dee-1.0 / DeeTermList.html

This file is indexed.

/usr/share/gtk-doc/html/dee-1.0/DeeTermList.html is in libdee-doc 1.2.7+17.10.20170616-0ubuntu4.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DeeTermList: Dee Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch03.html" title="Indexes">
<link rel="prev" href="DeeResultSet.html" title="DeeResultSet">
<link rel="next" href="DeeTextAnalyzer.html" title="DeeTextAnalyzer">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#DeeTermList.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#DeeTermList.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DeeResultSet.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="DeeTextAnalyzer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DeeTermList"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DeeTermList.top_of_page"></a>DeeTermList</span></h2>
<p>DeeTermList — A simple collection type representing a list of indexed terms for a row in a <a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DeeTermList.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="DeeTermList.html#dee-term-list-get-term" title="dee_term_list_get_term ()">dee_term_list_get_term</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeTermList.html" title="DeeTermList"><span class="returnvalue">DeeTermList</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeTermList.html#dee-term-list-add-term" title="dee_term_list_add_term ()">dee_term_list_add_term</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="DeeTermList.html#dee-term-list-num-terms" title="dee_term_list_num_terms ()">dee_term_list_num_terms</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeTermList.html" title="DeeTermList"><span class="returnvalue">DeeTermList</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeTermList.html#dee-term-list-clear" title="dee_term_list_clear ()">dee_term_list_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeTermList.html" title="DeeTermList"><span class="returnvalue">DeeTermList</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeTermList.html#dee-term-list-clone" title="dee_term_list_clone ()">dee_term_list_clone</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeTermList.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeTermList.html#DeeTermList-struct" title="struct DeeTermList">DeeTermList</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeTermList.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> DeeTermList
</pre>
</div>
<div class="refsect1">
<a name="DeeTermList.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;dee.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="DeeTermList.description"></a><h2>Description</h2>
<p><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> is a simple list type containing the indexed terms of a row
in a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> as recorded in a <a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a>. The terms are extracted from the
model by using a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a>.</p>
<p>The default implementation of <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> stores all terms in a string pool
and reuses terms from that string pool for the entire lifetime of the
term list. That is, even if you call <a class="link" href="DeeTermList.html#dee-term-list-clear" title="dee_term_list_clear ()"><code class="function">dee_term_list_clear()</code></a> on it. This
behaviour will save a lot of reallocations and <code class="function">g_strdup()</code>s provided
there is reuse in the terms over time.</p>
</div>
<div class="refsect1">
<a name="DeeTermList.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dee-term-list-get-term"></a><h3>dee_term_list_get_term ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
dee_term_list_get_term (<em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *self</code></em>,
                        <em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>Get the n'th term in the list.</p>
<p>Note that in the default implementation it is guaranteed that the returned
string is valid for the entire lifetime of the <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a>.</p>
<div class="refsect3">
<a name="dee-term-list-get-term.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The term list to get the <em class="parameter"><code>n</code></em>
th term from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The (zero based) offset into the term list</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dee-term-list-get-term.returns"></a><h4>Returns</h4>
<p> The <em class="parameter"><code>n</code></em>
th string held in the term list</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-term-list-add-term"></a><h3>dee_term_list_add_term ()</h3>
<pre class="programlisting"><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="returnvalue">DeeTermList</span></a> *
dee_term_list_add_term (<em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *self</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *term</code></em>);</pre>
<p>Add a term to the termlist. Note that it is possible to add a term multiple
times. The effect of this is determined by the <span class="type">DeeModelIndex</span> consuming the
<a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a>.</p>
<div class="refsect3">
<a name="dee-term-list-add-term.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The term list to add a term to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>term</p></td>
<td class="parameter_description"><p>The term to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dee-term-list-add-term.returns"></a><h4>Returns</h4>
<p>Always returns <em class="parameter"><code>self</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-term-list-num-terms"></a><h3>dee_term_list_num_terms ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_term_list_num_terms (<em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *self</code></em>);</pre>
<div class="refsect3">
<a name="dee-term-list-num-terms.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The term list to check the number of terms in</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dee-term-list-num-terms.returns"></a><h4>Returns</h4>
<p> The number of terms in the term list</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-term-list-clear"></a><h3>dee_term_list_clear ()</h3>
<pre class="programlisting"><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="returnvalue">DeeTermList</span></a> *
dee_term_list_clear (<em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *self</code></em>);</pre>
<p>Remove all terms from a term list making it ready for reuse. Note that
term list implementations will often have optimized memory allocation
schemes so reuse is often more efficient than allocating a new term list
each time you need it.</p>
<div class="refsect3">
<a name="dee-term-list-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The term list to clear</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dee-term-list-clear.returns"></a><h4>Returns</h4>
<p>Always returns <em class="parameter"><code>self</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-term-list-clone"></a><h3>dee_term_list_clone ()</h3>
<pre class="programlisting"><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="returnvalue">DeeTermList</span></a> *
dee_term_list_clone (<em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *self</code></em>);</pre>
<p>Create a copy of <em class="parameter"><code>self</code></em>
 that shares the underlying string pool and containing
a list of terms as currently set in <em class="parameter"><code>self</code></em>
.</p>
<p>Subsequently freeing the original and keeping the clone around is not a
problem. The clone works as a standalone term list. The only gotcha may be
threading issues because of concurrent access to the shared string pool.</p>
<p>Creating a clone very efficient since only very little memory allocation
is required. It's advised that you use a clone instead a new instance
whenever you work over a common corpus of strings.</p>
<p>It is also worth noting that terms obtained from the original term list
and a clone can be compared directly as pointers (fx. with <code class="function">g_direct_equal()</code>).
This is because they share the underlying string pool.</p>
<div class="refsect3">
<a name="dee-term-list-clone.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The term list to clone</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dee-term-list-clone.returns"></a><h4>Returns</h4>
<p>A newly allocated term list.
Free with <code class="function">g_object_unref()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeTermList.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeTermList-struct"></a><h3>struct DeeTermList</h3>
<pre class="programlisting">struct DeeTermList;</pre>
<p>All fields in the DeeTermList structure are private and should never be
accessed directly</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.