/usr/share/gtk-doc/html/libchamplain-0.12/ChamplainTileCache.html is in libchamplain-doc 0.12.16-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChamplainTileCache: libchamplain Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libchamplain Reference Manual">
<link rel="up" href="ch05.html" title="Tile Caches">
<link rel="prev" href="ch05.html" title="Tile Caches">
<link rel="next" href="ChamplainFileCache.html" title="ChamplainFileCache">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ChamplainTileCache.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ChamplainTileCache.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ChamplainFileCache.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ChamplainTileCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ChamplainTileCache.top_of_page"></a>ChamplainTileCache</span></h2>
<p>ChamplainTileCache — A base class of tile caches</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ChamplainTileCache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ChamplainTileCache.html#champlain-tile-cache-store-tile" title="champlain_tile_cache_store_tile ()">champlain_tile_cache_store_tile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ChamplainTileCache.html#champlain-tile-cache-refresh-tile-time" title="champlain_tile_cache_refresh_tile_time ()">champlain_tile_cache_refresh_tile_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ChamplainTileCache.html#champlain-tile-cache-on-tile-filled" title="champlain_tile_cache_on_tile_filled ()">champlain_tile_cache_on_tile_filled</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ChamplainTileCache.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ChamplainTileCache.html#ChamplainTileCache-struct" title="struct ChamplainTileCache">ChamplainTileCache</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ChamplainTileCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource">ChamplainMapSource</a>
<span class="lineart">╰──</span> ChamplainTileCache
<span class="lineart">├──</span> <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache">ChamplainFileCache</a>
<span class="lineart">╰──</span> <a class="link" href="ChamplainMemoryCache.html" title="ChamplainMemoryCache">ChamplainMemoryCache</a>
</pre>
</div>
<div class="refsect1">
<a name="ChamplainTileCache.description"></a><h2>Description</h2>
<p>This class defines properties and methods commons to all caches (that is, map
sources that permit storage and retrieval of tiles). Tiles are typically
stored by <a class="link" href="ChamplainTileSource.html" title="ChamplainTileSource"><span class="type">ChamplainTileSource</span></a> objects.</p>
</div>
<div class="refsect1">
<a name="ChamplainTileCache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="champlain-tile-cache-store-tile"></a><h3>champlain_tile_cache_store_tile ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
champlain_tile_cache_store_tile (<em class="parameter"><code><a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a> *tile_cache</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a> *tile</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *contents</code></em>,
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>
<p>Stores the tile including the metadata into the cache.</p>
<div class="refsect3">
<a name="champlain-tile-cache-store-tile.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tile_cache</p></td>
<td class="parameter_description"><p>a <a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tile</p></td>
<td class="parameter_description"><p>a <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>contents</p></td>
<td class="parameter_description"><p>the tile contents that should be stored</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>size of the contents in bytes</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-tile-cache-refresh-tile-time"></a><h3>champlain_tile_cache_refresh_tile_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
champlain_tile_cache_refresh_tile_time
(<em class="parameter"><code><a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a> *tile_cache</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a> *tile</code></em>);</pre>
<p>Refreshes the tile access time in the cache.</p>
<div class="refsect3">
<a name="champlain-tile-cache-refresh-tile-time.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tile_cache</p></td>
<td class="parameter_description"><p>a <a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tile</p></td>
<td class="parameter_description"><p>a <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-tile-cache-on-tile-filled"></a><h3>champlain_tile_cache_on_tile_filled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
champlain_tile_cache_on_tile_filled (<em class="parameter"><code><a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a> *tile_cache</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a> *tile</code></em>);</pre>
<p>When a cache fills a tile and the next source in the chain is a tile cache,
it should call this function on the next source. This way all the caches
preceding a tile source in the chain get informed that the tile was used and
can modify their metadata accordingly in the implementation of this function.
In addition, the call of this function should be chained so within the
implementation of this function it should be called on the next source
in the chain when next source is a tile cache.</p>
<div class="refsect3">
<a name="champlain-tile-cache-on-tile-filled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tile_cache</p></td>
<td class="parameter_description"><p>a <a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tile</p></td>
<td class="parameter_description"><p>a <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.6</p>
</div>
</div>
<div class="refsect1">
<a name="ChamplainTileCache.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ChamplainTileCache-struct"></a><h3>struct ChamplainTileCache</h3>
<pre class="programlisting">struct ChamplainTileCache;</pre>
<p>The <a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache"><span class="type">ChamplainTileCache</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: 0.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|