Namespace

Shumate – 0.0

GTK4 widget to display maps

Version0.0.0
Authorslibshumate contributors
LicenseLGPL-2.1-or-later
Websitehttps://gnome.pages.gitlab.gnome.org/libshumate
Sourcehttps://gitlab.gnome.org/GNOME/libshumate/

Build

C headersshumate/shumate.h
pkg-config filesshumate-0.0

Dependencies

GObject The base type system library
Browse documentation
GTK The GTK toolkit
Browse documentation

Additional documentation

Classes

Compass

A widget displaying a compass.

Coordinate

A simple object implementing ShumateLocation.

FileCache

A cache that stores and retrieves tiles from the file system. It is mainly used by ShumateNetworkTileSource, but can also be used by custom map sources.

Layer

Every layer (overlay that moves together with the map) has to inherit this class and implement its virtual methods.

License

A widget that displays license text.

Map

A GtkWidget to display maps. It supports two modes of scrolling:

MapLayer
MapSource

The base class for all map sources. Map sources fill ShumateTile objects with images from various sources: a web API, for example, or a test pattern generated on demand.

MapSourceRegistry

This object allows you to hold ShumateMapSource instances, you can access a default set of sources with shumate_map_source_registry_populate_defaults().

Marker

Markers represent points of interest on a map. Markers need to be placed on a layer (a ShumateMarkerLayer). Layers have to be added to a ShumateMap for the markers to show on the map.

MarkerLayer

Displays markers on the map. It is responsible for positioning markers correctly, marker selections and group marker operations.

MemoryCache

A cache that stores and retrieves tiles from the memory. The cache contents is not preserved between application restarts so this cache serves mostly as a quick access temporary cache to the most recently used tiles.

NetworkTileSource

Fetches raster (that is, image) tiles from a web API such as Mapbox or OpenStreetMap. It has a built-in ShumateFileCache to avoid repeated downloads.

PathLayer

A layer displaying line path between inserted ShumateLocation objects.

Point

A simple variant of ShumateMarker showing the location of the point as a circle on the map.

Scale

A widget displaying a scale.

Tile

An object that represents map tiles. Tiles are loaded by a ShumateMapSource.

Viewport

The object holding the coordinate and zoom-level state of the current view.

Interfaces

Location

An interface common to objects having latitude and longitude.

Enumerations

MapProjection

Projections supported by the library.

State

Tile loading state.

Unit

Units used by the scale.

Error Domains

FileCacheError

Error codes in the #SHUMATE_FILE_CACHE_ERROR domain.

NetworkSourceError

Error codes in the #SHUMATE_NETWORK_SOURCE_ERROR domain.

Function Macros

CHECK_VERSION

Returns TRUE if the version of the Shumate header files is the same as or newer than the passed-in version.

Constants

MAJOR_VERSION

The major version of libshumate (1, if SHUMATE_VERSION is 1.2.3)

MAP_SOURCE_MFF_RELIEF

Maps for Free Relief.

MAP_SOURCE_OSM_CYCLE_MAP

OpenStreetMap Cycle Map.

MAP_SOURCE_OSM_MAPNIK

OpenStreetMap Mapnik.

MAP_SOURCE_OSM_TRANSPORT_MAP

OpenStreetMap Transport Map.

MAP_SOURCE_OWM_CLOUDS

OpenWeatherMap clouds layer.

MAP_SOURCE_OWM_PRECIPITATION

OpenWeatherMap precipitation.

MAP_SOURCE_OWM_PRESSURE

OpenWeatherMap sea level pressure.

MAP_SOURCE_OWM_TEMPERATURE

OpenWeatherMap temperature.

MAP_SOURCE_OWM_WIND

OpenWeatherMap wind.

MAX_LATITUDE

The maximal possible latitude value.

MAX_LONGITUDE

The maximal possible longitude value.

MICRO_VERSION

The micro version of libshumate (3, if SHUMATE_VERSION is 1.2.3)

MIN_LATITUDE

The minimal possible latitude value.

MIN_LONGITUDE

The minimal possible longitude value.

MINOR_VERSION

The minor version of libshumate (2, if SHUMATE_VERSION is 1.2.3)