/usr/share/gtk-doc/html/libchamplain/ChamplainMapSource.html is in libchamplain-doc 0.12.2-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 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChamplainMapSource</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libchamplain Reference Manual">
<link rel="up" href="pt04.html" title="Part IV. Map Source API">
<link rel="prev" href="pt04.html" title="Part IV. Map Source API">
<link rel="next" href="ch04.html" title="Tile Sources">
<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="pt04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pt04.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">libchamplain Reference Manual</th>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ChamplainMapSource.synopsis" class="shortcut">Top</a>
|
<a href="#ChamplainMapSource.description" class="shortcut">Description</a>
|
<a href="#ChamplainMapSource.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ChamplainMapSource.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="ChamplainMapSource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ChamplainMapSource.top_of_page"></a>ChamplainMapSource</span></h2>
<p>ChamplainMapSource — A base class for map sources</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ChamplainMapSource.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="ChamplainMapSource.html#ChamplainMapSource-struct" title="struct ChamplainMapSource">ChamplainMapSource</a>;
enum <a class="link" href="ChamplainMapSource.html#ChamplainMapProjection" title="enum ChamplainMapProjection">ChamplainMapProjection</a>;
const <span class="returnvalue">gchar</span> * <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-id" title="champlain_map_source_get_id ()">champlain_map_source_get_id</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-name" title="champlain_map_source_get_name ()">champlain_map_source_get_name</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-license" title="champlain_map_source_get_license ()">champlain_map_source_get_license</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-license-uri" title="champlain_map_source_get_license_uri ()">champlain_map_source_get_license_uri</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-min-zoom-level" title="champlain_map_source_get_min_zoom_level ()">champlain_map_source_get_min_zoom_level</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-max-zoom-level" title="champlain_map_source_get_max_zoom_level ()">champlain_map_source_get_max_zoom_level</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-tile-size" title="champlain_map_source_get_tile_size ()">champlain_map_source_get_tile_size</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<a class="link" href="ChamplainMapSource.html#ChamplainMapProjection" title="enum ChamplainMapProjection"><span class="returnvalue">ChamplainMapProjection</span></a> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-projection" title="champlain_map_source_get_projection ()">champlain_map_source_get_projection</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-x" title="champlain_map_source_get_x ()">champlain_map_source_get_x</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> longitude</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-y" title="champlain_map_source_get_y ()">champlain_map_source_get_y</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> latitude</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-longitude" title="champlain_map_source_get_longitude ()">champlain_map_source_get_longitude</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-latitude" title="champlain_map_source_get_latitude ()">champlain_map_source_get_latitude</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-row-count" title="champlain_map_source_get_row_count ()">champlain_map_source_get_row_count</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-column-count" title="champlain_map_source_get_column_count ()">champlain_map_source_get_column_count</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-meters-per-pixel" title="champlain_map_source_get_meters_per_pixel ()">champlain_map_source_get_meters_per_pixel</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> latitude</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> longitude</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-fill-tile" title="champlain_map_source_fill_tile ()">champlain_map_source_fill_tile</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a> *tile</code></em>);
<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> * <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-next-source" title="champlain_map_source_get_next_source ()">champlain_map_source_get_next_source</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-set-next-source" title="champlain_map_source_set_next_source ()">champlain_map_source_set_next_source</a>
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *next_source</code></em>);
<a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="returnvalue">ChamplainRenderer</span></a> * <a class="link" href="ChamplainMapSource.html#champlain-map-source-get-renderer" title="champlain_map_source_get_renderer ()">champlain_map_source_get_renderer</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ChamplainMapSource.html#champlain-map-source-set-renderer" title="champlain_map_source_set_renderer ()">champlain_map_source_set_renderer</a> (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a> *renderer</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ChamplainMapSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----ChamplainMapSource
+----<a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache">ChamplainTileCache</a>
+----<a class="link" href="ChamplainTileSource.html" title="ChamplainTileSource">ChamplainTileSource</a>
+----<a class="link" href="ChamplainMapSourceChain.html" title="ChamplainMapSourceChain">ChamplainMapSourceChain</a>
</pre>
</div>
<div class="refsect1">
<a name="ChamplainMapSource.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="ChamplainMapSource.html#ChamplainMapSource--next-source" title='The "next-source" property'>next-source</a>" <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>* : Read / Write
"<a class="link" href="ChamplainMapSource.html#ChamplainMapSource--renderer" title='The "renderer" property'>renderer</a>" <a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="ChamplainMapSource.description"></a><h2>Description</h2>
<p>
<a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a> objects come from map sources which are represented by
<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>. This is should be considered an abstract
type as it does nothing of interest.
</p>
<p>
When loading new tiles, <a class="link" href="ChamplainView.html" title="ChamplainView"><span class="type">ChamplainView</span></a> calls <a class="link" href="ChamplainMapSource.html#champlain-map-source-fill-tile" title="champlain_map_source_fill_tile ()"><code class="function">champlain_map_source_fill_tile()</code></a>
on the current <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> passing it a <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a> to be filled
with the image.
</p>
<p>
Apart from being a base class of all map sources, <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
also supports cooperation of multiple map sources by arranging them into
chains. Every map source has the <a class="link" href="ChamplainMapSource.html#ChamplainMapSource--next-source" title='The "next-source" property'><span class="type">"next-source"</span></a> property
that determines the next map source in the chain. When a function of
a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> object is invoked, the map source may decide to
delegate the work to the next map source in the chain by invoking the
same function on it.
</p>
<p>
To undertand the concept of chains, consider for instance a chain
consisting of <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> whose next source is
<a class="link" href="ChamplainNetworkTileSource.html" title="ChamplainNetworkTileSource"><span class="type">ChamplainNetworkTileSource</span></a> whose next source is 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>.
When <a class="link" href="ChamplainMapSource.html#champlain-map-source-fill-tile" title="champlain_map_source_fill_tile ()"><code class="function">champlain_map_source_fill_tile()</code></a> is called on the first object of the
chain, <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>, the cache checks whether it contains the
requested tile in its database. If it does, it returns the tile; otherwise,
it calls <a class="link" href="ChamplainMapSource.html#champlain-map-source-fill-tile" title="champlain_map_source_fill_tile ()"><code class="function">champlain_map_source_fill_tile()</code></a> on the next source in the chain
(<a class="link" href="ChamplainNetworkTileSource.html" title="ChamplainNetworkTileSource"><span class="type">ChamplainNetworkTileSource</span></a>). The network tile source loads the tile
from the network. When successful, it returns the tile; otherwise it requests
the tile from the next source in the chain (error tile source).
The error tile source always generates an error tile, no matter what
its next source is.
</p>
</div>
<div class="refsect1">
<a name="ChamplainMapSource.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ChamplainMapSource-struct"></a><h3>struct ChamplainMapSource</h3>
<pre class="programlisting">struct ChamplainMapSource;</pre>
<p>
The <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</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="ChamplainMapProjection"></a><h3>enum ChamplainMapProjection</h3>
<pre class="programlisting">typedef enum {
CHAMPLAIN_MAP_PROJECTION_MERCATOR
} ChamplainMapProjection;
</pre>
<p>
Projections supported by the library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><a name="CHAMPLAIN-MAP-PROJECTION-MERCATOR:CAPS"></a><span class="term"><code class="literal">CHAMPLAIN_MAP_PROJECTION_MERCATOR</code></span></p></td>
<td>Currently the only supported projection
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-id"></a><h3>champlain_map_source_get_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * champlain_map_source_get_id (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's id.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the map source's id.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-name"></a><h3>champlain_map_source_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * champlain_map_source_get_name (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the map source's name.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-license"></a><h3>champlain_map_source_get_license ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * champlain_map_source_get_license (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's license.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the map source's license.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-license-uri"></a><h3>champlain_map_source_get_license_uri ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * champlain_map_source_get_license_uri
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's license URI.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the map source's license URI.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-min-zoom-level"></a><h3>champlain_map_source_get_min_zoom_level ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> champlain_map_source_get_min_zoom_level
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's minimum zoom level.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the miminum zoom level this map source supports</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-max-zoom-level"></a><h3>champlain_map_source_get_max_zoom_level ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> champlain_map_source_get_max_zoom_level
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's maximum zoom level.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the maximum zoom level this map source supports</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-tile-size"></a><h3>champlain_map_source_get_tile_size ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> champlain_map_source_get_tile_size (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's tile size.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the tile's size (width and height) in pixels for this map source</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-projection"></a><h3>champlain_map_source_get_projection ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSource.html#ChamplainMapProjection" title="enum ChamplainMapProjection"><span class="returnvalue">ChamplainMapProjection</span></a> champlain_map_source_get_projection
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Gets map source's projection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the map source's projection.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-x"></a><h3>champlain_map_source_get_x ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> champlain_map_source_get_x (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> longitude</code></em>);</pre>
<p>
Gets the x position on the map using this map source's projection.
(0, 0) is located at the top left.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em> :</span></p></td>
<td>a longitude</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the x position</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-y"></a><h3>champlain_map_source_get_y ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> champlain_map_source_get_y (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> latitude</code></em>);</pre>
<p>
Gets the y position on the map using this map source's projection.
(0, 0) is located at the top left.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>a latitude</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the y position</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-longitude"></a><h3>champlain_map_source_get_longitude ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> champlain_map_source_get_longitude (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>);</pre>
<p>
Gets the longitude corresponding to this x position in the map source's
projection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>a x position</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the longitude</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-latitude"></a><h3>champlain_map_source_get_latitude ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> champlain_map_source_get_latitude (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>);</pre>
<p>
Gets the latitude corresponding to this y position in the map source's
projection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>a y position</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the latitude</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-row-count"></a><h3>champlain_map_source_get_row_count ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> champlain_map_source_get_row_count (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>);</pre>
<p>
Gets the number of tiles in a row at this zoom level for this map source.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of tiles in a row</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-column-count"></a><h3>champlain_map_source_get_column_count ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> champlain_map_source_get_column_count
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>);</pre>
<p>
Gets the number of tiles in a column at this zoom level for this map
source.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of tiles in a column</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-meters-per-pixel"></a><h3>champlain_map_source_get_meters_per_pixel ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> champlain_map_source_get_meters_per_pixel
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><span class="type">guint</span> zoom_level</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> latitude</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> longitude</code></em>);</pre>
<p>
Gets meters per pixel at the position on the map using this map source's projection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zoom_level</code></em> :</span></p></td>
<td>the zoom level</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>a latitude</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em> :</span></p></td>
<td>a longitude</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the meters per pixel</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.3</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-fill-tile"></a><h3>champlain_map_source_fill_tile ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> champlain_map_source_fill_tile (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</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>
Fills the tile with image data (either from cache, network or rendered
locally).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tile</code></em> :</span></p></td>
<td>A <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-next-source"></a><h3>champlain_map_source_get_next_source ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="returnvalue">ChamplainMapSource</span></a> * champlain_map_source_get_next_source
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Get the next source in the chain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the next source in the chain. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-set-next-source"></a><h3>champlain_map_source_set_next_source ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> champlain_map_source_set_next_source
(<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *next_source</code></em>);</pre>
<p>
Sets the next map source in the chain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>next_source</code></em> :</span></p></td>
<td>the next <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> in the chain</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-get-renderer"></a><h3>champlain_map_source_get_renderer ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="returnvalue">ChamplainRenderer</span></a> * champlain_map_source_get_renderer (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>);</pre>
<p>
Get the renderer used for tiles rendering.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the renderer. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-map-source-set-renderer"></a><h3>champlain_map_source_set_renderer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> champlain_map_source_set_renderer (<em class="parameter"><code><a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a> *map_source</code></em>,
<em class="parameter"><code><a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a> *renderer</code></em>);</pre>
<p>
Sets the renderer used for tiles rendering.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map_source</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
<td>the renderer</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
</div>
<div class="refsect1">
<a name="ChamplainMapSource.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ChamplainMapSource--next-source"></a><h3>The <code class="literal">"next-source"</code> property</h3>
<pre class="programlisting"> "next-source" <a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource"><span class="type">ChamplainMapSource</span></a>* : Read / Write</pre>
<p>
Next source in the loading chain.
</p>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ChamplainMapSource--renderer"></a><h3>The <code class="literal">"renderer"</code> property</h3>
<pre class="programlisting"> "renderer" <a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a>* : Read / Write</pre>
<p>
Renderer used for tiles rendering.
</p>
<p class="since">Since 0.8</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|