1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
/*
This file is part of GNUnet.
Copyright (C) 2011, 2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file src/include/gnunet_gtk.h
* @brief Helper library for Gtk user interfaces to GNUnet
* @author Christian Grothoff
*/
#ifndef GNUNET_GTK_H
#define GNUNET_GTK_H
#ifndef HAVE_USED_CONFIG_H
#define HAVE_USED_CONFIG_H
#if HAVE_CONFIG_H
#include "gnunet_gtk_config.h"
#endif
#endif
#include <gnunet/platform.h>
#include <gnunet/gnunet_util_lib.h>
#include <gnunet/gnunet_extractor_compat.h>
#include <gnunet/gnunet_fs_service.h>
#include <gtk/gtk.h>
#include <gladeui/glade.h>
#include <gdk/gdkkeysyms.h>
#ifndef GDK_KEY_Return
#define GDK_KEY_Return GDK_Return
#endif
#ifndef GDK_KEY_Delete
#define GDK_KEY_Delete GDK_Delete
#endif
/**
* Handle for our main loop.
*/
struct GNUNET_GTK_MainLoop;
/* ****************** Initialization *************** */
/**
* Initialize natural language support.
*/
void
GNUNET_GTK_setup_nls (void);
/**
* Initialize GTK search path for icons.
*/
void
GNUNET_GTK_set_icon_search_path (void);
/**
* Get the name of the directory where all of our package
* data is stored ($PREFIX/share/)
*
* @return name of the data directory
*/
const char *
GNUNET_GTK_get_data_dir (void);
/**
* @brief get the path to a specific GNUnet installation directory or,
* with #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
* directory
* @author Milan
*
* @param dirkind which directory should be returned
* @return a pointer to the dir path (to be freed by the caller)
*/
char *
GNUNET_GTK_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
/* **************** Glade/Gtk helpers *************** */
/**
* Create an initialize a new builder based on the
* GNUnet-GTK glade file.
*
* @param filename name of the resource file to load
* @param user_data user_data to pass to signal handlers,
* use "NULL" to pass the GtkBuilder itself.
* @param cb function to call before connecting signals
* @return NULL on error
*/
GtkBuilder *
GNUNET_GTK_get_new_builder2 (const char *filename,
void *user_data,
GtkBuilderConnectFunc cb);
/**
* Create an initialize a new builder based on the GNUnet-GTK glade
* file.
*
* @param filename name of the resource file to load
* @param user_data user_data to pass to signal handlers,
* use "NULL" to pass the GtkBuilder itself.
* @return NULL on error
*/
#define GNUNET_GTK_get_new_builder(filename, user_data) \
GNUNET_GTK_get_new_builder2 (filename, user_data, NULL)
/**
* This displays an about dialog. The dialog must be called
* "about_window" with "about_credits_notebook" and
* "about_license_scroller" and "about_license_contents" being the
* respective subdialogs.
*
* @param dialogfile name of the glade file containing the dialog
*/
void
GNUNET_GTK_display_about (const char *dialogfile);
/**
* Obtain a string from a GtkTreeView's model.
*
* @param treeview treeview to inspect
* @param treepath path that identifies the item
* @param column number of the column with the string
* @param value where to store the string
* @return TRUE on success, FALSE on errors
*/
gboolean
GNUNET_GTK_get_tree_string (GtkTreeView *treeview,
GtkTreePath *treepath,
guint column,
gchar **value);
/**
* Convert a string from the current locale to UTF-8.
*
* @param str_loc string in current locale
* @return string in UTF-8, NULL if str_loc was NULL
*/
char *
GNUNET_GTK_from_loc_to_utf8 (const char *str_loc);
/**
* Returns filename form filechooser, encoded in UTF-8.
*
* @param fc file chooser to inspect
* @return selected filename as UTF-8, NULL on errors
*/
char *
GNUNET_GTK_filechooser_get_filename_utf8 (GtkFileChooser *fc);
/**
* Remove the given entry and all of its children from the tree store.
*
* @param ts tree store to change
* @param root root of the subtree to remove
*/
void
GNUNET_FS_GTK_remove_treestore_subtree (GtkTreeStore *ts, GtkTreeIter *root);
/* ******************* main loop ***************** */
/**
* Initialize the main loop.
*
* @param binary_name binary name
* @param binary_help help text for the binary
* @param argc number of command line options
* @param argv command line options
* @param options allowed command line options
* @param main_window_file glade file for the main window
* @param main_task first task to run, closure will be set to the `struct
* GNUNET_GTK_MainLoop`
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error (i.e. bad command-line
* options, etc)
*/
int
GNUNET_GTK_main_loop_start (const char *binary_name,
const char *binary_help,
int argc,
char *const *argv,
struct GNUNET_GETOPT_CommandLineOption *options,
const char *main_window_file,
GNUNET_SCHEDULER_TaskCallback main_task);
/**
* Get an object from the main window.
*
* @param ml handle to the main loop
* @param name name of the object
* @return NULL on error, otherwise the object
*/
GObject *
GNUNET_GTK_main_loop_get_object (struct GNUNET_GTK_MainLoop *ml,
const char *name);
/**
* Get the builder from the main window.
*
* @param ml handle to the main loop
* @return NULL on error, otherwise the builder
*/
GtkBuilder *
GNUNET_GTK_main_loop_get_builder (struct GNUNET_GTK_MainLoop *ml);
/**
* Get remaining command line arguments.
*
* @param ml handle to the main loop
* @param argc set to argument count
* @param argv set to argument vector
*/
void
GNUNET_GTK_main_loop_get_args (struct GNUNET_GTK_MainLoop *ml,
int *argc,
char *const **argv);
/**
* FIXME!
*
* @param ml FIXME
* @param data FIXME
* @return FIXME
*/
int
GNUNET_GTK_main_loop_build_window (struct GNUNET_GTK_MainLoop *ml,
gpointer data);
/**
* Obtain the name of the configuration file that is being used.
*
* @param ml handle to the main loop
* @return name of configuration file
*/
const char *
GNUNET_GTK_main_loop_get_configuration_file (struct GNUNET_GTK_MainLoop *ml);
/**
* Get the configuration.
*
* @param ml handle to the main loop
* @return handle to the configuration, never NULL
*/
const struct GNUNET_CONFIGURATION_Handle *
GNUNET_GTK_main_loop_get_configuration (struct GNUNET_GTK_MainLoop *ml);
/**
* Trigger shutdown of the GUI and exit the main loop.
*
* @param ml handle to the main loop
*/
void
GNUNET_GTK_main_loop_quit (struct GNUNET_GTK_MainLoop *ml);
/* ******************** animations ******************* */
/**
* Handle for an animation. Each animation file should only
* be loaded once and can then be used in multiple tree views.
*/
struct GNUNET_GTK_AnimationContext;
/**
* Handle to a tree view (and column) that contains animations.
* Whenever an animation is added to a tree view, this module
* must be told about the tree view and column for the animations
* to work.
*/
struct GNUNET_GTK_AnimationTreeViewHandle;
/**
* Create an animation context. Usually animation contexts are
* created during the startup of the application and kept around
* until shutdown.
*
* @param filename name of the file with the animation to show
* @return context to use to get the animated pixbuf, NULL on error
*/
struct GNUNET_GTK_AnimationContext *
GNUNET_GTK_animation_context_create (const char *filename);
/**
* Destroy an animation context. Should only be called after the
* respective pixbufs are no longer needed.
*
* @param ac animation context to destroy.
*/
void
GNUNET_GTK_animation_context_destroy (struct GNUNET_GTK_AnimationContext *ac);
/**
* Obtain the animated pixbuf from an animation context. Note
* that the pixbuf will only properly work within GtkTreeViews
* where the column with the image has been registered using
* #GNUNET_GTK_animation_tree_view_register.
*
* @param ac animation context to query
* @return pixbuf of the AC, NULL on error loading the pixbuf
*/
GdkPixbuf *
GNUNET_GTK_animation_context_get_pixbuf (
struct GNUNET_GTK_AnimationContext *ac);
/**
* Register a tree view column with the animation subsystem. This
* column may contain animated pixbufs and thus needs to be periodically
* redrawn.
*
* @param tv tree view to register
* @param image_col column in the tree view with the animated pixbufs
* @return handle to unregister the tree view later
*/
struct GNUNET_GTK_AnimationTreeViewHandle *
GNUNET_GTK_animation_tree_view_register (GtkTreeView *tv,
GtkTreeViewColumn *image_col);
/**
* Unregister a tree view, it no longer needs to be updated.
*
* @param atv tree view to unregister
*/
void
GNUNET_GTK_animation_tree_view_unregister (
struct GNUNET_GTK_AnimationTreeViewHandle *atv);
/* ********************* generic helpers ******************* */
/**
* Columns in the anonymity level model.
*/
enum GNUNET_GTK_FS_MAIN_WINDOW_AnonymityLevelModelColumns
{
/**
* A gchararray.
*/
GNUNET_GTK_ANONYMITY_LEVEL_MC_NAME = 0,
/**
* A guint.
*/
GNUNET_GTK_ANONYMITY_LEVEL_MC_LEVEL = 1,
/**
* A gchararray.
*/
GNUNET_GTK_ANONYMITY_LEVEL_MC_COLOR = 2
};
/**
* Convert the year from the spin button to an expiration
* time (on midnight, January 1st of that year).
*
* @param spin button with the year
* @return time converted from the spin button
*/
struct GNUNET_TIME_Absolute
GNUNET_GTK_get_expiration_time (GtkSpinButton *spin);
/**
* Initialize the 'expiration_year_adjustment' of the given
* builder to have a lower range of current-year+1 and a
* default of current-year+2.
* FIXME-STYLE: odd API...
*
* @param builder builder object for which we should manipulate
* the adjustment
*/
void
GNUNET_GTK_setup_expiration_year_adjustment (GtkBuilder *builder);
/**
* Obtain the numeric anonymity level selected by a GtkComboBox.
*
* @param builder builder for looking up widgets
* @param combo_name name of the GtkComboBox with the anonymity selection
* @param p_level where to store the anonymity level
* @return TRUE on success, FALSE on failure
*/
gboolean
GNUNET_GTK_get_selected_anonymity_level (GtkBuilder *builder,
gchar *combo_name,
guint *p_level);
/**
* Obtain the numeric anonymity level selected by a GtkComboBox.
*
* @param combo the GtkComboBox with the anonymity selection
* @param p_level where to store the anonymity level
* @return TRUE on success, FALSE on failure
*/
gboolean
GNUNET_GTK_get_selected_anonymity_combo_level (GtkComboBox *combo,
guint *p_level);
#endif
/* end of gnunet_gtk.h */
|