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"
34 typedef struct _VikDataSourceInterface VikDataSourceInterface;
37 * acq_dialog_widgets_t:
39 * global data structure used to expose the progress dialog to the worker thread.
48 VikDataSourceInterface *source_interface;
50 } acq_dialog_widgets_t;
53 VIK_DATASOURCE_CREATENEWLAYER,
54 VIK_DATASOURCE_ADDTOLAYER,
55 VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT,
56 } vik_datasource_mode_t;
57 /* TODO: replace track/layer? */
60 VIK_DATASOURCE_INPUTTYPE_NONE = 0,
61 VIK_DATASOURCE_INPUTTYPE_TRWLAYER,
62 VIK_DATASOURCE_INPUTTYPE_TRACK,
63 VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK
64 } vik_datasource_inputtype_t;
67 * VikDataSourceInitFunc:
69 * Returns: pointer to state if OK, otherwise %NULL
71 typedef gpointer (*VikDataSourceInitFunc) ();
74 * VikDataSourceCheckExistenceFunc:
76 * Returns: %NULL if OK, otherwise returns an error message.
78 typedef gchar *(*VikDataSourceCheckExistenceFunc) ();
81 * VikDataSourceAddSetupWidgetsFunc:
83 * Create widgets to show in a setup dialog, set up state via user_data.
85 typedef void (*VikDataSourceAddSetupWidgetsFunc) ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data );
88 * VikDataSourceGetCmdStringFunc:
89 * @user_data: provided by #VikDataSourceInterface.init_func or dialog with params
90 * @args: the arguments computed for #VikDataSourceInterface.process_func
91 * @extra: extra arguments for #VikDataSourceInterface.process_func
92 * @options: even more options for #VikDataSourceInterface.process_func
94 * set both to %NULL to signal refusal (ie already downloading).
96 typedef void (*VikDataSourceGetCmdStringFunc) ( gpointer user_data, gchar **args, gchar **extra, gpointer options );
98 typedef void (*VikDataSourceGetCmdStringFuncWithInput) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype, const gchar *input_file_name );
99 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 );
102 * VikDataSourceProcessFunc:
104 * @cmd: the arguments computed by #VikDataSourceInterface.get_cmd_string_func
105 * @extra: the extra arguments computed by #VikDataSourceInterface.get_cmd_string_func
106 * @status_cb: the #VikDataSourceInterface.progress_func
107 * @adw: the widgets and data used by #VikDataSourceInterface.progress_func
108 * @options: more options returned by #VikDataSourceInterface.get_cmd_string_func
110 * The actual function to do stuff - must report success/failure.
112 typedef gboolean (*VikDataSourceProcessFunc) ( gpointer vtl, const gchar *cmd, const gchar *extra, BabelStatusFunc status_cb, acq_dialog_widgets_t *adw, gpointer options );
115 typedef void (*VikDataSourceProgressFunc) ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w );
118 * VikDataSourceAddProgressWidgetsFunc:
120 * Creates widgets to show in a progress dialog, may set up state via user_data.
122 typedef void (*VikDataSourceAddProgressWidgetsFunc) ( GtkWidget *dialog, gpointer user_data );
125 * VikDataSourceCleanupFunc:
127 * Frees any widgets created for the setup or progress dialogs, any allocated state, etc.
129 typedef void (*VikDataSourceCleanupFunc) ( gpointer user_data );
131 typedef void (*VikDataSourceOffFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );;
134 * VikDataSourceInterface:
138 struct _VikDataSourceInterface {
139 const gchar *window_title;
140 const gchar *layer_title;
141 vik_datasource_mode_t mode;
142 vik_datasource_inputtype_t inputtype;
144 gboolean keep_dialog_open; /* when done */
148 /*** Manual UI Building ***/
149 VikDataSourceInitFunc init_func;
150 VikDataSourceCheckExistenceFunc check_existence_func;
151 VikDataSourceAddSetupWidgetsFunc add_setup_widgets_func;
154 /* or VikDataSourceGetCmdStringFuncWithInput, if inputtype is not NONE */
155 VikDataSourceGetCmdStringFunc get_cmd_string_func;
157 VikDataSourceProcessFunc process_func;
159 VikDataSourceProgressFunc progress_func;
160 VikDataSourceAddProgressWidgetsFunc add_progress_widgets_func;
161 VikDataSourceCleanupFunc cleanup_func;
162 VikDataSourceOffFunc off_func;
164 /*** UI Building ***/
165 VikLayerParam * params;
166 guint16 params_count;
167 VikLayerParamData * params_defaults;
168 gchar ** params_groups;
169 guint8 params_groups_count;
173 /**********************************/
174 /**********************************/
175 /**********************************/
177 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface );
179 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl);
181 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl);
183 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr);
185 void a_acquire_set_filter_track ( VikTrack *tr );