/usr/share/gtk-doc/html/libtododb/libtododb-todo-db.html is in libtododb-dev 0.11-3.
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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>todo-db</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="GPE Manual: libtododb Reference">
<link rel="up" href="ch01.html" title="Programmers Interface">
<link rel="prev" href="ch01.html" title="Programmers Interface">
<link rel="next" href="ch02.html" title="About">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Programmers Interface">
<link rel="chapter" href="ch02.html" title="About">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GPE Manual: libtododb Reference</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2575430" class="shortcut">Top</a>
 | 
<a href="#id2506680" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libtododb-todo-db"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2575430"></a><span class="refentrytitle">todo-db</span>
</h2>
<p>todo-db</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
enum <a href="libtododb-todo-db.html#item-state">item_state</a>;
struct <a href="libtododb-todo-db.html#todo-item">todo_item</a>;
#define <a href="libtododb-todo-db.html#PRIORITY-HIGH:CAPS">PRIORITY_HIGH</a>
#define <a href="libtododb-todo-db.html#PRIORITY-STANDARD:CAPS">PRIORITY_STANDARD</a>
#define <a href="libtododb-todo-db.html#PRIORITY-LOW:CAPS">PRIORITY_LOW</a>
struct <a href="libtododb-todo-db.html#todo-item">todo_item</a>* <a href="libtododb-todo-db.html#todo-db-new-item">todo_db_new_item</a> (void);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libtododb-todo-db.html#todo-db-push-item">todo_db_push_item</a> (struct todo_item *i);
void <a href="libtododb-todo-db.html#todo-db-delete-item">todo_db_delete_item</a> (struct todo_item *i);
void <a href="libtododb-todo-db.html#todo-db-destroy-item">todo_db_destroy_item</a> (struct todo_item *i);
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a>* <a href="libtododb-todo-db.html#todo-db-get-items-list">todo_db_get_items_list</a> (void);
int <a href="libtododb-todo-db.html#todo-db-start">todo_db_start</a> (void);
void <a href="libtododb-todo-db.html#todo-db-stop">todo_db_stop</a> (void);
int <a href="libtododb-todo-db.html#todo-db-refresh">todo_db_refresh</a> (void);
struct <a href="libtododb-todo-db.html#todo-item">todo_item</a>* <a href="libtododb-todo-db.html#todo-db-find-item-by-id">todo_db_find_item_by_id</a> (<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> uid);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2506680"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2524521"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2524532"></a><h3>
<a name="item-state"></a>enum item_state</h3>
<a class="indexterm" name="id2524544"></a><pre class="programlisting">typedef enum
{
NOT_STARTED,
IN_PROGRESS,
COMPLETED,
ABANDONED
} item_state;
</pre>
<p>
Type to describe the progress status of a todo item.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="NOT-STARTED:CAPS"></a><code class="literal">NOT_STARTED</code></span></td>
<td> Indicates a task which isn't started.
</td>
</tr>
<tr>
<td><span class="term"><a name="IN-PROGRESS:CAPS"></a><code class="literal">IN_PROGRESS</code></span></td>
<td> Task currently in progress.
</td>
</tr>
<tr>
<td><span class="term"><a name="COMPLETED:CAPS"></a><code class="literal">COMPLETED</code></span></td>
<td> Task is marked as completed.
</td>
</tr>
<tr>
<td><span class="term"><a name="ABANDONED:CAPS"></a><code class="literal">ABANDONED</code></span></td>
<td> Indicates an abandoned task.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2524656"></a><h3>
<a name="todo-item"></a>struct todo_item</h3>
<a class="indexterm" name="id2524668"></a><pre class="programlisting">struct todo_item {
int id, pos;
time_t time;
const char *what;
const char *summary;
const char *todoid;
item_state state;
gboolean was_complete;
GSList *categories;
guint priority;
};
</pre>
<p>
Data type describing a todo item including description and current status.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">int <em class="structfield"><code>id</code></em>;</span></td>
<td> Unique id.
</td>
</tr>
<tr>
<td><span class="term">int <em class="structfield"><code>pos</code></em>;</span></td>
<td> Position marker.
</td>
</tr>
<tr>
<td><span class="term">time_t <em class="structfield"><code>time</code></em>;</span></td>
<td> Timestamp holding due date.
</td>
</tr>
<tr>
<td><span class="term">const char *<em class="structfield"><code>what</code></em>;</span></td>
<td> Item title.
</td>
</tr>
<tr>
<td><span class="term">const char *<em class="structfield"><code>summary</code></em>;</span></td>
<td> Item description.
</td>
</tr>
<tr>
<td><span class="term">const char *<em class="structfield"><code>todoid</code></em>;</span></td>
<td> ID for vtodo ex-/importation.
</td>
</tr>
<tr>
<td><span class="term"><a href="libtododb-todo-db.html#item-state">item_state</a> <em class="structfield"><code>state</code></em>;</span></td>
<td> Item status (see <a href="libtododb-todo-db.html#item-state"><span class="type">item_state</span></a>).
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <em class="structfield"><code>was_complete</code></em>;</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *<em class="structfield"><code>categories</code></em>;</span></td>
<td> List of categories the item belongs to.
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> <em class="structfield"><code>priority</code></em>;</span></td>
<td> Priority information.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2566774"></a><h3>
<a name="PRIORITY-HIGH:CAPS"></a>PRIORITY_HIGH</h3>
<a class="indexterm" name="id2502017"></a><pre class="programlisting">#define PRIORITY_HIGH 9
</pre>
<p>
Indicates an item with high priority.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2502036"></a><h3>
<a name="PRIORITY-STANDARD:CAPS"></a>PRIORITY_STANDARD</h3>
<a class="indexterm" name="id2502047"></a><pre class="programlisting">#define PRIORITY_STANDARD 5
</pre>
<p>
Indicates an item with default priority.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2502066"></a><h3>
<a name="PRIORITY-LOW:CAPS"></a>PRIORITY_LOW</h3>
<a class="indexterm" name="id2502079"></a><pre class="programlisting">#define PRIORITY_LOW 0
</pre>
<p>
Indicates a low priority item.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2502098"></a><h3>
<a name="todo-db-new-item"></a>todo_db_new_item ()</h3>
<a class="indexterm" name="id2502110"></a><pre class="programlisting">struct <a href="libtododb-todo-db.html#todo-item">todo_item</a>* todo_db_new_item (void);</pre>
<p>
Create a new todo item and add it to list and database.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> New todo item.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2502152"></a><h3>
<a name="todo-db-push-item"></a>todo_db_push_item ()</h3>
<a class="indexterm" name="id2502165"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> todo_db_push_item (struct todo_item *i);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2502221"></a><h3>
<a name="todo-db-delete-item"></a>todo_db_delete_item ()</h3>
<a class="indexterm" name="id2502234"></a><pre class="programlisting">void todo_db_delete_item (struct todo_item *i);</pre>
<p>
Deletes an item from the list and database.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> Todo item to delete.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2502284"></a><h3>
<a name="todo-db-destroy-item"></a>todo_db_destroy_item ()</h3>
<a class="indexterm" name="id2589381"></a><pre class="programlisting">void todo_db_destroy_item (struct todo_item *i);</pre>
<p>
Frees a todo list item struct.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> Todo item to destroy.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589425"></a><h3>
<a name="todo-db-get-items-list"></a>todo_db_get_items_list ()</h3>
<a class="indexterm" name="id2589435"></a><pre class="programlisting"><a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a>* todo_db_get_items_list (void);</pre>
<p>
Get a list of all todo items. The returned list points to the internal
list used by libtododb and doesn't need to be freed. It is a good idea
to consider it to be read only.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> List of todo items.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589474"></a><h3>
<a name="todo-db-start"></a>todo_db_start ()</h3>
<a class="indexterm" name="id2589485"></a><pre class="programlisting">int todo_db_start (void);</pre>
<p>
Initialises libtododb for use.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, -1 on failure.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589521"></a><h3>
<a name="todo-db-stop"></a>todo_db_stop ()</h3>
<a class="indexterm" name="id2589533"></a><pre class="programlisting">void todo_db_stop (void);</pre>
<p>
Deinitialises libtododb and frees all its allocated data.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589559"></a><h3>
<a name="todo-db-refresh"></a>todo_db_refresh ()</h3>
<a class="indexterm" name="id2589572"></a><pre class="programlisting">int todo_db_refresh (void);</pre>
<p>
Update list of todo items from database.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, -1 on failure.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589613"></a><h3>
<a name="todo-db-find-item-by-id"></a>todo_db_find_item_by_id ()</h3>
<a class="indexterm" name="id2589624"></a><pre class="programlisting">struct <a href="libtododb-todo-db.html#todo-item">todo_item</a>* todo_db_find_item_by_id (<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> uid);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>uid</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|