src/vikmapsource.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * viking
   4  * Copyright (C) 2009-2010, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
   5  *
   6  * viking is free software: you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * viking is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  14  * See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef _VIK_MAP_SOURCE_H_
  21 #define _VIK_MAP_SOURCE_H_
  22
  23 #include <glib-object.h>
  24
  25 #include "vikviewport.h"
  26 #include "vikcoord.h"
  27 #include "mapcoord.h"
  28
  29 G_BEGIN_DECLS
  30
  31 #define VIK_TYPE_MAP_SOURCE             (vik_map_source_get_type ())
  32 #define VIK_MAP_SOURCE(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_TYPE_MAP_SOURCE, VikMapSource))
  33 #define VIK_MAP_SOURCE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_TYPE_MAP_SOURCE, VikMapSourceClass))
  34 #define VIK_IS_MAP_SOURCE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_TYPE_MAP_SOURCE))
  35 #define VIK_IS_MAP_SOURCE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_TYPE_MAP_SOURCE))
  36 #define VIK_MAP_SOURCE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), VIK_TYPE_MAP_SOURCE, VikMapSourceClass))
  37
  38 typedef struct _VikMapSourceClass VikMapSourceClass;
  39 typedef struct _VikMapSource VikMapSource;
  40
  41 struct _VikMapSourceClass
  42 {
  43         GObjectClass parent_class;
  44
  45         /* Legal info */
  46         const gchar *(* get_copyright) (VikMapSource * self);
  47         const gchar *(* get_license) (VikMapSource * self);
  48         const gchar *(* get_license_url) (VikMapSource * self);
  49
  50         guint8 (* get_uniq_id) (VikMapSource * self);
  51         const gchar * (* get_label) (VikMapSource * self);
  52         guint16 (* get_tilesize_x) (VikMapSource * self);
  53         guint16 (* get_tilesize_y) (VikMapSource * self);
  54         VikViewportDrawMode (* get_drawmode) (VikMapSource * self);
  55         gboolean (* supports_download_only_new) (VikMapSource * self);
  56         gboolean (* coord_to_mapcoord) (VikMapSource * self, const VikCoord * src, gdouble xzoom, gdouble yzoom, MapCoord * dest);
  57         void (* mapcoord_to_center_coord) (VikMapSource * self, MapCoord * src, VikCoord * dest);
  58         int (* download) (VikMapSource * self, MapCoord * src, const gchar * dest_fn, void * handle);
  59         void * (* download_handle_init) (VikMapSource * self);
  60         void (* download_handle_cleanup) (VikMapSource * self, void * handle);
  61 };
  62
  63 struct _VikMapSource
  64 {
  65         GObject parent_instance;
  66 };
  67
  68 GType vik_map_source_get_type (void) G_GNUC_CONST;
  69
  70 const gchar *vik_map_source_get_copyright (VikMapSource * self);
  71 const gchar *vik_map_source_get_license (VikMapSource * self);
  72 const gchar *vik_map_source_get_license_url (VikMapSource * self);
  73
  74 guint8 vik_map_source_get_uniq_id (VikMapSource * self);
  75 const gchar *vik_map_source_get_label (VikMapSource * self);
  76 guint16 vik_map_source_get_tilesize_x (VikMapSource * self);
  77 guint16 vik_map_source_get_tilesize_y (VikMapSource * self);
  78 VikViewportDrawMode vik_map_source_get_drawmode (VikMapSource * self);
  79 gboolean vik_map_source_supports_download_only_new (VikMapSource * self);
  80 gboolean vik_map_source_coord_to_mapcoord (VikMapSource * self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest );
  81 void vik_map_source_mapcoord_to_center_coord (VikMapSource * self, MapCoord *src, VikCoord *dest);
  82 int vik_map_source_download (VikMapSource * self, MapCoord * src, const gchar * dest_fn, void * handle);
  83 void * vik_map_source_download_handle_init (VikMapSource * self);
  84 void vik_map_source_download_handle_cleanup (VikMapSource * self, void * handle);
  85
  86 G_END_DECLS
  87
  88 #endif /* _VIK_MAP_SOURCE_H_ */