← Back to branch summary

~joel-auterson/ubuntu/maverick/ibus/newmenuname

« back to all changes in this revision

Viewing changes to docs/reference/ibus/html/IBusObservedPath.html

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-10-05 20:45:18 UTC
  • mfrom: (1.1.5 upstream) (6.1.15 sid)
  • Revision ID: james.westby@ubuntu.com-20091005204518-069vlwrl3r8v7bbr
Tags: 1.2.0.20090927-2
https://launchpad.net/bugs/188690
https://launchpad.net/bugs/432375
* create po template when build (LP: #188690)
  - debian/rules: updated.
  - debian/clean: remove pot file when clean.
* debian/control: build depends on python-rsvg (LP: #432375)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/html/IBusObservedPath.html
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>IBusObservedPath</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
7
 
<link rel="home" href="index.html" title="iBus Reference Manual">
8
 
<link rel="up" href="ch05.html" title="Others">
9
 
<link rel="prev" href="IBusObject.html" title="IBusObject">
 
7
<link rel="home" href="index.html" title="IBus Reference Manual">
 
8
<link rel="up" href="ch04.html" title="Communication and Configuration">
 
9
<link rel="prev" href="ibus-ibusmessage.html" title="ibusmessage">
10
10
<link rel="next" href="ibus-ibuspendingcall.html" title="ibuspendingcall">
11
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="ch01.html" title="API Overviews">
14
 
<link rel="chapter" href="ch02.html" title="User Interfaces">
 
13
<link rel="chapter" href="ch01.html" title="Overview">
 
14
<link rel="chapter" href="ch02.html" title="Panel (User Interfaces)">
15
15
<link rel="chapter" href="ch03.html" title="Input method engine">
16
 
<link rel="chapter" href="ch04.html" title="Configuration">
17
 
<link rel="chapter" href="ch05.html" title="Others">
 
16
<link rel="chapter" href="ch04.html" title="Communication and Configuration">
 
17
<link rel="chapter" href="ch05.html" title="Internal">
18
18
</head>
19
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
20
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
21
21
<tr valign="middle">
22
 
<td><a accesskey="p" href="IBusObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
23
 
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
22
<td><a accesskey="p" href="ibus-ibusmessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
23
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
24
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
25
 
<th width="100%" align="center">iBus Reference Manual</th>
 
25
<th width="100%" align="center">IBus Reference Manual</th>
26
26
<td><a accesskey="n" href="ibus-ibuspendingcall.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
27
</tr>
28
28
<tr><td colspan="5" class="shortcuts">
38
38
<div class="refnamediv"><table width="100%"><tr>
39
39
<td valign="top">
40
40
<h2><span class="refentrytitle"><a name="IBusObservedPath.top_of_page"></a>IBusObservedPath</span></h2>
41
 
<p>IBusObservedPath</p>
 
41
<p>IBusObservedPath — Path object of IBus.</p>
42
42
</td>
43
43
<td valign="top" align="right"></td>
44
44
</tr></table></div>
 
45
<div class="refsect1" lang="en">
 
46
<a name="IBusObservedPath.stability-level"></a><h2>Stability Level</h2>
 
47
Stable, unless otherwise indicated
 
48
</div>
45
49
<div class="refsynopsisdiv">
46
50
<a name="IBusObservedPath.synopsis"></a><h2>Synopsis</h2>
47
51
<pre class="synopsis">
79
83
  <a
80
84
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
81
85
>GObject</a>
82
 
   +----<a class="link" href="IBusObject.html" title="IBusObject">IBusObject</a>
83
 
         +----<a class="link" href="IBusSerializable.html" title="IBusSerializable">IBusSerializable</a>
84
 
               +----IBusObservedPath
 
86
   +----<a
 
87
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
 
88
>GInitiallyUnowned</a>
 
89
         +----<a class="link" href="IBusObject.html" title="IBusObject">IBusObject</a>
 
90
               +----<a class="link" href="IBusSerializable.html" title="IBusSerializable">IBusSerializable</a>
 
91
                     +----IBusObservedPath
85
92
</pre>
86
93
</div>
87
94
<div class="refsect1" lang="en">
88
95
<a name="IBusObservedPath.description"></a><h2>Description</h2>
89
96
<p>
 
97
IBusObservedPath provides methods for file path manipulation,
 
98
such as monitor modification, directory tree traversal.</p>
 
99
<p>
90
100
</p>
91
101
</div>
92
102
<div class="refsect1" lang="en">
95
105
<a name="IBusObservedPath-struct"></a><h3>IBusObservedPath</h3>
96
106
<pre class="programlisting">typedef struct _IBusObservedPath IBusObservedPath;</pre>
97
107
<p>
 
108
Data structure of IBusObservedPath.</p>
 
109
<p>
98
110
</p>
 
111
<div class="variablelist"><table border="0">
 
112
<col align="left" valign="top">
 
113
<tbody></tbody>
 
114
</table></div>
99
115
</div>
100
116
<hr>
101
117
<div class="refsect2" lang="en">
106
122
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
107
123
>gboolean</a> fill_stat);</pre>
108
124
<p>
 
125
New an IBusObservedPath from an XML node.</p>
 
126
<p>
109
127
</p>
110
128
<div class="variablelist"><table border="0">
111
129
<col align="left" valign="top">
112
130
<tbody>
113
131
<tr>
114
132
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
115
 
<td>
 
133
<td> An XML node that contain path.
116
134
</td>
117
135
</tr>
118
136
<tr>
119
137
<td><p><span class="term"><em class="parameter"><code>fill_stat</code></em> :</span></p></td>
120
 
<td>
 
138
<td> Auto-fill the path status.
121
139
</td>
122
140
</tr>
123
141
<tr>
124
142
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
125
 
<td>
 
143
<td> A newly allocated IBusObservedPath.
126
144
</td>
127
145
</tr>
128
146
</tbody>
138
156
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
139
157
>gboolean</a> fill_stat);</pre>
140
158
<p>
 
159
New an IBusObservedPath from an XML node.</p>
 
160
<p>
141
161
</p>
142
162
<div class="variablelist"><table border="0">
143
163
<col align="left" valign="top">
144
164
<tbody>
145
165
<tr>
146
166
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
147
 
<td>
 
167
<td> The path string.
148
168
</td>
149
169
</tr>
150
170
<tr>
151
171
<td><p><span class="term"><em class="parameter"><code>fill_stat</code></em> :</span></p></td>
152
 
<td>
 
172
<td> Auto-fill the path status.
153
173
</td>
154
174
</tr>
155
175
<tr>
156
176
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
157
 
<td>
 
177
<td> A newly allocated IBusObservedPath.
158
178
</td>
159
179
</tr>
160
180
</tbody>
167
187
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
168
188
>GList</a> *             ibus_observed_path_traverse         (<a class="link" href="IBusObservedPath.html" title="IBusObservedPath">IBusObservedPath</a> *path);</pre>
169
189
<p>
 
190
Recursively traverse the path and put the files and subdirectory in to a newly allocated
 
191
GLists, if the <em class="parameter"><code>path</code></em> is a directory. Otherwise returns NULL.</p>
 
192
<p>
170
193
</p>
171
194
<div class="variablelist"><table border="0">
172
195
<col align="left" valign="top">
173
196
<tbody>
174
197
<tr>
175
198
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
176
 
<td>
 
199
<td> An IBusObservedPath.
177
200
</td>
178
201
</tr>
179
202
<tr>
180
203
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
181
 
<td>
 
204
<td> A newly allocate GList which holds content in path; NULL if <em class="parameter"><code>path</code></em> is not directory.
182
205
</td>
183
206
</tr>
184
207
</tbody>
192
215
>gboolean</a>            ibus_observed_path_check_modification
193
216
                                                        (<a class="link" href="IBusObservedPath.html" title="IBusObservedPath">IBusObservedPath</a> *path);</pre>
194
217
<p>
 
218
Checks whether the path is modified by comparing the mtime in object and mtime in file system.
 
219
Returns TRUE if imtime is changed, otherwise FALSE.</p>
 
220
<p>
195
221
</p>
196
222
<div class="variablelist"><table border="0">
197
223
<col align="left" valign="top">
198
224
<tbody>
199
225
<tr>
200
226
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
201
 
<td>
 
227
<td> An IBusObservedPath.
202
228
</td>
203
229
</tr>
204
230
<tr>
205
231
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
206
 
<td>
 
232
<td> TRUE if mtime is changed; FALSE otherwise.
207
233
</td>
208
234
</tr>
209
235
</tbody>
220
246
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
221
247
>gint</a> indent);</pre>
222
248
<p>
 
249
Append the observed path to a string with following format:
 
250
&lt;path mtime="&lt;i&gt;modified time&lt;/i&gt;" &gt;&lt;i&gt;path&lt;/i&gt;&lt;/path&gt;</p>
 
251
<p>
223
252
</p>
224
253
<div class="variablelist"><table border="0">
225
254
<col align="left" valign="top">
226
255
<tbody>
227
256
<tr>
228
257
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
229
 
<td>
 
258
<td> An IBusObservedPath.
230
259
</td>
231
260
</tr>
232
261
<tr>
233
262
<td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
234
 
<td>
 
263
<td> Path is appended to.
235
264
</td>
236
265
</tr>
237
266
<tr>
238
267
<td><p><span class="term"><em class="parameter"><code>indent</code></em> :</span></p></td>
239
 
<td>
 
268
<td> number of indent.
240
269
</td>
241
270
</tr>
242
271
</tbody>