ibus-doc 1.5.17-3ubuntu4 / usr / share / doc / ibus / html / IBusObservedPath.html

This file is indexed.

/usr/share/doc/ibus/html/IBusObservedPath.html is in ibus-doc 1.5.17-3ubuntu4.

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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBusObservedPath: IBus Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="IBus Reference Manual">
<link rel="up" href="ch04.html" title="Configuration">
<link rel="prev" href="IBusConfigService.html" title="IBusConfigService">
<link rel="next" href="IBusRegistry.html" title="IBusRegistry">
<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="#IBusObservedPath.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#IBusObservedPath.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="IBusConfigService.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="IBusRegistry.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="IBusObservedPath"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBusObservedPath.top_of_page"></a>IBusObservedPath</span></h2>
<p>IBusObservedPath — Path object of IBus.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBusObservedPath.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="IBusObservedPath.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">
<a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="returnvalue">IBusObservedPath</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusObservedPath.html#ibus-observed-path-new-from-xml-node" title="ibus_observed_path_new_from_xml_node ()">ibus_observed_path_new_from_xml_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="returnvalue">IBusObservedPath</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusObservedPath.html#ibus-observed-path-new" title="ibus_observed_path_new ()">ibus_observed_path_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="IBusObservedPath.html#ibus-observed-path-traverse" title="ibus_observed_path_traverse ()">ibus_observed_path_traverse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IBusObservedPath.html#ibus-observed-path-check-modification" title="ibus_observed_path_check_modification ()">ibus_observed_path_check_modification</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusObservedPath.html#ibus-observed-path-output" title="ibus_observed_path_output ()">ibus_observed_path_output</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IBusObservedPath.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="IBusObservedPath.html#IBusObservedPath-struct" title="struct IBusObservedPath">IBusObservedPath</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IBusObservedPath.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="IBusObject.html" title="IBusObject">IBusObject</a>
            <span class="lineart">╰──</span> <a class="link" href="IBusSerializable.html" title="IBusSerializable">IBusSerializable</a>
                <span class="lineart">╰──</span> IBusObservedPath
</pre>
</div>
<div class="refsect1">
<a name="IBusObservedPath.description"></a><h2>Description</h2>
<p>IBusObservedPath provides methods for file path manipulation,
such as monitor modification, directory tree traversal.</p>
</div>
<div class="refsect1">
<a name="IBusObservedPath.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ibus-observed-path-new-from-xml-node"></a><h3>ibus_observed_path_new_from_xml_node ()</h3>
<pre class="programlisting"><a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="returnvalue">IBusObservedPath</span></a> *
ibus_observed_path_new_from_xml_node (<em class="parameter"><code><a class="link" href="ibus-ibusxml.html#XMLNode" title="XMLNode"><span class="type">XMLNode</span></a> *node</code></em>,
                                      <em class="parameter"><code><span class="type">gboolean</span> fill_stat</code></em>);</pre>
<p>Creates an new <a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a> from an XML node.</p>
<div class="refsect3">
<a name="ibus-observed-path-new-from-xml-node.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>node</p></td>
<td class="parameter_description"><p>An XML node that contain path.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fill_stat</p></td>
<td class="parameter_description"><p>Auto-fill the path status.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-observed-path-new-from-xml-node.returns"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-observed-path-new"></a><h3>ibus_observed_path_new ()</h3>
<pre class="programlisting"><a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="returnvalue">IBusObservedPath</span></a> *
ibus_observed_path_new (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
                        <em class="parameter"><code><span class="type">gboolean</span> fill_stat</code></em>);</pre>
<p>Creates a new <a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a> from an XML node.</p>
<div class="refsect3">
<a name="ibus-observed-path-new.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>path</p></td>
<td class="parameter_description"><p>The path string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fill_stat</p></td>
<td class="parameter_description"><p>Auto-fill the path status.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-observed-path-new.returns"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-observed-path-traverse"></a><h3>ibus_observed_path_traverse ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
ibus_observed_path_traverse (<em class="parameter"><code><a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a> *path</code></em>,
                             <em class="parameter"><code><span class="type">gboolean</span> dir_only</code></em>);</pre>
<p>Recursively traverse the path and put the files and subdirectory in to
a newly allocated
GLists, if the <em class="parameter"><code>path</code></em>
 is a directory. Otherwise returns NULL.</p>
<div class="refsect3">
<a name="ibus-observed-path-traverse.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>path</p></td>
<td class="parameter_description"><p>An IBusObservedPath.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dir_only</p></td>
<td class="parameter_description"><p>Only looks for subdirs, not files</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-observed-path-traverse.returns"></a><h4>Returns</h4>
<p>A newly allocate
GList which holds content in path; NULL if <em class="parameter"><code>path</code></em>
is not directory. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> IBusObservedPath]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-observed-path-check-modification"></a><h3>ibus_observed_path_check_modification ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ibus_observed_path_check_modification (<em class="parameter"><code><a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a> *path</code></em>);</pre>
<p>Checks whether the path is modified by comparing the mtime in object and
mtime in file system.</p>
<div class="refsect3">
<a name="ibus-observed-path-check-modification.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>path</p></td>
<td class="parameter_description"><p>An IBusObservedPath.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-observed-path-check-modification.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if imtime is changed, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-observed-path-output"></a><h3>ibus_observed_path_output ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_observed_path_output (<em class="parameter"><code><a class="link" href="IBusObservedPath.html" title="IBusObservedPath"><span class="type">IBusObservedPath</span></a> *path</code></em>,
                           <em class="parameter"><code><span class="type">GString</span> *output</code></em>,
                           <em class="parameter"><code><span class="type">gint</span> indent</code></em>);</pre>
<p>Append the observed path to a string with following format:
&lt;path mtime="&lt;i&gt;modified time&lt;/i&gt;" &gt;&lt;i&gt;path&lt;/i&gt;&lt;/path&gt;</p>
<div class="refsect3">
<a name="ibus-observed-path-output.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>path</p></td>
<td class="parameter_description"><p>An IBusObservedPath.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output</p></td>
<td class="parameter_description"><p>Path is appended to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>indent</p></td>
<td class="parameter_description"><p>number of indent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="IBusObservedPath.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="IBusObservedPath-struct"></a><h3>struct IBusObservedPath</h3>
<pre class="programlisting">struct IBusObservedPath {
    gchar *path;
    glong mtime;
    gboolean is_dir;
    gboolean is_exist;
};
</pre>
<p>Data structure of IBusObservedPath.</p>
<div class="refsect3">
<a name="IBusObservedPath.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="IBusObservedPath-struct.path"></a>path</code></em>;</p></td>
<td class="struct_member_description"><p>Path to be handled.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">glong</span> <em class="structfield"><code><a name="IBusObservedPath-struct.mtime"></a>mtime</code></em>;</p></td>
<td class="struct_member_description"><p>Modified time.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="IBusObservedPath-struct.is-dir"></a>is_dir</code></em>;</p></td>
<td class="struct_member_description"><p>Whether the file is the path directory.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="IBusObservedPath-struct.is-exist"></a>is_exist</code></em>;</p></td>
<td class="struct_member_description"><p>Whether the file exists.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.