]> git.street.me.uk Git - andy/viking.git/blob - src/vikwaypoint.h
Improve function comments as these don't return anything
[andy/viking.git] / src / vikwaypoint.h
1 /*
2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
3  *
4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
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
22 #ifndef _VIKING_WAYPOINT_H
23 #define _VIKING_WAYPOINT_H
24
25 #include "vikcoord.h"
26
27 #include <gdk-pixbuf/gdk-pixdata.h>
28
29 G_BEGIN_DECLS
30 /* todo important: put these in their own header file, maybe.probably also rename */
31
32 #define VIK_WAYPOINT(x) ((VikWaypoint *)(x))
33
34 typedef struct _VikWaypoint VikWaypoint;
35
36 struct _VikWaypoint {
37   VikCoord coord;
38   gboolean visible;
39   gboolean has_timestamp;
40   time_t timestamp;
41   gdouble altitude;
42   gchar *name;
43   gchar *comment;
44   gchar *description;
45   gchar *source;
46   gchar *type;
47   gchar *url;
48   gchar *image;
49   /* a rather misleading, ugly hack needed for trwlayer's click image.
50    * these are the height at which the thumbnail is being drawn, not the 
51    * dimensions of the original image. */
52   guint8 image_width;
53   guint8 image_height;
54   gchar *symbol;
55   // Only for GUI display
56   GdkPixbuf *symbol_pixbuf;
57 };
58
59 VikWaypoint *vik_waypoint_new();
60 void vik_waypoint_set_name(VikWaypoint *wp, const gchar *name);
61 void vik_waypoint_set_comment(VikWaypoint *wp, const gchar *comment);
62 void vik_waypoint_set_description(VikWaypoint *wp, const gchar *description);
63 void vik_waypoint_set_source(VikWaypoint *wp, const gchar *source);
64 void vik_waypoint_set_type(VikWaypoint *wp, const gchar *type);
65 void vik_waypoint_set_url(VikWaypoint *wp, const gchar *url);
66 void vik_waypoint_set_image(VikWaypoint *wp, const gchar *image);
67 void vik_waypoint_set_symbol(VikWaypoint *wp, const gchar *symname);
68 void vik_waypoint_free(VikWaypoint * wp);
69 VikWaypoint *vik_waypoint_copy(const VikWaypoint *wp);
70 void vik_waypoint_set_comment_no_copy(VikWaypoint *wp, gchar *comment);
71 gboolean vik_waypoint_apply_dem_data ( VikWaypoint *wp, gboolean skip_existing );
72 void vik_waypoint_marshall ( VikWaypoint *wp, guint8 **data, guint *len);
73 VikWaypoint *vik_waypoint_unmarshall (guint8 *data, guint datalen);
74
75 G_END_DECLS
76
77 #endif