libchamplain Reference Manual: libchamplain Reference Manual

for libchamplain 0.12.22

The latest version of this documentation can be found on-line at https://gnome.pages.gitlab.gnome.org/libchamplain/champlain/.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to:

          The Free Software Foundation, Inc.,
          59 Temple Place - Suite 330,
          Boston, MA 02111-1307,
          USA

I. Core API

GtkChamplainEmbed — A Gtk+ Widget that embeds a ChamplainView
ChamplainView — A ClutterActor to display maps

II. Layers, Markers and Locations

Layers

ChamplainLayer — Base class of libchamplain layers
ChamplainMarkerLayer — A container for ChamplainMarker
ChamplainPathLayer — A layer displaying line path between inserted ChamplainLocation objects

Markers

ChamplainMarker — Base class of libchamplain markers
ChamplainLabel — A label to identify points of interest on a map
ChamplainPoint — A simple point to mark a coordinate
ChamplainCustomMarker — A marker implementing the ClutterContainer interface. Deprecated.

Locations

ChamplainLocation — An interface common to objects having latitude and longitude
ChamplainCoordinate — The simplest implementation of ChamplainLocation

III. Widgets

ChamplainLicense — An actor that displays license text.
ChamplainScale — An actor displaying a scale.

IV. Map Source API

ChamplainMapSource — A base class for map sources

Tile Sources

ChamplainTileSource — A base class of tile sources
ChamplainNetworkTileSource — A map source that downloads tile data from a web server
ChamplainNullTileSource — A tile source that doesn't load map data from anywhere
ChamplainFileTileSource — A map source that loads tile data from a file
ChamplainNetworkBboxTileSource — A map source that loads tile data from an OpenStreetMap API server

Tile Caches

ChamplainTileCache — A base class of tile caches
ChamplainFileCache — Stores and loads cached tiles from the file system
ChamplainMemoryCache — Stores and loads cached tiles from the memory

Map Source Utilities

ChamplainMapSourceChain — A map source simplifying creation of source chains
ChamplainMapSourceFactory — Manages ChamplainMapSource instances
ChamplainMapSourceDesc — A class that describes map sources.

V. Renderer API

ChamplainRenderer — A base class of renderers
ChamplainImageRenderer — A renderer that renders tiles from binary image data
ChamplainErrorTileRenderer — A renderer that renders error tiles independently of input data

VI. Others

ChamplainTile — An object that represent map tiles
champlain-bounding-box — A basic struct to describe a bounding box
ChamplainExportable — An interface for objects exportable to a cairo surface
champlain-version — Versioning utility macros

VII. Annotation Glossary

Annotation Glossary

Index of all symbols