Shumate.MapLayer¶

Subclasses:: None

Methods¶

Inherited:: Shumate.Layer (1), Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class

new (map_source, viewport)

Virtual Methods¶

Inherited:: Shumate.Layer (1), Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Shumate.Layer (1), Gtk.Widget (35), Gtk.Accessible (1)

Name	Type	Flags	Short Description
`map-source`	`Shumate.MapSource`	r/w/co	The Map Source

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Short Description
`map-loaded`	Emitted when all the tiles in the map view are finished loading.
`symbol-clicked`	Emitted when a symbol in the map layer is clicked.
`tile-error`	Emitted when a tile fails to load.

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Class Details¶

class Shumate.MapLayer(**kwargs)¶

Bases:: Shumate.Layer
Abstract:: No
Structure:: Shumate.MapLayerClass

A [class`Shumate`.Layer] implementation that fetches tiles from a [class`Shumate`.MapSource] and draws them as a grid.

classmethod new(map_source, viewport)¶

Parameters:

map_source (Shumate.MapSource) –
viewport (Shumate.Viewport) –

Return type:

Shumate.MapLayer

Signal Details¶

Shumate.MapLayer.signals.map_loaded(map_layer, errors)¶

Signal Name:

map-loaded

Flags:

RUN_LAST

Parameters:

map_layer (Shumate.MapLayer) – The object which received the signal
errors (bool) – TRUE if any visible tiles failed to load

Emitted when all the tiles in the map view are finished loading.

As the map is panned or zoomed, this signal may be emitted multiple times.

New in version 1.4.

Shumate.MapLayer.signals.symbol_clicked(map_layer, event)¶

Signal Name:

symbol-clicked

Flags:

RUN_LAST

Parameters:

map_layer (Shumate.MapLayer) – The object which received the signal
event (Shumate.SymbolEvent) – a [class`SymbolEvent`] with details about the clicked symbol.

Emitted when a symbol in the map layer is clicked.

New in version 1.1.

Shumate.MapLayer.signals.tile_error(map_layer, tile, error)¶

Signal Name:

tile-error

Flags:

RUN_LAST

Parameters:

map_layer (Shumate.MapLayer) – The object which received the signal
tile (Shumate.Tile) – the [class`Tile`] that failed to load
error (GLib.Error) – the error that occurred

Emitted when a tile fails to load.

New in version 1.4.

Property Details¶

Shumate.MapLayer.props.map_source¶

Name:: map-source
Type:: Shumate.MapSource
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Map Source