/usr/share/gtk-doc/html/libgrss/GrssFeedsStore.html is in libgrss-dev 0.5.0-2ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GrssFeedsStore</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libgrss Reference Manual">
<link rel="up" href="libgrss-utils.html" title="Part III. Useful Objects">
<link rel="prev" href="GrssFeedsPublisher.html" title="GrssFeedsPublisher">
<link rel="next" href="ix01.html" title="Index">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GrssFeedsPublisher.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgrss-utils.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">libgrss Reference Manual</th>
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GrssFeedsStore.synopsis" class="shortcut">Top</a>
|
<a href="#GrssFeedsStore.description" class="shortcut">Description</a>
|
<a href="#GrssFeedsStore.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GrssFeedsStore"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GrssFeedsStore.top_of_page"></a>GrssFeedsStore</span></h2>
<p>GrssFeedsStore — abstract class for feeds permanent storage</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GrssFeedsStore.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GrssFeedsStore.html#GrssFeedsStore-struct" title="struct GrssFeedsStore">GrssFeedsStore</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="GrssFeedsStore.html#grss-feeds-store-get-channels" title="grss_feeds_store_get_channels ()">grss_feeds_store_get_channels</a> (<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="GrssFeedsStore.html#grss-feeds-store-get-items-by-channel" title="grss_feeds_store_get_items_by_channel ()">grss_feeds_store_get_items_by_channel</a>
(<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> *channel</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GrssFeedsStore.html#grss-feeds-store-has-item" title="grss_feeds_store_has_item ()">grss_feeds_store_has_item</a> (<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> *channel</code></em>,
<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>);
<span class="returnvalue">void</span> <a class="link" href="GrssFeedsStore.html#grss-feeds-store-add-item-in-channel" title="grss_feeds_store_add_item_in_channel ()">grss_feeds_store_add_item_in_channel</a>
(<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> *channel</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedItem.html" title="GrssFeedItem"><span class="type">GrssFeedItem</span></a> *item</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GrssFeedsStore.html#grss-feeds-store-switch" title="grss_feeds_store_switch ()">grss_feeds_store_switch</a> (<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> run</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsStore.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GrssFeedsStore
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsStore.description"></a><h2>Description</h2>
<p>
<a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> is a class which abstracts storage of feeds, implementing some
behaviours valid for all. Extensions of this must provide implementation
of different callbacks so to permit permanent saving of channels and feeds.
</p>
</div>
<div class="refsect1">
<a name="GrssFeedsStore.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GrssFeedsStore-struct"></a><h3>struct GrssFeedsStore</h3>
<pre class="programlisting">struct GrssFeedsStore;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-store-get-channels"></a><h3>grss_feeds_store_get_channels ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * grss_feeds_store_get_channels (<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>);</pre>
<p>
To retrieve list of feeds permanently saved into the store.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>list of <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> found in the <em class="parameter"><code>store</code></em>. Do not modify or
free it.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-store-get-items-by-channel"></a><h3>grss_feeds_store_get_items_by_channel ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * grss_feeds_store_get_items_by_channel
(<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> *channel</code></em>);</pre>
<p>
To retrieve list of items saved into the store, assigned to the given
<em class="parameter"><code>channel</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>parent feed containing required items.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>list of <a class="link" href="GrssFeedItem.html" title="GrssFeedItem"><span class="type">GrssFeedItem</span></a> found in the <em class="parameter"><code>store</code></em>. Do not modify or free
it.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-store-has-item"></a><h3>grss_feeds_store_has_item ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> grss_feeds_store_has_item (<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> *channel</code></em>,
<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>
<p>
To retrieve an item into a feed, given his unique ID.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>parent feed containing required item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>unique ID to look for.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the specified item exists, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-store-add-item-in-channel"></a><h3>grss_feeds_store_add_item_in_channel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> grss_feeds_store_add_item_in_channel
(<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> *channel</code></em>,
<em class="parameter"><code><a class="link" href="GrssFeedItem.html" title="GrssFeedItem"><span class="type">GrssFeedItem</span></a> *item</code></em>);</pre>
<p>
To save a new <a class="link" href="GrssFeedItem.html" title="GrssFeedItem"><span class="type">GrssFeedItem</span></a> into the <em class="parameter"><code>store</code></em>. It performs a check to grant
<em class="parameter"><code>item</code></em> is not already saved.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>parent feed for the new item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>new item to permanently save.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-store-switch"></a><h3>grss_feeds_store_switch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> grss_feeds_store_switch (<em class="parameter"><code><a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a> *store</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> run</code></em>);</pre>
<p>
This is to permit the <em class="parameter"><code>store</code></em> to auto-update itself: it creates an internal
<a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> and listens for his signals, so to implement the whole loop
fetch-parse-save trasparently.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsStore.html" title="GrssFeedsStore"><span class="type">GrssFeedsStore</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>run</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to run the <em class="parameter"><code>store</code></em>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to stop.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|