OsmGpsMap

typedef struct _OsmGpsMap OsmGpsMap;

struct OsmGpsMapClass

struct OsmGpsMapClass {
    GtkDrawingAreaClass parent_class;

    void (*draw_gps_point) (OsmGpsMap *map, cairo_t *cr);
};

OSM_GPS_MAP_INVALID

#define OSM_GPS_MAP_INVALID         (0.0/0.0)

OSM_GPS_MAP_CACHE_DISABLED

#define OSM_GPS_MAP_CACHE_DISABLED  "none://"

OSM_GPS_MAP_CACHE_AUTO

#define OSM_GPS_MAP_CACHE_AUTO      "auto://"

OSM_GPS_MAP_CACHE_FRIENDLY

#define OSM_GPS_MAP_CACHE_FRIENDLY  "friendly://"

osm_gps_map_get_default_cache_directory ()

gchar *             osm_gps_map_get_default_cache_directory
                                                        (void);

enum OsmGpsMapSource_t

typedef enum {
    OSM_GPS_MAP_SOURCE_NULL,
    OSM_GPS_MAP_SOURCE_OPENSTREETMAP,
    OSM_GPS_MAP_SOURCE_OPENSTREETMAP_RENDERER,
    OSM_GPS_MAP_SOURCE_OPENAERIALMAP,
    OSM_GPS_MAP_SOURCE_MAPS_FOR_FREE,
    OSM_GPS_MAP_SOURCE_OPENCYCLEMAP,
    OSM_GPS_MAP_SOURCE_OSM_PUBLIC_TRANSPORT,
    OSM_GPS_MAP_SOURCE_GOOGLE_STREET,
    OSM_GPS_MAP_SOURCE_GOOGLE_SATELLITE,
    OSM_GPS_MAP_SOURCE_GOOGLE_HYBRID,
    OSM_GPS_MAP_SOURCE_VIRTUAL_EARTH_STREET,
    OSM_GPS_MAP_SOURCE_VIRTUAL_EARTH_SATELLITE,
    OSM_GPS_MAP_SOURCE_VIRTUAL_EARTH_HYBRID,
    OSM_GPS_MAP_SOURCE_YAHOO_STREET,
    OSM_GPS_MAP_SOURCE_YAHOO_SATELLITE,
    OSM_GPS_MAP_SOURCE_YAHOO_HYBRID,
    OSM_GPS_MAP_SOURCE_OSMC_TRAILS,

    OSM_GPS_MAP_SOURCE_LAST
} OsmGpsMapSource_t;

osm_gps_map_source_get_friendly_name ()

const char *        osm_gps_map_source_get_friendly_name
                                                        (OsmGpsMapSource_t source);

osm_gps_map_source_get_repo_uri ()

const char *        osm_gps_map_source_get_repo_uri     (OsmGpsMapSource_t source);

osm_gps_map_source_get_image_format ()

const char *        osm_gps_map_source_get_image_format (OsmGpsMapSource_t source);

osm_gps_map_source_get_min_zoom ()

int                 osm_gps_map_source_get_min_zoom     (OsmGpsMapSource_t source);

osm_gps_map_source_get_max_zoom ()

int                 osm_gps_map_source_get_max_zoom     (OsmGpsMapSource_t source);

osm_gps_map_source_is_valid ()

gboolean            osm_gps_map_source_is_valid         (OsmGpsMapSource_t source);

osm_gps_map_new ()

GtkWidget *         osm_gps_map_new                     (void);

Returns a new OsmGpsMap object, defaults to showing data from OpenStreetMap

See the properties description for more information about construction parameters than could be passed to g_object_new()

osm_gps_map_download_maps ()

void                osm_gps_map_download_maps           (OsmGpsMap *map,
                                                         OsmGpsMapPoint *pt1,
                                                         OsmGpsMapPoint *pt2,
                                                         int zoom_start,
                                                         int zoom_end);

Downloads all tiles over the supplied zoom range in the rectangular region specified by pt1 (north west corner) to pt2 (south east corner)

osm_gps_map_download_cancel_all ()

void                osm_gps_map_download_cancel_all     (OsmGpsMap *map);

Cancels all tiles currently being downloaded. Typically used if you wish to cacel a large number of tiles queued using osm_gps_map_download_maps()

Since 0.7.0

osm_gps_map_get_bbox ()

void                osm_gps_map_get_bbox                (OsmGpsMap *map,
                                                         OsmGpsMapPoint *pt1,
                                                         OsmGpsMapPoint *pt2);

osm_gps_map_set_center ()

void                osm_gps_map_set_center              (OsmGpsMap *map,
                                                         float latitude,
                                                         float longitude);

osm_gps_map_set_center_and_zoom ()

void                osm_gps_map_set_center_and_zoom     (OsmGpsMap *map,
                                                         float latitude,
                                                         float longitude,
                                                         int zoom);

Since 0.7.0

osm_gps_map_set_zoom ()

int                 osm_gps_map_set_zoom                (OsmGpsMap *map,
                                                         int zoom);

osm_gps_map_zoom_in ()

int                 osm_gps_map_zoom_in                 (OsmGpsMap *map);

osm_gps_map_zoom_out ()

int                 osm_gps_map_zoom_out                (OsmGpsMap *map);

osm_gps_map_scroll ()

void                osm_gps_map_scroll                  (OsmGpsMap *map,
                                                         gint dx,
                                                         gint dy);

Scrolls the map by dx, dy pixels (positive north, east)

osm_gps_map_get_scale ()

float               osm_gps_map_get_scale               (OsmGpsMap *map);

enum OsmGpsMapKey_t

typedef enum {
    OSM_GPS_MAP_KEY_FULLSCREEN,
    OSM_GPS_MAP_KEY_ZOOMIN,
    OSM_GPS_MAP_KEY_ZOOMOUT,
    OSM_GPS_MAP_KEY_UP,
    OSM_GPS_MAP_KEY_DOWN,
    OSM_GPS_MAP_KEY_LEFT,
    OSM_GPS_MAP_KEY_RIGHT,
    OSM_GPS_MAP_KEY_MAX
} OsmGpsMapKey_t;

osm_gps_map_set_keyboard_shortcut ()

void                osm_gps_map_set_keyboard_shortcut   (OsmGpsMap *map,
                                                         OsmGpsMapKey_t key,
                                                         guint keyval);

Associates a keyboard shortcut with the supplied keyval (as returned by gdk_keyval_from_name or simiar). The action given in key will be triggered when the corresponding keyval is pressed. By default no keyboard shortcuts are associated.

osm_gps_map_get_event_location ()

OsmGpsMapPoint *    osm_gps_map_get_event_location      (OsmGpsMap *map,
                                                         GdkEventButton *event);

A convenience function for getting the geographic location of events, such as mouse clicks, on the map

Since 0.7.0

osm_gps_map_convert_geographic_to_screen ()

void                osm_gps_map_convert_geographic_to_screen
                                                        (OsmGpsMap *map,
                                                         OsmGpsMapPoint *pt,
                                                         gint *pixel_x,
                                                         gint *pixel_y);

Convert the given location on the globe to the corresponding pixel locations on the map.

Since 0.7.0

osm_gps_map_convert_screen_to_geographic ()

void                osm_gps_map_convert_screen_to_geographic
                                                        (OsmGpsMap *map,
                                                         gint pixel_x,
                                                         gint pixel_y,
                                                         OsmGpsMapPoint *pt);

Convert the given pixel location on the map into corresponding location on the globe

Since 0.7.0

osm_gps_map_gps_add ()

void                osm_gps_map_gps_add                 (OsmGpsMap *map,
                                                         float latitude,
                                                         float longitude,
                                                         float heading);

Since 0.7.0

osm_gps_map_gps_clear ()

void                osm_gps_map_gps_clear               (OsmGpsMap *map);

Since 0.7.0

osm_gps_map_gps_get_track ()

OsmGpsMapTrack *    osm_gps_map_gps_get_track           (OsmGpsMap *map);

Since 0.7.0

osm_gps_map_track_add ()

void                osm_gps_map_track_add               (OsmGpsMap *map,
                                                         OsmGpsMapTrack *track);

Since 0.7.0

osm_gps_map_track_remove ()

gboolean            osm_gps_map_track_remove            (OsmGpsMap *map,
                                                         OsmGpsMapTrack *track);

Since 0.7.0

osm_gps_map_track_remove_all ()

void                osm_gps_map_track_remove_all        (OsmGpsMap *map);

Since 0.7.0

osm_gps_map_image_add ()

OsmGpsMapImage *    osm_gps_map_image_add               (OsmGpsMap *map,
                                                         float latitude,
                                                         float longitude,
                                                         GdkPixbuf *image);

Since 0.7.0

osm_gps_map_image_add_with_alignment ()

OsmGpsMapImage *    osm_gps_map_image_add_with_alignment
                                                        (OsmGpsMap *map,
                                                         float latitude,
                                                         float longitude,
                                                         GdkPixbuf *image,
                                                         float xalign,
                                                         float yalign);

Since 0.7.0

osm_gps_map_image_remove ()

gboolean            osm_gps_map_image_remove            (OsmGpsMap *map,
                                                         OsmGpsMapImage *image);

Since 0.7.0

osm_gps_map_image_remove_all ()

void                osm_gps_map_image_remove_all        (OsmGpsMap *map);

Since 0.7.0

osm_gps_map_layer_add ()

void                osm_gps_map_layer_add               (OsmGpsMap *map,
                                                         OsmGpsMapLayer *layer);

Since 0.7.0

osm_gps_map_layer_remove ()

gboolean            osm_gps_map_layer_remove            (OsmGpsMap *map,
                                                         OsmGpsMapLayer *layer);

Since 0.7.0

osm_gps_map_layer_remove_all ()

void                osm_gps_map_layer_remove_all        (OsmGpsMap *map);

Since 0.7.0

The "auto-center" property

  "auto-center"              gboolean              : Read / Write / Construct

map auto center.

Default value: TRUE

The "auto-center-threshold" property

  "auto-center-threshold"    gfloat                : Read / Write / Construct

the amount of the window the gps point must move before auto centering.

Allowed values: [0,1]

Default value: 0.25

The "auto-download" property

  "auto-download"            gboolean              : Read / Write / Construct

map auto download.

Default value: TRUE

The "drag-limit" property

  "drag-limit"               gint                  : Read / Write / Construct Only

The number of pixels the user has to move the pointer in order to start dragging.

Allowed values: >= 0

Default value: 10

The "gps-track-highlight-radius" property

  "gps-track-highlight-radius" gint                  : Read / Write / Construct

The radius of the gps point highlight circle.

Allowed values: >= 0

Default value: 20

The "gps-track-point-radius" property

  "gps-track-point-radius"   gint                  : Read / Write / Construct

The radius of the gps point inner circle.

Allowed values: >= 0

Default value: 5

The "gps-track-width" property

  "gps-track-width"          gfloat                : Read / Write / Construct

The width of the lines drawn for the gps track.

Allowed values: [1,100]

Default value: 4

The "image-format" property

  "image-format"             gchar*                : Read / Write / Construct Only

The map source tile repository image format (jpg, png).

Default value: "png"

The "latitude" property

  "latitude"                 gfloat                : Read

Latitude in degrees.

Allowed values: [-90,90]

Default value: 0

The "longitude" property

  "longitude"                gfloat                : Read

Longitude in degrees.

Allowed values: [-180,180]

Default value: 0

The "map-source" property

  "map-source"               gint                  : Read / Write / Construct

A OsmGpsMapSource_t representing the tile repository to use

Allowed values: >= G_MAXULONG

Default value: -1

The "map-x" property

  "map-x"                    gint                  : Read / Write / Construct Only

Initial map x location.

Default value: 890

The "map-y" property

  "map-y"                    gint                  : Read / Write / Construct Only

Initial map y location.

Default value: 515

The "max-zoom" property

  "max-zoom"                 gint                  : Read / Write / Construct Only

Maximum zoom level.

Allowed values: [0,20]

Default value: 18

The "min-zoom" property

  "min-zoom"                 gint                  : Read / Write / Construct Only

Minimum zoom level.

Allowed values: [0,20]

Default value: 1

The "proxy-uri" property

  "proxy-uri"                gchar*                : Read / Write / Construct Only

HTTP proxy uri or NULL.

Default value: NULL

The "record-trip-history" property

  "record-trip-history"      gboolean              : Read / Write / Construct

should all gps points be recorded in a trip history.

Default value: TRUE

The "repo-uri" property

  "repo-uri"                 gchar*                : Read / Write / Construct Only

A URI string which defines the location and format to fetch tiles for the map. The string is of the format "http://tile.openstreetmap.org/#Z/#X/#Y.png". Characters that begin with # are treated as tokens and replaced according to the following rules;

Default value: "http://tile.openstreetmap.org/#Z/#X/#Y.png"

The "show-gps-point" property

  "show-gps-point"           gboolean              : Read / Write / Construct

Controls whether the current gps point is shown on the map. Note that for derived classes that implement the draw_gps_point vfunc, if this property is FALSE

Default value: TRUE

The "show-trip-history" property

  "show-trip-history"        gboolean              : Read / Write / Construct

should the recorded trip history be shown on the map.

Default value: TRUE

The "tile-cache" property

  "tile-cache"               gchar*                : Read / Write / Construct

Either a full path or one of the special format URIs OSM_GPS_MAP_CACHE_DISABLED, OSM_GPS_MAP_CACHE_AUTO, OSM_GPS_MAP_CACHE_FRIENDLY. Also see "tile-cache-base" for a full understanding.

OSM_GPS_MAP_CACHE_DISABLED disables the on disk tile cache (so all tiles are fetched from the network. OSM_GPS_MAP_CACHE_AUTO causes the tile cache to be /tile-cache-base/md5(repo-uri), where md5 is the md5sum of "repo-uri". OSM_GPS_MAP_CACHE_FRIENDLY causes the tile cache to be /tile-cache-base/friendlyname(repo-uri).

Any other string is interpreted as a local path, i.e. /path/to/cache

Default value: "auto://"

The "tile-cache-base" property

  "tile-cache-base"          gchar*                : Read / Write / Construct Only

The base directory of the tile cache when you have constructed the map with "tile-cache" set to OSM_GPS_MAP_CACHE_AUTO or OSM_GPS_MAP_CACHE_FRIENDLY

The string is interpreted as a local path, i.e. /path/to/cache. If NULL is supplied, map tiles are cached starting in the users cache directory, (as outlined in the XDG Base Directory Specification). To get the base directory where map tiles will be cached call osm_gps_map_get_default_cache_directory()

Default value: NULL

The "tile-zoom-offset" property

  "tile-zoom-offset"         gint                  : Read / Write / Construct Only

Number of zoom-levels to upsample tiles.

Allowed values: [0,10]

Default value: 0

The "tiles-queued" property

  "tiles-queued"             gint                  : Read

The number of tiles currently waiting to download. Connect to ::notify::tiles-queued if you want to be informed when this changes

Default value: 0

The "zoom" property

  "zoom"                     gint                  : Read / Write / Construct Only

The map zoom level. Connect to ::notify::zoom if you want to be informed when this changes.

Allowed values: [0,20]

Default value: 3

The "changed" signal

void                user_function                      (OsmGpsMap *arg0,
                                                        gpointer   user_data)      : Run First

The "changed" signal is emitted any time the map zoom or map center is chaged (such as by dragging or zooming).