ChamplainTileSource

ChamplainTileSource — A base class of tile sources

Synopsis

                    ChamplainTileSource;
void                champlain_tile_source_set_cache     (ChamplainTileSource *tile_source,
                                                         ChamplainTileCache *cache);
ChamplainTileCache * champlain_tile_source_get_cache    (ChamplainTileSource *tile_source);
void                champlain_tile_source_set_id        (ChamplainTileSource *tile_source,
                                                         const gchar *id);
void                champlain_tile_source_set_name      (ChamplainTileSource *tile_source,
                                                         const gchar *name);
void                champlain_tile_source_set_license   (ChamplainTileSource *tile_source,
                                                         const gchar *license);
void                champlain_tile_source_set_license_uri
                                                        (ChamplainTileSource *tile_source,
                                                         const gchar *license_uri);
void                champlain_tile_source_set_min_zoom_level
                                                        (ChamplainTileSource *tile_source,
                                                         guint zoom_level);
void                champlain_tile_source_set_max_zoom_level
                                                        (ChamplainTileSource *tile_source,
                                                         guint zoom_level);
void                champlain_tile_source_set_tile_size (ChamplainTileSource *tile_source,
                                                         guint tile_size);
void                champlain_tile_source_set_projection
                                                        (ChamplainTileSource *tile_source,
                                                         ChamplainMapProjection projection);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ChamplainMapSource
               +----ChamplainTileSource
                     +----ChamplainErrorTileSource
                     +----ChamplainMemphisTileSource
                     +----ChamplainNetworkTileSource

Properties

  "cache"                    ChamplainTileCache*   : Read / Write
  "id"                       gchar*                : Read / Write / Construct
  "license"                  gchar*                : Read / Write / Construct
  "license-uri"              gchar*                : Read / Write / Construct
  "max-zoom-level"           guint                 : Read / Write / Construct
  "min-zoom-level"           guint                 : Read / Write / Construct
  "name"                     gchar*                : Read / Write / Construct
  "projection"               ChamplainMapProjection  : Read / Write / Construct
  "tile-size"                guint                 : Read / Write / Construct

Description

This class defines properties common to all tile sources (that is, map sources that are not caches).

Details

ChamplainTileSource

typedef struct _ChamplainTileSource ChamplainTileSource;


champlain_tile_source_set_cache ()

void                champlain_tile_source_set_cache     (ChamplainTileSource *tile_source,
                                                         ChamplainTileCache *cache);

Sets the map source's cache used for storing tiles.

tile_source :

a ChamplainTileSource

cache :

a ChamplainTileCache

Since 0.6


champlain_tile_source_get_cache ()

ChamplainTileCache * champlain_tile_source_get_cache    (ChamplainTileSource *tile_source);

Gets the cache used for storing tiles by this tile source.

tile_source :

a ChamplainTileSource

Returns :

the cache

Since 0.6


champlain_tile_source_set_id ()

void                champlain_tile_source_set_id        (ChamplainTileSource *tile_source,
                                                         const gchar *id);

Sets the tile source's id.

tile_source :

a ChamplainTileSource

id :

an id

Since 0.4


champlain_tile_source_set_name ()

void                champlain_tile_source_set_name      (ChamplainTileSource *tile_source,
                                                         const gchar *name);

Sets the tile source's name.

tile_source :

a ChamplainTileSource

name :

a name

Since 0.4


champlain_tile_source_set_license ()

void                champlain_tile_source_set_license   (ChamplainTileSource *tile_source,
                                                         const gchar *license);

Sets the tile source's license.

tile_source :

a ChamplainTileSource

license :

the licence

Since 0.4


champlain_tile_source_set_license_uri ()

void                champlain_tile_source_set_license_uri
                                                        (ChamplainTileSource *tile_source,
                                                         const gchar *license_uri);

Sets the tile source's license URI.

tile_source :

a ChamplainTileSource

license_uri :

the licence URI

Since 0.4


champlain_tile_source_set_min_zoom_level ()

void                champlain_tile_source_set_min_zoom_level
                                                        (ChamplainTileSource *tile_source,
                                                         guint zoom_level);

Sets the tile source's minimal zoom level.

tile_source :

a ChamplainTileSource

zoom_level :

the minimal zoom level

Since 0.6


champlain_tile_source_set_max_zoom_level ()

void                champlain_tile_source_set_max_zoom_level
                                                        (ChamplainTileSource *tile_source,
                                                         guint zoom_level);

Sets the tile source's maximal zoom level.

tile_source :

a ChamplainTileSource

zoom_level :

the maximal zoom level

Since 0.6


champlain_tile_source_set_tile_size ()

void                champlain_tile_source_set_tile_size (ChamplainTileSource *tile_source,
                                                         guint tile_size);

Sets the tile source's tile size.

tile_source :

a ChamplainTileSource

tile_size :

the tile size

Since 0.6


champlain_tile_source_set_projection ()

void                champlain_tile_source_set_projection
                                                        (ChamplainTileSource *tile_source,
                                                         ChamplainMapProjection projection);

Sets the tile source's projection.

tile_source :

a ChamplainTileSource

projection :

a ChamplainMapProjection

Since 0.4

Property Details

The "cache" property

  "cache"                    ChamplainTileCache*   : Read / Write

The cache used for tile storage

Since 0.6


The "id" property

  "id"                       gchar*                : Read / Write / Construct

The name of the tile source

Default value: ""

Since 0.4


The "license" property

  "license"                  gchar*                : Read / Write / Construct

The usage license of the tile source

Default value: ""

Since 0.4


The "license-uri" property

  "license-uri"              gchar*                : Read / Write / Construct

The usage license's uri for more information

Default value: ""

Since 0.4


The "max-zoom-level" property

  "max-zoom-level"           guint                 : Read / Write / Construct

The maximum zoom level

Allowed values: <= 50

Default value: 18

Since 0.4


The "min-zoom-level" property

  "min-zoom-level"           guint                 : Read / Write / Construct

The minimum zoom level

Allowed values: <= 50

Default value: 0

Since 0.4


The "name" property

  "name"                     gchar*                : Read / Write / Construct

The name of the tile source

Default value: ""

Since 0.4


The "projection" property

  "projection"               ChamplainMapProjection  : Read / Write / Construct

The map projection of the tile source

Default value: CHAMPLAIN_MAP_PROJECTION_MERCATOR

Since 0.4


The "tile-size" property

  "tile-size"                guint                 : Read / Write / Construct

The tile size of the tile source

Allowed values: <= 2048

Default value: 256

Since 0.4