]> git.street.me.uk Git - andy/viking.git/blob - src/vikgototool.h
Improve documentation of background.c
[andy/viking.git] / src / vikgototool.h
1 /*
2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
3  *
4  * Copyright (C) 2009, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21 #ifndef _VIKING_GOTO_TOOL_H
22 #define _VIKING_GOTO_TOOL_H
23
24 #include <glib.h>
25
26 #include "vikwindow.h"
27 #include "download.h"
28
29 #define VIK_GOTO_TOOL_TYPE            (vik_goto_tool_get_type ())
30 #define VIK_GOTO_TOOL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_GOTO_TOOL_TYPE, VikGotoTool))
31 #define VIK_GOTO_TOOL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_GOTO_TOOL_TYPE, VikGotoToolClass))
32 #define IS_VIK_GOTO_TOOL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_GOTO_TOOL_TYPE))
33 #define IS_VIK_GOTO_TOOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_GOTO_TOOL_TYPE))
34 #define VIK_GOTO_TOOL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), VIK_GOTO_TOOL_TYPE, VikGotoToolClass))
35
36
37 typedef struct _VikGotoTool VikGotoTool;
38 typedef struct _VikGotoToolClass VikGotoToolClass;
39
40 struct _VikGotoToolClass
41 {
42   GObjectClass object_class;
43   gchar *(* get_label) (VikGotoTool *self);
44   gchar *(* get_url_format) (VikGotoTool *self);
45   DownloadMapOptions *(* get_download_options) (VikGotoTool *self);
46   gboolean (* parse_file_for_latlon) (VikGotoTool *self, gchar *filename, struct LatLon *ll);
47 };
48
49 GType vik_goto_tool_get_type ();
50
51 struct _VikGotoTool {
52   GObject obj;
53 };
54
55 gchar *vik_goto_tool_get_label ( VikGotoTool *self );
56 gchar *vik_goto_tool_get_url_format ( VikGotoTool *self );
57 DownloadMapOptions *vik_goto_tool_get_download_options ( VikGotoTool *self );
58 gboolean vik_goto_tool_parse_file_for_latlon ( VikGotoTool *self, gchar *filename, struct LatLon *ll );
59 int vik_goto_tool_get_coord ( VikGotoTool *self, VikWindow *vw, VikViewport *vvp, gchar *srch_str, VikCoord *coord );
60
61 #endif