2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
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.
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.
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
22 #ifndef _VIKING_ACQUIRE_H
23 #define _VIKING_ACQUIRE_H
27 #include "vikwindow.h"
28 #include "viklayerspanel.h"
29 #include "vikviewport.h"
31 typedef struct _VikDataSourceInterface VikDataSourceInterface;
33 /* global data structure used to expose the progress dialog to the worker thread */
40 gboolean ok; /* if OK is false when we exit, we MUST free w */
41 VikDataSourceInterface *source_interface;
43 } acq_dialog_widgets_t;
46 VIK_DATASOURCE_GPSBABEL_DIRECT,
48 VIK_DATASOURCE_SHELL_CMD
49 } vik_datasource_type_t;
52 VIK_DATASOURCE_CREATENEWLAYER,
53 VIK_DATASOURCE_ADDTOLAYER
54 } vik_datasource_mode_t;
55 /* TODO: replace track/layer? */
58 VIK_DATASOURCE_INPUTTYPE_NONE = 0,
59 VIK_DATASOURCE_INPUTTYPE_TRWLAYER,
60 VIK_DATASOURCE_INPUTTYPE_TRACK,
61 VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK
62 } vik_datasource_inputtype_t;
64 /* returns pointer to state if OK, otherwise NULL */
65 typedef gpointer (*VikDataSourceInitFunc) ();
67 /* returns NULL if OK, otherwise returns an error message. */
68 typedef gchar *(*VikDataSourceCheckExistenceFunc) ();
70 /* Create widgets to show in a setup dialog, set up state via user_data */
71 typedef void (*VikDataSourceAddSetupWidgetsFunc) ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data );
73 /* if VIK_DATASOURCE_GPSBABEL_DIRECT, babelargs and inputfile.
74 if VIK_DATASOURCE_SHELL_CMD, shellcmd and inputtype.
75 if VIK_DATASOURCE_URL, url and inputtype.
76 set both to NULL to signal refusal (ie already downloading) */
77 typedef void (*VikDataSourceGetCmdStringFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );
79 typedef void (*VikDataSourceGetCmdStringFuncWithInput) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype, const gchar *input_file_name );
80 typedef void (*VikDataSourceGetCmdStringFuncWithInputInput) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype, const gchar *input_file_name, const gchar *input_track_file_name );
83 typedef void (*VikDataSourceProgressFunc) (gpointer c, gpointer data, acq_dialog_widgets_t *w);
85 /* Creates widgets to show in a progress dialog, may set up state via user_data */
86 typedef void (*VikDataSourceAddProgressWidgetsFunc) ( GtkWidget *dialog, gpointer user_data );
88 /* Frees any widgets created for the setup or progress dialogs, any allocated state, etc. */
89 typedef void (*VikDataSourceCleanupFunc) ( gpointer user_data );
91 typedef void (*VikDataSourceOffFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );;
93 struct _VikDataSourceInterface {
94 const gchar *window_title;
95 const gchar *layer_title;
96 vik_datasource_type_t type;
97 vik_datasource_mode_t mode;
98 vik_datasource_inputtype_t inputtype;
100 gboolean keep_dialog_open; /* when done */
103 /*** Manual UI Building ***/
104 VikDataSourceInitFunc init_func;
105 VikDataSourceCheckExistenceFunc check_existence_func;
106 VikDataSourceAddSetupWidgetsFunc add_setup_widgets_func;
109 /* or VikDataSourceGetCmdStringFuncWithInput, if inputtype is not NONE */
110 VikDataSourceGetCmdStringFunc get_cmd_string_func;
112 VikDataSourceProgressFunc progress_func;
113 VikDataSourceAddProgressWidgetsFunc add_progress_widgets_func;
114 VikDataSourceCleanupFunc cleanup_func;
115 VikDataSourceOffFunc off_func;
117 /*** UI Building ***/
118 VikLayerParam * params;
119 guint16 params_count;
120 VikLayerParamData * params_defaults;
121 gchar ** params_groups;
122 guint8 params_groups_count;
126 /**********************************/
127 /**********************************/
128 /**********************************/
130 /* for sources with no input data */
131 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface );
133 /* Create a sub menu intended for rightclicking on a TRWLayer. menu called "Filter"
134 * returns NULL if no filters */
135 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl);
137 /* Create a sub menu intended for rightclicking on a TRWLayer. menu called "Filter with Track "TRACKNAME"..."
138 * returns NULL if no filters or no filter track has been set
140 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl);
142 /* Create a sub menu intended for rightclicking on a track. menu called "Filter"
143 * returns NULL if no applicable filters */
144 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr);
146 /* sets aplication-wide track to use with filter. references the track. */
147 void a_acquire_set_filter_track ( VikTrack *tr, const gchar *name );