/usr/share/gtk-doc/html/libchamplain-0.12/ChamplainMapSourceFactory.html is in libchamplain-doc 0.12.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChamplainMapSourceFactory: 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="ch06.html" title="Map Source Utilities">
<link rel="prev" href="ChamplainMapSourceChain.html" title="ChamplainMapSourceChain">
<link rel="next" href="ChamplainMapSourceDesc.html" title="ChamplainMapSourceDesc">
<meta name="generator" content="GTK-Doc V1.24 (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="#ChamplainMapSourceFactory.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ChamplainMapSourceFactory.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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ChamplainMapSourceChain.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ChamplainMapSourceDesc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ChamplainMapSourceFactory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ChamplainMapSourceFactory.top_of_page"></a>ChamplainMapSourceFactory</span></h2>
<p>ChamplainMapSourceFactory — Manages <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> instances</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ChamplainMapSourceFactory.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">
<a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="returnvalue">ChamplainMapSourceFactory</span></a> *
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-dup-default" title="champlain_map_source_factory_dup_default ()">champlain_map_source_factory_dup_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-create" title="champlain_map_source_factory_create ()">champlain_map_source_factory_create</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-create-cached-source" title="champlain_map_source_factory_create_cached_source ()">champlain_map_source_factory_create_cached_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-create-memcached-source" title="champlain_map_source_factory_create_memcached_source ()">champlain_map_source_factory_create_memcached_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-create-error-source" title="champlain_map_source_factory_create_error_source ()">champlain_map_source_factory_create_error_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-register" title="champlain_map_source_factory_register ()">champlain_map_source_factory_register</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-get-registered" title="champlain_map_source_factory_get_registered ()">champlain_map_source_factory_get_registered</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ChamplainMapSourceFactory.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="ChamplainMapSourceFactory.html#ChamplainMapSourceFactory-struct" title="struct ChamplainMapSourceFactory">ChamplainMapSourceFactory</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OSM-MAPNIK:CAPS" title="CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK">CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OSM-CYCLE-MAP:CAPS" title="CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP">CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OSM-TRANSPORT-MAP:CAPS" title="CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP">CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OSM-AERIAL-MAP:CAPS" title="CHAMPLAIN_MAP_SOURCE_OSM_AERIAL_MAP">CHAMPLAIN_MAP_SOURCE_OSM_AERIAL_MAP</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OSM-MAPQUEST:CAPS" title="CHAMPLAIN_MAP_SOURCE_OSM_MAPQUEST">CHAMPLAIN_MAP_SOURCE_OSM_MAPQUEST</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-MFF-RELIEF:CAPS" title="CHAMPLAIN_MAP_SOURCE_MFF_RELIEF">CHAMPLAIN_MAP_SOURCE_MFF_RELIEF</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OAM:CAPS" title="CHAMPLAIN_MAP_SOURCE_OAM">CHAMPLAIN_MAP_SOURCE_OAM</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OSM-OSMARENDER:CAPS" title="CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER">CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OWM-CLOUDS:CAPS" title="CHAMPLAIN_MAP_SOURCE_OWM_CLOUDS">CHAMPLAIN_MAP_SOURCE_OWM_CLOUDS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OWM-PRECIPITATION:CAPS" title="CHAMPLAIN_MAP_SOURCE_OWM_PRECIPITATION">CHAMPLAIN_MAP_SOURCE_OWM_PRECIPITATION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OWM-PRESSURE:CAPS" title="CHAMPLAIN_MAP_SOURCE_OWM_PRESSURE">CHAMPLAIN_MAP_SOURCE_OWM_PRESSURE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OWM-TEMPERATURE:CAPS" title="CHAMPLAIN_MAP_SOURCE_OWM_TEMPERATURE">CHAMPLAIN_MAP_SOURCE_OWM_TEMPERATURE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ChamplainMapSourceFactory.html#CHAMPLAIN-MAP-SOURCE-OWM-WIND:CAPS" title="CHAMPLAIN_MAP_SOURCE_OWM_WIND">CHAMPLAIN_MAP_SOURCE_OWM_WIND</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ChamplainMapSourceFactory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ChamplainMapSourceFactory
</pre>
</div>
<div class="refsect1">
<a name="ChamplainMapSourceFactory.description"></a><h2>Description</h2>
<p>This factory manages the create of <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>. It contains names
and constructor functions for each available map sources in libchamplain.
You can add your own with <a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-register" title="champlain_map_source_factory_register ()"><span class="type">champlain_map_source_factory_register</span></a>.</p>
<p>To get the wanted map source, use <a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-create" title="champlain_map_source_factory_create ()"><span class="type">champlain_map_source_factory_create</span></a>. It
will return a ready to use <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>.</p>
<p>To get the list of registered map sources, use
<a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-get-registered" title="champlain_map_source_factory_get_registered ()"><span class="type">champlain_map_source_factory_get_registered</span></a>.</p>
</div>
<div class="refsect1">
<a name="ChamplainMapSourceFactory.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="champlain-map-source-factory-dup-default"></a><h3>champlain_map_source_factory_dup_default ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="returnvalue">ChamplainMapSourceFactory</span></a> *
champlain_map_source_factory_dup_default
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>A method to obtain the singleton object.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.2.5"></a><h4>Returns</h4>
<p> the singleton <a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a>, it should be freed
using <code class="function"><GTKDOCLINK HREF="g-object-unref"><code class="function">g_object_unref()</code></code></GTKDOCLINK> when not needed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-factory-create"></a><h3>champlain_map_source_factory_create ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
champlain_map_source_factory_create (<em class="parameter"><code><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> *factory</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>Note: The id should not contain any character that can't be in a filename as it
will be used as the cache directory name for that map source.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.3.5"></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>factory</p></td>
<td class="parameter_description"><p>the Factory</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>the wanted map source id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.3.7.3.6"></a><h4>Returns</h4>
<p> a ready to use <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> matching the given name, returns
NULL is none match. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-factory-create-cached-source"></a><h3>champlain_map_source_factory_create_cached_source ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
champlain_map_source_factory_create_cached_source
(<em class="parameter"><code><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> *factory</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>Creates a cached map source.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.4.5"></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>factory</p></td>
<td class="parameter_description"><p>the Factory</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>the wanted map source id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.3.7.4.6"></a><h4>Returns</h4>
<p> a ready to use <a class="link" href="ChamplainMapSourceChain.html" title="ChamplainMapSourceChain"><span class="type">ChamplainMapSourceChain</span></a> consisting of
<a class="link" href="ChamplainMemoryCache.html" title="ChamplainMemoryCache"><span class="type">ChamplainMemoryCache</span></a>, <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>, <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> matching the given name, and
an error tile source created with <a class="link" href="ChamplainMapSourceFactory.html#champlain-map-source-factory-create-error-source" title="champlain_map_source_factory_create_error_source ()"><code class="function">champlain_map_source_factory_create_error_source()</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-factory-create-memcached-source"></a><h3>champlain_map_source_factory_create_memcached_source ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
champlain_map_source_factory_create_memcached_source
(<em class="parameter"><code><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> *factory</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>Creates a memory cached map source.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.5.5"></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>factory</p></td>
<td class="parameter_description"><p>the Factory</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>the wanted map source id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.3.7.5.6"></a><h4>Returns</h4>
<p> a ready to use <a class="link" href="ChamplainMapSourceChain.html" title="ChamplainMapSourceChain"><span class="type">ChamplainMapSourceChain</span></a> consisting of
<a class="link" href="ChamplainMemoryCache.html" title="ChamplainMemoryCache"><span class="type">ChamplainMemoryCache</span></a> and <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> matching the given name. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.12.5</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-factory-create-error-source"></a><h3>champlain_map_source_factory_create_error_source ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> *
champlain_map_source_factory_create_error_source
(<em class="parameter"><code><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> *factory</code></em>,
<em class="parameter"><code><span class="type">guint</span> tile_size</code></em>);</pre>
<p>Creates a map source generating error tiles.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.6.5"></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>factory</p></td>
<td class="parameter_description"><p>the Factory</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tile_size</p></td>
<td class="parameter_description"><p>the size of the error tile</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.3.7.6.6"></a><h4>Returns</h4>
<p> a ready to use map source generating error tiles. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-factory-register"></a><h3>champlain_map_source_factory_register ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
champlain_map_source_factory_register (<em class="parameter"><code><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> *factory</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainMapSourceDesc.html" title="ChamplainMapSourceDesc"><span class="type">ChamplainMapSourceDesc</span></a> *desc</code></em>);</pre>
<p>Registers the new map source with the given constructor. When this map
source is requested, the given constructor will be used to build the
map source. <a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> will take ownership of the passed
<a class="link" href="ChamplainMapSourceDesc.html" title="ChamplainMapSourceDesc"><span class="type">ChamplainMapSourceDesc</span></a>, so don't free it.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.7.5"></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>factory</p></td>
<td class="parameter_description"><p>A <a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>desc</p></td>
<td class="parameter_description"><p>the description of the map source</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.3.7.7.6"></a><h4>Returns</h4>
<p> TRUE if the registration suceeded.</p>
</div>
<p class="since">Since: 0.10</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-factory-get-registered"></a><h3>champlain_map_source_factory_get_registered ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *
champlain_map_source_factory_get_registered
(<em class="parameter"><code><a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> *factory</code></em>);</pre>
<p>Get the list of registered map sources.</p>
<div class="refsect3">
<a name="id-1.5.5.3.7.8.5"></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>factory</p></td>
<td class="parameter_description"><p>the Factory</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.3.7.8.6"></a><h4>Returns</h4>
<p> the list of registered map sources, the items should not be freed,
the list should be freed with <span class="type">g_slist_free</span>. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ChamplainMapSourceDesc]</span></p>
</div>
<p class="since">Since: 0.4</p>
</div>
</div>
<div class="refsect1">
<a name="ChamplainMapSourceFactory.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ChamplainMapSourceFactory-struct"></a><h3>struct ChamplainMapSourceFactory</h3>
<pre class="programlisting">struct ChamplainMapSourceFactory;</pre>
<p>The <a class="link" href="ChamplainMapSourceFactory.html" title="ChamplainMapSourceFactory"><span class="type">ChamplainMapSourceFactory</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OSM-MAPNIK:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK "osm-mapnik"
</pre>
<p>OpenStreetMap Mapnik</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OSM-CYCLE-MAP:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP "osm-cyclemap"
</pre>
<p>OpenStreetMap Cycle Map</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OSM-TRANSPORT-MAP:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP "osm-transportmap"
</pre>
<p>OpenStreetMap Transport Map</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OSM-AERIAL-MAP:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OSM_AERIAL_MAP</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OSM_AERIAL_MAP "osm-aerialmap"
</pre>
<p>Mapquest Open Aerial</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OSM-MAPQUEST:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OSM_MAPQUEST</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OSM_MAPQUEST "osm-mapquest"
</pre>
<p>Mapquest OpenStreetMap</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-MFF-RELIEF:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_MFF_RELIEF</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_MFF_RELIEF "mff-relief"
</pre>
<p>Maps for Free Relief</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OAM:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OAM</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OAM "OpenAerialMap"
</pre>
<div class="warning">
<p><code class="literal">CHAMPLAIN_MAP_SOURCE_OAM</code> is deprecated and should not be used in newly-written code.</p>
<p>OpenAerialMap isn't available any more and will be removed in the next release.
As it doens't exist, it isn't registered to the factory and the 'create' method won't
return any source.</p>
</div>
<p>OpenAerialMap</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OSM-OSMARENDER:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER "osm-osmarender"
</pre>
<div class="warning">
<p><code class="literal">CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER</code> is deprecated and should not be used in newly-written code.</p>
<p>Osmarender isn't available any more and will be removed in the next release.
As it doens't exist, it isn't registered to the factory and the 'create' method won't
return any source.</p>
</div>
<p>OpenStreetMap Osmarender</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OWM-CLOUDS:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OWM_CLOUDS</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OWM_CLOUDS "owm-clouds"
</pre>
<p>OpenWeatherMap clouds layer</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OWM-PRECIPITATION:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OWM_PRECIPITATION</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OWM_PRECIPITATION "owm-precipitation"
</pre>
<p>OpenWeatherMap precipitation</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OWM-PRESSURE:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OWM_PRESSURE</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OWM_PRESSURE "owm-pressure"
</pre>
<p>OpenWeatherMap sea level pressure</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OWM-TEMPERATURE:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OWM_TEMPERATURE</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OWM_TEMPERATURE "owm-temperature"
</pre>
<p>OpenWeatherMap temperature</p>
</div>
<hr>
<div class="refsect2">
<a name="CHAMPLAIN-MAP-SOURCE-OWM-WIND:CAPS"></a><h3>CHAMPLAIN_MAP_SOURCE_OWM_WIND</h3>
<pre class="programlisting">#define CHAMPLAIN_MAP_SOURCE_OWM_WIND "owm-wind"
</pre>
<p>OpenWeatherMap wind</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|