]>
Commit | Line | Data |
---|---|---|
1d1bc3c1 EB |
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_ACQUIRE_H | |
23 | #define _VIKING_ACQUIRE_H | |
24 | ||
a25c4c50 GB |
25 | #include <gtk/gtk.h> |
26 | ||
27 | #include "vikwindow.h" | |
28 | #include "viklayerspanel.h" | |
29 | #include "vikviewport.h" | |
0944940f | 30 | #include "babel.h" |
a25c4c50 | 31 | |
722b5481 RN |
32 | G_BEGIN_DECLS |
33 | ||
cf697cc2 EB |
34 | typedef struct _VikDataSourceInterface VikDataSourceInterface; |
35 | ||
fba47910 GB |
36 | /** |
37 | * acq_dialog_widgets_t: | |
38 | * | |
39 | * global data structure used to expose the progress dialog to the worker thread. | |
40 | */ | |
7b3479e3 EB |
41 | typedef struct { |
42 | GtkWidget *status; | |
43 | VikWindow *vw; | |
44 | VikLayersPanel *vlp; | |
45 | VikViewport *vvp; | |
46 | GtkWidget *dialog; | |
b2aa700f | 47 | gboolean running; |
62ddf770 | 48 | VikDataSourceInterface *source_interface; |
65f0ccab | 49 | gpointer user_data; |
7b3479e3 EB |
50 | } acq_dialog_widgets_t; |
51 | ||
28c82d8b EB |
52 | typedef enum { |
53 | VIK_DATASOURCE_CREATENEWLAYER, | |
3cc57413 RN |
54 | VIK_DATASOURCE_ADDTOLAYER, |
55 | VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT, | |
28c82d8b EB |
56 | } vik_datasource_mode_t; |
57 | /* TODO: replace track/layer? */ | |
58 | ||
59 | typedef enum { | |
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; | |
7b3479e3 | 65 | |
fba47910 GB |
66 | /** |
67 | * VikDataSourceInitFunc: | |
68 | * | |
69 | * Returns: pointer to state if OK, otherwise %NULL | |
70 | */ | |
65f0ccab | 71 | typedef gpointer (*VikDataSourceInitFunc) (); |
92255687 | 72 | |
fba47910 GB |
73 | /** |
74 | * VikDataSourceCheckExistenceFunc: | |
75 | * | |
76 | * Returns: %NULL if OK, otherwise returns an error message. | |
77 | */ | |
92255687 EB |
78 | typedef gchar *(*VikDataSourceCheckExistenceFunc) (); |
79 | ||
fba47910 GB |
80 | /** |
81 | * VikDataSourceAddSetupWidgetsFunc: | |
82 | * | |
83 | * Create widgets to show in a setup dialog, set up state via user_data. | |
84 | */ | |
65f0ccab AF |
85 | typedef void (*VikDataSourceAddSetupWidgetsFunc) ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data ); |
86 | ||
fba47910 GB |
87 | /** |
88 | * VikDataSourceGetCmdStringFunc: | |
eb3f9398 GB |
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 | |
ed691ed1 | 92 | * @options: even more options for #VikDataSourceInterface.process_func |
fba47910 | 93 | * |
fba47910 GB |
94 | * set both to %NULL to signal refusal (ie already downloading). |
95 | */ | |
ed691ed1 | 96 | typedef void (*VikDataSourceGetCmdStringFunc) ( gpointer user_data, gchar **args, gchar **extra, gpointer options ); |
65f0ccab | 97 | |
28c82d8b EB |
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 ); | |
100 | ||
fba47910 GB |
101 | /** |
102 | * VikDataSourceProcessFunc: | |
c12a9108 GB |
103 | * @vtl: |
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 | |
ed691ed1 RN |
107 | * @adw: the widgets and data used by #VikDataSourceInterface.progress_func |
108 | * @options: more options returned by #VikDataSourceInterface.get_cmd_string_func | |
fba47910 GB |
109 | * |
110 | * The actual function to do stuff - must report success/failure. | |
111 | */ | |
ed691ed1 | 112 | typedef gboolean (*VikDataSourceProcessFunc) ( gpointer vtl, const gchar *cmd, const gchar *extra, BabelStatusFunc status_cb, acq_dialog_widgets_t *adw, gpointer options ); |
0944940f | 113 | |
65f0ccab | 114 | /* */ |
5564dd66 | 115 | typedef void (*VikDataSourceProgressFunc) ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w ); |
65f0ccab | 116 | |
fba47910 GB |
117 | /** |
118 | * VikDataSourceAddProgressWidgetsFunc: | |
119 | * | |
120 | * Creates widgets to show in a progress dialog, may set up state via user_data. | |
121 | */ | |
65f0ccab AF |
122 | typedef void (*VikDataSourceAddProgressWidgetsFunc) ( GtkWidget *dialog, gpointer user_data ); |
123 | ||
fba47910 GB |
124 | /** |
125 | * VikDataSourceCleanupFunc: | |
126 | * | |
127 | * Frees any widgets created for the setup or progress dialogs, any allocated state, etc. | |
128 | */ | |
65f0ccab AF |
129 | typedef void (*VikDataSourceCleanupFunc) ( gpointer user_data ); |
130 | ||
2b756ea0 | 131 | typedef void (*VikDataSourceOffFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );; |
7b3479e3 | 132 | |
c12a9108 GB |
133 | /** |
134 | * VikDataSourceInterface: | |
135 | * | |
136 | * Main interface. | |
137 | */ | |
cf697cc2 | 138 | struct _VikDataSourceInterface { |
a8d46e0b | 139 | const gchar *window_title; |
7b3479e3 | 140 | const gchar *layer_title; |
28c82d8b EB |
141 | vik_datasource_mode_t mode; |
142 | vik_datasource_inputtype_t inputtype; | |
d2525524 | 143 | gboolean autoview; |
28c82d8b EB |
144 | gboolean keep_dialog_open; /* when done */ |
145 | ||
b2aa700f | 146 | gboolean is_thread; |
7b3479e3 | 147 | |
28c82d8b | 148 | /*** Manual UI Building ***/ |
65f0ccab AF |
149 | VikDataSourceInitFunc init_func; |
150 | VikDataSourceCheckExistenceFunc check_existence_func; | |
151 | VikDataSourceAddSetupWidgetsFunc add_setup_widgets_func; | |
28c82d8b EB |
152 | /*** ***/ |
153 | ||
154 | /* or VikDataSourceGetCmdStringFuncWithInput, if inputtype is not NONE */ | |
65f0ccab | 155 | VikDataSourceGetCmdStringFunc get_cmd_string_func; |
7b3479e3 | 156 | |
0944940f RN |
157 | VikDataSourceProcessFunc process_func; |
158 | ||
7b3479e3 EB |
159 | VikDataSourceProgressFunc progress_func; |
160 | VikDataSourceAddProgressWidgetsFunc add_progress_widgets_func; | |
161 | VikDataSourceCleanupFunc cleanup_func; | |
2b756ea0 | 162 | VikDataSourceOffFunc off_func; |
28c82d8b EB |
163 | |
164 | /*** UI Building ***/ | |
165 | VikLayerParam * params; | |
166 | guint16 params_count; | |
167 | VikLayerParamData * params_defaults; | |
168 | gchar ** params_groups; | |
169 | guint8 params_groups_count; | |
170 | ||
cf697cc2 | 171 | }; |
7b3479e3 | 172 | |
28c82d8b EB |
173 | /**********************************/ |
174 | /**********************************/ | |
175 | /**********************************/ | |
7b3479e3 | 176 | |
62ddf770 | 177 | void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ); |
1d1bc3c1 | 178 | |
28c82d8b EB |
179 | GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl); |
180 | ||
28c82d8b EB |
181 | GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl); |
182 | ||
28c82d8b EB |
183 | GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr); |
184 | ||
ce4bd1cf | 185 | void a_acquire_set_filter_track ( VikTrack *tr ); |
28c82d8b | 186 | |
722b5481 | 187 | G_END_DECLS |
28c82d8b | 188 | |
1d1bc3c1 | 189 | #endif |