← Back to branch summary

~ubuntu-branches/ubuntu/trusty/yelp/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/libyelp/html/YelpDocument.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2012-01-03 13:23:15 UTC
  • mfrom: (1.1.54)
  • Revision ID: package-import@ubuntu.com-20120103132315-yvk636rtjs1j62hx
Tags: 3.3.2-0ubuntu1
https://launchpad.net/bugs/911125
* debian/watch: Watch for development versions.
* New upstream release.
* debian/control.in: Add libgee-dev and libfolks-dev build dependencies as
  per upstream configure.ac.
* 01_lpi.patch, 06_setup_error_on_missing_dbus.patch: Unfuzz.
* Add 08_g_thread_init_deprecation.patch: Don't call g_thread_init().
  (LP: #911125)
* debian/libyelp0.symbols: Add new symbol from this upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libyelp/html/YelpDocument.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>YelpDocument</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Yelp Reference Manual">
8
8
<link rel="up" href="ch01s02.html" title="Document Processing">
9
9
<link rel="prev" href="ch01s02.html" title="Document Processing">
10
10
<link rel="next" href="YelpSimpleDocument.html" title="YelpSimpleDocument">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
30
30
                  <a href="#YelpDocument.properties" class="shortcut">Properties</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" title="YelpDocument">
 
33
<div class="refentry">
34
34
<a name="YelpDocument"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv" title="Synopsis">
 
42
<div class="refsynopsisdiv">
43
43
<a name="YelpDocument.synopsis"></a><h2>Synopsis</h2>
44
 
<pre class="synopsis">                    <a href="YelpDocument.html#YelpDocument-struct">YelpDocument</a>;
45
 
                    <a href="YelpDocument.html#YelpDocumentClass">YelpDocumentClass</a>;
46
 
                    <a href="YelpDocument.html#YelpDocumentPriv">YelpDocumentPriv</a>;
47
 
enum                <a href="YelpDocument.html#YelpDocumentSignal">YelpDocumentSignal</a>;
 
44
<pre class="synopsis">enum                <a href="YelpDocument.html#YelpDocumentSignal">YelpDocumentSignal</a>;
48
45
<span class="returnvalue">void</span>                (<a href="YelpDocument.html#YelpDocumentCallback">*YelpDocumentCallback</a>)             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
49
46
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentSignal"><span class="type">YelpDocumentSignal</span></a> signal</code></em>,
50
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
51
 
                                                         <em class="parameter"><code><span class="type">GError</span> *error</code></em>);
 
47
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
48
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);
 
49
struct              <a href="YelpDocument.html#YelpDocument-struct">YelpDocument</a>;
 
50
struct              <a href="YelpDocument.html#YelpDocumentClass">YelpDocumentClass</a>;
52
51
<a href="YelpDocument.html"><span class="returnvalue">YelpDocument</span></a> *      <a href="YelpDocument.html#yelp-document-get-for-uri">yelp_document_get_for_uri</a>           (<em class="parameter"><code><a href="YelpUri.html"><span class="type">YelpUri</span></a> *uri</code></em>);
53
 
<span class="returnvalue">gboolean</span>            <a href="YelpDocument.html#yelp-document-request-page">yelp_document_request_page</a>          (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
54
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a href="YelpDocument.html#yelp-document-request-page">yelp_document_request_page</a>          (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
53
                                                         <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> *page_id</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
56
55
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentCallback"><span class="type">YelpDocumentCallback</span></a> callback</code></em>,
57
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
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> user_data</code></em>);
58
57
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-give-contents">yelp_document_give_contents</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
59
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
60
 
                                                         <em class="parameter"><code><span class="type">gchar</span> *contents</code></em>,
61
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *mime</code></em>);
62
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-mime-type">yelp_document_get_mime_type</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
63
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
64
 
const <span class="returnvalue">gchar</span> *       <a href="YelpDocument.html#yelp-document-read-contents">yelp_document_read_contents</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
65
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
58
                                                         <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> *page_id</code></em>,
 
59
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *contents</code></em>,
 
60
                                                         <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> *mime</code></em>);
 
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-mime-type">yelp_document_get_mime_type</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
62
                                                         <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> *page_id</code></em>);
 
63
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a href="YelpDocument.html#yelp-document-read-contents">yelp_document_read_contents</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
64
                                                         <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> *page_id</code></em>);
66
65
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-finish-read">yelp_document_finish_read</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
67
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *contents</code></em>);
68
 
<span class="returnvalue">gchar</span> **            <a href="YelpDocument.html#yelp-document-list-page-ids">yelp_document_list_page_ids</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>);
69
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-page-id">yelp_document_get_page_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
70
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
 
66
                                                         <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> *contents</code></em>);
 
67
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-index">yelp_document_index</a>                 (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>);
 
68
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **            <a href="YelpDocument.html#yelp-document-list-page-ids">yelp_document_list_page_ids</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>);
 
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-page-id">yelp_document_get_page_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
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> *id</code></em>);
71
71
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-page-id">yelp_document_set_page_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
72
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
73
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
74
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-root-id">yelp_document_get_root_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
75
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
72
                                                         <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> *id</code></em>,
 
73
                                                         <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> *page_id</code></em>);
 
74
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-root-id">yelp_document_get_root_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
75
                                                         <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> *page_id</code></em>);
76
76
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-root-id">yelp_document_set_root_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
77
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
78
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *root_id</code></em>);
79
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-prev-id">yelp_document_get_prev_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
80
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
77
                                                         <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> *page_id</code></em>,
 
78
                                                         <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> *root_id</code></em>);
 
79
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-prev-id">yelp_document_get_prev_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
80
                                                         <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> *page_id</code></em>);
81
81
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-prev-id">yelp_document_set_prev_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
82
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
83
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prev_id</code></em>);
 
82
                                                         <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> *page_id</code></em>,
 
83
                                                         <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> *prev_id</code></em>);
84
84
<span class="returnvalue">char</span> *              <a href="YelpDocument.html#yelp-document-get-next-id">yelp_document_get_next_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
85
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
85
                                                         <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> *page_id</code></em>);
86
86
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-next-id">yelp_document_set_next_id</a>           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
87
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
88
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *next_id</code></em>);
89
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-up-id">yelp_document_get_up_id</a>             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
90
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
87
                                                         <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> *page_id</code></em>,
 
88
                                                         <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> *next_id</code></em>);
 
89
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-up-id">yelp_document_get_up_id</a>             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
90
                                                         <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> *page_id</code></em>);
91
91
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-up-id">yelp_document_set_up_id</a>             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
92
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
93
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *up_id</code></em>);
94
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-root-title">yelp_document_get_root_title</a>        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
95
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
96
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-page-title">yelp_document_get_page_title</a>        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
97
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
92
                                                         <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> *page_id</code></em>,
 
93
                                                         <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> *up_id</code></em>);
 
94
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-root-title">yelp_document_get_root_title</a>        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
95
                                                         <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> *page_id</code></em>);
 
96
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-page-title">yelp_document_get_page_title</a>        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
97
                                                         <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> *page_id</code></em>);
98
98
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-page-title">yelp_document_set_page_title</a>        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
99
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
100
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);
101
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-page-desc">yelp_document_get_page_desc</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
102
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
99
                                                         <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> *page_id</code></em>,
 
100
                                                         <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> *title</code></em>);
 
101
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-page-desc">yelp_document_get_page_desc</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
102
                                                         <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> *page_id</code></em>);
103
103
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-page-desc">yelp_document_set_page_desc</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
104
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
105
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);
106
 
<span class="returnvalue">gchar</span> *             <a href="YelpDocument.html#yelp-document-get-page-icon">yelp_document_get_page_icon</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
107
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
104
                                                         <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> *page_id</code></em>,
 
105
                                                         <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> *desc</code></em>);
 
106
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a href="YelpDocument.html#yelp-document-get-page-icon">yelp_document_get_page_icon</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
107
                                                         <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> *page_id</code></em>);
108
108
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-set-page-icon">yelp_document_set_page_icon</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
109
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
110
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon</code></em>);
111
 
<span class="returnvalue">gboolean</span>            <a href="YelpDocument.html#yelp-document-has-page">yelp_document_has_page</a>              (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
112
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);
 
109
                                                         <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> *page_id</code></em>,
 
110
                                                         <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> *icon</code></em>);
 
111
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a href="YelpDocument.html#yelp-document-has-page">yelp_document_has_page</a>              (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
112
                                                         <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> *page_id</code></em>);
113
113
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-signal">yelp_document_signal</a>                (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
114
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
 
114
                                                         <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> *page_id</code></em>,
115
115
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentSignal"><span class="type">YelpDocumentSignal</span></a> signal</code></em>,
116
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
 
116
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);
117
117
<span class="returnvalue">void</span>                <a href="YelpDocument.html#yelp-document-error-pending">yelp_document_error_pending</a>         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
118
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
 
118
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);
 
119
                    <a href="YelpDocument.html#YelpDocumentPriv">YelpDocumentPriv</a>;
119
120
</pre>
120
121
</div>
121
 
<div class="refsect1" title="Object Hierarchy">
 
122
<div class="refsect1">
122
123
<a name="YelpDocument.object-hierarchy"></a><h2>Object Hierarchy</h2>
123
124
<pre class="synopsis">
124
 
  GObject
 
125
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
125
126
   +----YelpDocument
126
127
         +----YelpDocbookDocument
127
128
         +----YelpHelpList
131
132
         +----<a href="YelpSimpleDocument.html">YelpSimpleDocument</a>
132
133
</pre>
133
134
</div>
134
 
<div class="refsect1" title="Properties">
 
135
<div class="refsect1">
135
136
<a name="YelpDocument.properties"></a><h2>Properties</h2>
136
137
<pre class="synopsis">
137
 
  "<a href="YelpDocument.html#YelpDocument--document-uri">document-uri</a>"             <span class="type">gchar</span>*                : Read / Write / Construct Only
138
 
  "<a href="YelpDocument.html#YelpDocument--indexed">indexed</a>"                  <span class="type">gboolean</span>              : Read / Write / Construct
 
138
  "<a href="YelpDocument.html#YelpDocument--document-uri">document-uri</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
139
  "<a href="YelpDocument.html#YelpDocument--indexed">indexed</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
139
140
</pre>
140
141
</div>
141
 
<div class="refsect1" title="Description">
 
142
<div class="refsect1">
142
143
<a name="YelpDocument.description"></a><h2>Description</h2>
143
144
</div>
144
 
<div class="refsect1" title="Details">
 
145
<div class="refsect1">
145
146
<a name="YelpDocument.details"></a><h2>Details</h2>
146
 
<div class="refsect2" title="YelpDocument">
147
 
<a name="YelpDocument-struct"></a><h3>YelpDocument</h3>
148
 
<pre class="programlisting">typedef struct _YelpDocument YelpDocument;</pre>
149
 
</div>
150
 
<hr>
151
 
<div class="refsect2" title="YelpDocumentClass">
152
 
<a name="YelpDocumentClass"></a><h3>YelpDocumentClass</h3>
153
 
<pre class="programlisting">typedef struct {
 
147
<div class="refsect2">
 
148
<a name="YelpDocumentSignal"></a><h3>enum YelpDocumentSignal</h3>
 
149
<pre class="programlisting">typedef enum {
 
150
    YELP_DOCUMENT_SIGNAL_CONTENTS,
 
151
    YELP_DOCUMENT_SIGNAL_INFO,
 
152
    YELP_DOCUMENT_SIGNAL_ERROR
 
153
} YelpDocumentSignal;
 
154
</pre>
 
155
</div>
 
156
<hr>
 
157
<div class="refsect2">
 
158
<a name="YelpDocumentCallback"></a><h3>YelpDocumentCallback ()</h3>
 
159
<pre class="programlisting"><span class="returnvalue">void</span>                (*YelpDocumentCallback)             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
160
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentSignal"><span class="type">YelpDocumentSignal</span></a> signal</code></em>,
 
161
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
162
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
 
163
</div>
 
164
<hr>
 
165
<div class="refsect2">
 
166
<a name="YelpDocument-struct"></a><h3>struct YelpDocument</h3>
 
167
<pre class="programlisting">struct YelpDocument;</pre>
 
168
</div>
 
169
<hr>
 
170
<div class="refsect2">
 
171
<a name="YelpDocumentClass"></a><h3>struct YelpDocumentClass</h3>
 
172
<pre class="programlisting">struct YelpDocumentClass {
154
173
    GObjectClass      parent_class;
155
174
 
156
175
    /* Virtual Functions */
166
185
    gchar *       (*get_mime_type)             (YelpDocument         *document,
167
186
                                                const gchar          *page_id);
168
187
    void          (*index)                     (YelpDocument         *document);
169
 
} YelpDocumentClass;
170
 
</pre>
171
 
</div>
172
 
<hr>
173
 
<div class="refsect2" title="YelpDocumentPriv">
174
 
<a name="YelpDocumentPriv"></a><h3>YelpDocumentPriv</h3>
175
 
<pre class="programlisting">typedef struct _YelpDocumentPriv YelpDocumentPriv;</pre>
176
 
</div>
177
 
<hr>
178
 
<div class="refsect2" title="enum YelpDocumentSignal">
179
 
<a name="YelpDocumentSignal"></a><h3>enum YelpDocumentSignal</h3>
180
 
<pre class="programlisting">typedef enum {
181
 
    YELP_DOCUMENT_SIGNAL_CONTENTS,
182
 
    YELP_DOCUMENT_SIGNAL_INFO,
183
 
    YELP_DOCUMENT_SIGNAL_ERROR
184
 
} YelpDocumentSignal;
185
 
</pre>
186
 
</div>
187
 
<hr>
188
 
<div class="refsect2" title="YelpDocumentCallback ()">
189
 
<a name="YelpDocumentCallback"></a><h3>YelpDocumentCallback ()</h3>
190
 
<pre class="programlisting"><span class="returnvalue">void</span>                (*YelpDocumentCallback)             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
191
 
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentSignal"><span class="type">YelpDocumentSignal</span></a> signal</code></em>,
192
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
193
 
                                                         <em class="parameter"><code><span class="type">GError</span> *error</code></em>);</pre>
194
 
</div>
195
 
<hr>
196
 
<div class="refsect2" title="yelp_document_get_for_uri ()">
 
188
};
 
189
</pre>
 
190
</div>
 
191
<hr>
 
192
<div class="refsect2">
197
193
<a name="yelp-document-get-for-uri"></a><h3>yelp_document_get_for_uri ()</h3>
198
194
<pre class="programlisting"><a href="YelpDocument.html"><span class="returnvalue">YelpDocument</span></a> *      yelp_document_get_for_uri           (<em class="parameter"><code><a href="YelpUri.html"><span class="type">YelpUri</span></a> *uri</code></em>);</pre>
199
195
</div>
200
196
<hr>
201
 
<div class="refsect2" title="yelp_document_request_page ()">
 
197
<div class="refsect2">
202
198
<a name="yelp-document-request-page"></a><h3>yelp_document_request_page ()</h3>
203
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            yelp_document_request_page          (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
204
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
205
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
199
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            yelp_document_request_page          (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
200
                                                         <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> *page_id</code></em>,
 
201
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
206
202
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentCallback"><span class="type">YelpDocumentCallback</span></a> callback</code></em>,
207
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
203
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
208
204
</div>
209
205
<hr>
210
 
<div class="refsect2" title="yelp_document_give_contents ()">
 
206
<div class="refsect2">
211
207
<a name="yelp-document-give-contents"></a><h3>yelp_document_give_contents ()</h3>
212
208
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_give_contents         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
213
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
214
 
                                                         <em class="parameter"><code><span class="type">gchar</span> *contents</code></em>,
215
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *mime</code></em>);</pre>
 
209
                                                         <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> *page_id</code></em>,
 
210
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *contents</code></em>,
 
211
                                                         <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> *mime</code></em>);</pre>
216
212
</div>
217
213
<hr>
218
 
<div class="refsect2" title="yelp_document_get_mime_type ()">
 
214
<div class="refsect2">
219
215
<a name="yelp-document-get-mime-type"></a><h3>yelp_document_get_mime_type ()</h3>
220
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_mime_type         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
221
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
216
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_mime_type         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
217
                                                         <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> *page_id</code></em>);</pre>
222
218
</div>
223
219
<hr>
224
 
<div class="refsect2" title="yelp_document_read_contents ()">
 
220
<div class="refsect2">
225
221
<a name="yelp-document-read-contents"></a><h3>yelp_document_read_contents ()</h3>
226
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       yelp_document_read_contents         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
227
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
222
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       yelp_document_read_contents         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
223
                                                         <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> *page_id</code></em>);</pre>
228
224
</div>
229
225
<hr>
230
 
<div class="refsect2" title="yelp_document_finish_read ()">
 
226
<div class="refsect2">
231
227
<a name="yelp-document-finish-read"></a><h3>yelp_document_finish_read ()</h3>
232
228
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_finish_read           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
233
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *contents</code></em>);</pre>
234
 
</div>
235
 
<hr>
236
 
<div class="refsect2" title="yelp_document_list_page_ids ()">
 
229
                                                         <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> *contents</code></em>);</pre>
 
230
</div>
 
231
<hr>
 
232
<div class="refsect2">
 
233
<a name="yelp-document-index"></a><h3>yelp_document_index ()</h3>
 
234
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_index                 (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>);</pre>
 
235
</div>
 
236
<hr>
 
237
<div class="refsect2">
237
238
<a name="yelp-document-list-page-ids"></a><h3>yelp_document_list_page_ids ()</h3>
238
 
<pre class="programlisting"><span class="returnvalue">gchar</span> **            yelp_document_list_page_ids         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>);</pre>
 
239
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **            yelp_document_list_page_ids         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>);</pre>
239
240
</div>
240
241
<hr>
241
 
<div class="refsect2" title="yelp_document_get_page_id ()">
 
242
<div class="refsect2">
242
243
<a name="yelp-document-get-page-id"></a><h3>yelp_document_get_page_id ()</h3>
243
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_page_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
244
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
 
244
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_page_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
245
                                                         <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> *id</code></em>);</pre>
245
246
</div>
246
247
<hr>
247
 
<div class="refsect2" title="yelp_document_set_page_id ()">
 
248
<div class="refsect2">
248
249
<a name="yelp-document-set-page-id"></a><h3>yelp_document_set_page_id ()</h3>
249
250
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_page_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
250
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
251
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
251
                                                         <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> *id</code></em>,
 
252
                                                         <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> *page_id</code></em>);</pre>
252
253
</div>
253
254
<hr>
254
 
<div class="refsect2" title="yelp_document_get_root_id ()">
 
255
<div class="refsect2">
255
256
<a name="yelp-document-get-root-id"></a><h3>yelp_document_get_root_id ()</h3>
256
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_root_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
257
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
257
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_root_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
258
                                                         <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> *page_id</code></em>);</pre>
258
259
</div>
259
260
<hr>
260
 
<div class="refsect2" title="yelp_document_set_root_id ()">
 
261
<div class="refsect2">
261
262
<a name="yelp-document-set-root-id"></a><h3>yelp_document_set_root_id ()</h3>
262
263
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_root_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
263
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
264
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *root_id</code></em>);</pre>
 
264
                                                         <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> *page_id</code></em>,
 
265
                                                         <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> *root_id</code></em>);</pre>
265
266
</div>
266
267
<hr>
267
 
<div class="refsect2" title="yelp_document_get_prev_id ()">
 
268
<div class="refsect2">
268
269
<a name="yelp-document-get-prev-id"></a><h3>yelp_document_get_prev_id ()</h3>
269
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_prev_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
270
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
270
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_prev_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
271
                                                         <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> *page_id</code></em>);</pre>
271
272
</div>
272
273
<hr>
273
 
<div class="refsect2" title="yelp_document_set_prev_id ()">
 
274
<div class="refsect2">
274
275
<a name="yelp-document-set-prev-id"></a><h3>yelp_document_set_prev_id ()</h3>
275
276
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_prev_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
276
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
277
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prev_id</code></em>);</pre>
 
277
                                                         <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> *page_id</code></em>,
 
278
                                                         <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> *prev_id</code></em>);</pre>
278
279
</div>
279
280
<hr>
280
 
<div class="refsect2" title="yelp_document_get_next_id ()">
 
281
<div class="refsect2">
281
282
<a name="yelp-document-get-next-id"></a><h3>yelp_document_get_next_id ()</h3>
282
283
<pre class="programlisting"><span class="returnvalue">char</span> *              yelp_document_get_next_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
283
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
284
                                                         <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> *page_id</code></em>);</pre>
284
285
</div>
285
286
<hr>
286
 
<div class="refsect2" title="yelp_document_set_next_id ()">
 
287
<div class="refsect2">
287
288
<a name="yelp-document-set-next-id"></a><h3>yelp_document_set_next_id ()</h3>
288
289
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_next_id           (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
289
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
290
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *next_id</code></em>);</pre>
 
290
                                                         <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> *page_id</code></em>,
 
291
                                                         <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> *next_id</code></em>);</pre>
291
292
</div>
292
293
<hr>
293
 
<div class="refsect2" title="yelp_document_get_up_id ()">
 
294
<div class="refsect2">
294
295
<a name="yelp-document-get-up-id"></a><h3>yelp_document_get_up_id ()</h3>
295
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_up_id             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
296
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
296
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_up_id             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
297
                                                         <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> *page_id</code></em>);</pre>
297
298
</div>
298
299
<hr>
299
 
<div class="refsect2" title="yelp_document_set_up_id ()">
 
300
<div class="refsect2">
300
301
<a name="yelp-document-set-up-id"></a><h3>yelp_document_set_up_id ()</h3>
301
302
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_up_id             (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
302
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
303
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *up_id</code></em>);</pre>
 
303
                                                         <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> *page_id</code></em>,
 
304
                                                         <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> *up_id</code></em>);</pre>
304
305
</div>
305
306
<hr>
306
 
<div class="refsect2" title="yelp_document_get_root_title ()">
 
307
<div class="refsect2">
307
308
<a name="yelp-document-get-root-title"></a><h3>yelp_document_get_root_title ()</h3>
308
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_root_title        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
309
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
309
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_root_title        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
310
                                                         <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> *page_id</code></em>);</pre>
310
311
</div>
311
312
<hr>
312
 
<div class="refsect2" title="yelp_document_get_page_title ()">
 
313
<div class="refsect2">
313
314
<a name="yelp-document-get-page-title"></a><h3>yelp_document_get_page_title ()</h3>
314
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_page_title        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
315
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
315
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_page_title        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
316
                                                         <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> *page_id</code></em>);</pre>
316
317
</div>
317
318
<hr>
318
 
<div class="refsect2" title="yelp_document_set_page_title ()">
 
319
<div class="refsect2">
319
320
<a name="yelp-document-set-page-title"></a><h3>yelp_document_set_page_title ()</h3>
320
321
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_page_title        (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
321
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
322
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
 
322
                                                         <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> *page_id</code></em>,
 
323
                                                         <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> *title</code></em>);</pre>
323
324
</div>
324
325
<hr>
325
 
<div class="refsect2" title="yelp_document_get_page_desc ()">
 
326
<div class="refsect2">
326
327
<a name="yelp-document-get-page-desc"></a><h3>yelp_document_get_page_desc ()</h3>
327
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_page_desc         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
328
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
328
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_page_desc         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
329
                                                         <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> *page_id</code></em>);</pre>
329
330
</div>
330
331
<hr>
331
 
<div class="refsect2" title="yelp_document_set_page_desc ()">
 
332
<div class="refsect2">
332
333
<a name="yelp-document-set-page-desc"></a><h3>yelp_document_set_page_desc ()</h3>
333
334
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_page_desc         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
334
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
335
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre>
 
335
                                                         <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> *page_id</code></em>,
 
336
                                                         <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> *desc</code></em>);</pre>
336
337
</div>
337
338
<hr>
338
 
<div class="refsect2" title="yelp_document_get_page_icon ()">
 
339
<div class="refsect2">
339
340
<a name="yelp-document-get-page-icon"></a><h3>yelp_document_get_page_icon ()</h3>
340
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             yelp_document_get_page_icon         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
341
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
341
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             yelp_document_get_page_icon         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
342
                                                         <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> *page_id</code></em>);</pre>
342
343
</div>
343
344
<hr>
344
 
<div class="refsect2" title="yelp_document_set_page_icon ()">
 
345
<div class="refsect2">
345
346
<a name="yelp-document-set-page-icon"></a><h3>yelp_document_set_page_icon ()</h3>
346
347
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_set_page_icon         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
347
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
348
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon</code></em>);</pre>
 
348
                                                         <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> *page_id</code></em>,
 
349
                                                         <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> *icon</code></em>);</pre>
349
350
</div>
350
351
<hr>
351
 
<div class="refsect2" title="yelp_document_has_page ()">
 
352
<div class="refsect2">
352
353
<a name="yelp-document-has-page"></a><h3>yelp_document_has_page ()</h3>
353
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            yelp_document_has_page              (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
354
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>);</pre>
 
354
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            yelp_document_has_page              (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
 
355
                                                         <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> *page_id</code></em>);</pre>
355
356
</div>
356
357
<hr>
357
 
<div class="refsect2" title="yelp_document_signal ()">
 
358
<div class="refsect2">
358
359
<a name="yelp-document-signal"></a><h3>yelp_document_signal ()</h3>
359
360
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_signal                (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
360
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *page_id</code></em>,
 
361
                                                         <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> *page_id</code></em>,
361
362
                                                         <em class="parameter"><code><a href="YelpDocument.html#YelpDocumentSignal"><span class="type">YelpDocumentSignal</span></a> signal</code></em>,
362
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
 
363
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
363
364
</div>
364
365
<hr>
365
 
<div class="refsect2" title="yelp_document_error_pending ()">
 
366
<div class="refsect2">
366
367
<a name="yelp-document-error-pending"></a><h3>yelp_document_error_pending ()</h3>
367
368
<pre class="programlisting"><span class="returnvalue">void</span>                yelp_document_error_pending         (<em class="parameter"><code><a href="YelpDocument.html"><span class="type">YelpDocument</span></a> *document</code></em>,
368
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
369
 
</div>
370
 
</div>
371
 
<div class="refsect1" title="Property Details">
 
369
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
 
370
</div>
 
371
<hr>
 
372
<div class="refsect2">
 
373
<a name="YelpDocumentPriv"></a><h3>YelpDocumentPriv</h3>
 
374
<pre class="programlisting">typedef struct _YelpDocumentPriv YelpDocumentPriv;</pre>
 
375
</div>
 
376
</div>
 
377
<div class="refsect1">
372
378
<a name="YelpDocument.property-details"></a><h2>Property Details</h2>
373
 
<div class="refsect2" title='The "document-uri" property'>
 
379
<div class="refsect2">
374
380
<a name="YelpDocument--document-uri"></a><h3>The <code class="literal">"document-uri"</code> property</h3>
375
 
<pre class="programlisting">  "document-uri"             <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
 
381
<pre class="programlisting">  "document-uri"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
376
382
<p>The URI which identifies the document.</p>
377
383
<p>Default value: NULL</p>
378
384
</div>
379
385
<hr>
380
 
<div class="refsect2" title='The "indexed" property'>
 
386
<div class="refsect2">
381
387
<a name="YelpDocument--indexed"></a><h3>The <code class="literal">"indexed"</code> property</h3>
382
 
<pre class="programlisting">  "indexed"                  <span class="type">gboolean</span>              : Read / Write / Construct</pre>
 
388
<pre class="programlisting">  "indexed"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
383
389
<p>Whether the document content has been indexed.</p>
384
390
<p>Default value: FALSE</p>
385
391
</div>
387
393
</div>
388
394
<div class="footer">
389
395
<hr>
390
 
          Generated by GTK-Doc V1.15</div>
 
396
          Generated by GTK-Doc V1.18</div>
391
397
</body>
392
398
</html>
 
 
b'\\ No newline at end of file'