5149036c62d3beba1a35705ea39ce77fcd2fd51b
[claws.git] / src / gtk / prefswindow.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2002 Hiroyuki Yamamoto and the Sylpheed-Claws Team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #  include "config.h"
22 #endif
23
24 #include <string.h>
25 #include <gtk/gtk.h>
26 #include <gtk/gtktext.h>
27 #include <gdk/gdkkeysyms.h>
28
29 #include "intl.h"
30 #include "utils.h"
31 #include "prefswindow.h"
32 #include "gtkutils.h"
33
34 enum { 
35         PREFS_PAGE_TITLE,               /* page title */
36         PREFS_PAGE_DATA,                /* PrefsTreeNode data */        
37         PREFS_PAGE_DATA_AUTO_FREE,      /* auto free for PREFS_PAGE_DATA */
38         PREFS_PAGE_WEIGHT,              /* weight */
39         PREFS_PAGE_INDEX,               /* index in original page list */
40         N_PREFS_PAGE_COLUMNS
41 };
42
43 typedef struct _PrefsWindow PrefsWindow;
44 typedef struct _PrefsTreeNode PrefsTreeNode;
45
46 struct _PrefsWindow
47 {
48         GtkWidget *window;
49         GtkWidget *table1;
50         GtkWidget *scrolledwindow1;
51         GtkWidget *tree_view;
52         GtkWidget *table2;
53         GtkWidget *pagelabel;
54         GtkWidget *labelframe;
55         GtkWidget *frame;
56         GtkWidget *notebook;
57         GtkWidget *confirm_area;
58         GtkWidget *ok_btn;
59         GtkWidget *cancel_btn;
60         GtkWidget *apply_btn;
61
62         GtkWidget *empty_page;
63
64         gpointer         data;
65         GSList          *prefs_pages;
66         GtkDestroyNotify func;
67 };
68
69 struct _PrefsTreeNode
70 {
71         PrefsPage *page;
72         gfloat     treeweight; /* GTK2: not used */
73 };
74
75 static GType G_TYPE_AUTO_POINTER;
76
77 typedef struct AutoPointerRef {
78         gpointer        pointer;
79         glong           cnt;
80 } AutoPointerRef;
81
82 typedef struct AutoPointer {
83         AutoPointerRef *ref;
84 } AutoPointer;
85
86 static gpointer g_auto_pointer_new                      (gpointer pointer);
87 static gpointer g_auto_pointer_copy                     (gpointer p);
88 static void g_auto_pointer_free                         (gpointer p);
89
90 static GtkTreeStore *prefswindow_create_data_store      (void);
91 static GtkWidget *prefswindow_tree_view_create          (PrefsWindow* prefswindow);
92 static void prefs_filtering_create_tree_view_columns    (GtkWidget *tree_view);
93 static gboolean prefswindow_row_selected                (GtkTreeSelection *selector,
94                                                          GtkTreeModel *model, 
95                                                          GtkTreePath *path,
96                                                          gboolean currently_selected,
97                                                          gpointer data);
98
99 static void save_all_pages(GSList *prefs_pages)
100 {
101         GSList *cur;
102
103         for (cur = prefs_pages; cur != NULL; cur = g_slist_next(cur)) {
104                 PrefsPage *page = (PrefsPage *) cur->data;
105
106                 if (page->page_open) {
107                         page->save_page(page);
108                 }
109         }
110 }
111
112 static void close_all_pages(GSList *prefs_pages)
113 {
114         GSList *cur;
115
116         for (cur = prefs_pages; cur != NULL; cur = g_slist_next(cur)) {
117                 PrefsPage *page = (PrefsPage *) cur->data;
118
119                 if (page->page_open) {
120                         page->destroy_widget(page);
121                         page->page_open = FALSE;
122                 }
123         }       
124 }
125
126 static void apply_button_released(GtkButton *button, gpointer user_data)
127 {
128         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
129
130         save_all_pages(prefswindow->prefs_pages);
131 }
132
133 static void close_prefs_window(PrefsWindow *prefswindow)
134 {
135         debug_print("prefs window closed\n");
136
137         close_all_pages(prefswindow->prefs_pages);
138
139         gtk_widget_destroy(prefswindow->window);
140         g_slist_free(prefswindow->prefs_pages);
141         if(prefswindow->func != NULL)
142                 prefswindow->func(prefswindow->data);
143         g_free(prefswindow);
144 }
145
146 static void ok_button_released(GtkButton *button, gpointer user_data)
147 {
148         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
149
150         save_all_pages(prefswindow->prefs_pages);
151         close_prefs_window(prefswindow);
152 }
153
154 static void cancel_button_released(GtkButton *button, gpointer user_data)
155 {
156         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
157
158         close_prefs_window(prefswindow);
159 }
160
161 static gboolean window_closed(GtkWidget *widget, GdkEvent *event, gpointer user_data)
162 {
163         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
164
165         close_prefs_window(prefswindow);
166         return FALSE;
167 }
168
169 static gboolean prefswindow_key_pressed(GtkWidget *widget, GdkEventKey *event,
170                                     PrefsWindow *data)
171 {
172         GtkWidget *focused_child;
173
174         if (event) {
175                 switch (event->keyval) {
176                         case GDK_Escape :
177                                 cancel_button_released(NULL, data);
178                                 break;
179                         case GDK_Return : 
180                         case GDK_KP_Enter :
181                                 focused_child = gtkut_get_focused_child
182                                         (GTK_CONTAINER(data->notebook));
183                                 /* Press ok, if the focused child is not a text view
184                                  * and text (anything that accepts return) (can pass
185                                  * NULL to any of the GTK_xxx() casts) */
186                                 if (!GTK_IS_TEXT_VIEW(focused_child))
187                                         ok_button_released(NULL, data);
188                                 break;
189                         default:
190                                 break;
191                 }
192         }
193         return FALSE;
194 }
195
196 typedef struct FindNodeByName {
197         const gchar *name;
198         gboolean     found;
199         GtkTreeIter  node;
200 } FindNodeByName;
201
202 static gboolean find_node_by_name(GtkTreeModel *model, GtkTreePath *path,
203                                   GtkTreeIter *iter, FindNodeByName *data)
204 {
205         gchar *name;
206         gboolean result = FALSE;
207
208         gtk_tree_model_get(model, iter, PREFS_PAGE_TITLE, &name, -1);
209         if (name) {
210                 result = strcmp(name, data->name) == 0;
211                 if (result) {
212                         data->found = TRUE;
213                         data->node  = *iter;
214                 }                       
215                 g_free(name);
216         }
217         
218         return result;
219 }
220
221 static gint prefswindow_tree_sort_by_weight(GtkTreeModel *model, 
222                                             GtkTreeIter  *a,
223                                             GtkTreeIter  *b,
224                                             gpointer      context)
225 {
226         gfloat f1, f2;
227         gint i1, i2;
228
229         /* From observation sorting should keep in account the original
230          * order in the prefs_pages list. I.e. if equal weight, prefer 
231          * the index in the pages list */ 
232         gtk_tree_model_get(model, a, 
233                            PREFS_PAGE_INDEX,  &i1,
234                            PREFS_PAGE_WEIGHT, &f1, -1);
235         gtk_tree_model_get(model, b, 
236                            PREFS_PAGE_INDEX,  &i2,
237                            PREFS_PAGE_WEIGHT, &f2, -1);
238
239         return f1 < f2 ? -1 : (f1 > f2 ?  1 : 
240               (i1 < i2 ?  1 : (i1 > i2 ? -1 : 0)));
241 }
242                                   
243 static void prefswindow_build_tree(GtkWidget *tree_view, GSList *prefs_pages)
244 {
245         GtkTreeStore *store = GTK_TREE_STORE(gtk_tree_view_get_model
246                         (GTK_TREE_VIEW(tree_view)));
247         GSList *cur;
248         gint index; /* index in pages list */
249         GtkTreeSelection *selection;
250         GtkTreeIter iter;
251         
252         for (cur = prefs_pages, index = 0; cur != NULL; cur = g_slist_next(cur), index++) {
253                 PrefsPage *page = (PrefsPage *)cur->data;
254                 FindNodeByName find_name;
255                 GtkTreeIter node, child;
256                 PrefsTreeNode *prefs_node;
257                 int i;
258
259                 /* each page tree component string */
260                 for (i = 0; page->path[i] != NULL; i++) {
261                         find_name.found = FALSE;
262                         find_name.name  = page->path[i];
263                         
264                         /* find node to attach to 
265                          * FIXME: we search the entire tree, so this is suboptimal... */
266                         gtk_tree_model_foreach(GTK_TREE_MODEL(store), 
267                                                (GtkTreeModelForeachFunc) find_node_by_name,
268                                                &find_name);
269                         if (find_name.found) {
270                                 node = find_name.node;
271                                 gtk_tree_model_get(GTK_TREE_MODEL(store), &node,
272                                                    PREFS_PAGE_DATA, &prefs_node,
273                                                    -1);
274                         } else {
275                                 gpointer autoptr; 
276                         
277                                 /* create a new top level */
278                                 gtk_tree_store_append(store, &child, i == 0 ? NULL : &node);
279                                 prefs_node = g_new0(PrefsTreeNode, 1);
280                                 autoptr = g_auto_pointer_new(prefs_node);
281                                 gtk_tree_store_set(store, &child,
282                                                    PREFS_PAGE_TITLE, page->path[i],
283                                                    PREFS_PAGE_DATA,  prefs_node,
284                                                    PREFS_PAGE_DATA_AUTO_FREE, autoptr,
285                                                    PREFS_PAGE_INDEX, index,
286                                                    PREFS_PAGE_WEIGHT, 0.0f,
287                                                    -1);
288                                 g_auto_pointer_free(autoptr);
289                                 node = child;
290                         }
291                 }
292
293                 /* right now we have a node and its prefs_node */
294                 prefs_node->page = page;
295
296                 /* parents "inherit" the max weight of the children */
297                 do {
298                         gfloat f;
299                         
300                         gtk_tree_model_get(GTK_TREE_MODEL(store), &node, 
301                                            PREFS_PAGE_WEIGHT, &f,
302                                            -1);
303                         if (page->weight > f) {
304                                 f = page->weight;
305                                 gtk_tree_store_set(store, &node,
306                                                    PREFS_PAGE_WEIGHT, f,
307                                                    -1);
308                         }       
309                         child = node;   
310                 } while (gtk_tree_model_iter_parent(GTK_TREE_MODEL(store),      
311                                                     &node, &child));
312         }
313
314         gtk_tree_view_expand_all(GTK_TREE_VIEW(tree_view));
315
316         /* set sort func & sort */
317         gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store),
318                                         PREFS_PAGE_WEIGHT,
319                                         prefswindow_tree_sort_by_weight,
320                                         NULL, NULL);
321         gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store),
322                                              PREFS_PAGE_WEIGHT,
323                                              GTK_SORT_DESCENDING);
324
325         /* select first one */                                       
326         selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tree_view));
327         if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
328                 gtk_tree_selection_select_iter(selection, &iter);
329 }
330
331 void prefswindow_open_full(const gchar *title, GSList *prefs_pages, gpointer data, GtkDestroyNotify func)
332 {
333         gint optsize;
334         PrefsWindow *prefswindow;
335         GtkTreeStore *store;
336
337         prefswindow = g_new0(PrefsWindow, 1);
338
339         prefswindow->data = data;
340         prefswindow->func = func;
341         prefswindow->prefs_pages = g_slist_copy(prefs_pages);
342
343         prefswindow->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
344         gtk_window_set_title(GTK_WINDOW(prefswindow->window), title);
345         gtk_window_set_default_size(GTK_WINDOW(prefswindow->window), 600, 340);
346         gtk_window_set_position (GTK_WINDOW(prefswindow->window), GTK_WIN_POS_CENTER);
347         gtk_window_set_modal (GTK_WINDOW (prefswindow->window), TRUE);
348         gtk_window_set_resizable (GTK_WINDOW(prefswindow->window), TRUE);
349         gtk_container_set_border_width(GTK_CONTAINER(prefswindow->window), 4);
350
351         prefswindow->table1 = gtk_table_new(2, 2, FALSE);
352         gtk_widget_show(prefswindow->table1);
353         gtk_container_add(GTK_CONTAINER(prefswindow->window), prefswindow->table1);
354
355         prefswindow->scrolledwindow1 = gtk_scrolled_window_new(NULL, NULL);
356         gtk_widget_show(prefswindow->scrolledwindow1);
357         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(prefswindow->scrolledwindow1), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
358         gtk_table_attach(GTK_TABLE(prefswindow->table1), prefswindow->scrolledwindow1, 0, 1, 0, 1, GTK_FILL, GTK_FILL | GTK_EXPAND, 2, 2);
359
360         prefswindow->tree_view = prefswindow_tree_view_create(prefswindow);
361         gtk_widget_show(prefswindow->tree_view);
362         gtk_container_add(GTK_CONTAINER(prefswindow->scrolledwindow1), 
363                           prefswindow->tree_view);
364
365         prefswindow->frame = gtk_frame_new(NULL);
366         gtk_widget_show(prefswindow->frame);
367         gtk_frame_set_shadow_type(GTK_FRAME(prefswindow->frame), GTK_SHADOW_IN);
368         gtk_table_attach(GTK_TABLE(prefswindow->table1), prefswindow->frame, 1, 2, 0, 1, GTK_FILL | GTK_EXPAND, GTK_FILL | GTK_EXPAND, 2, 2);
369
370         prefswindow->table2 = gtk_table_new(1, 2, FALSE);
371         gtk_widget_show(prefswindow->table2);
372         gtk_container_add(GTK_CONTAINER(prefswindow->frame), prefswindow->table2);
373
374         prefswindow->labelframe = gtk_frame_new(NULL);
375         gtk_widget_show(prefswindow->labelframe);
376         gtk_frame_set_shadow_type(GTK_FRAME(prefswindow->labelframe), GTK_SHADOW_OUT);
377         gtk_table_attach(GTK_TABLE(prefswindow->table2), prefswindow->labelframe, 0, 1, 0, 1, GTK_FILL | GTK_EXPAND, GTK_FILL, 1, 1);
378
379         prefswindow->pagelabel = gtk_label_new("");
380         gtk_widget_show(prefswindow->pagelabel);
381         gtk_label_set_justify(GTK_LABEL(prefswindow->pagelabel), GTK_JUSTIFY_LEFT);
382         gtk_misc_set_alignment(GTK_MISC(prefswindow->pagelabel), 0, 0.0);
383         gtk_container_add(GTK_CONTAINER(prefswindow->labelframe), prefswindow->pagelabel);
384
385         prefswindow->notebook = gtk_notebook_new();
386         gtk_widget_show(prefswindow->notebook);
387         gtk_notebook_set_scrollable(GTK_NOTEBOOK(prefswindow->notebook), TRUE);
388         gtk_notebook_set_show_tabs(GTK_NOTEBOOK(prefswindow->notebook), FALSE);
389         gtk_notebook_set_show_border(GTK_NOTEBOOK(prefswindow->notebook), FALSE);
390         gtk_table_attach(GTK_TABLE(prefswindow->table2), prefswindow->notebook, 0, 1, 1, 2, GTK_FILL | GTK_EXPAND, GTK_FILL | GTK_EXPAND, 8, 8);
391
392         prefswindow->empty_page = gtk_label_new("");
393         gtk_widget_show(prefswindow->empty_page);
394         gtk_container_add(GTK_CONTAINER(prefswindow->notebook), prefswindow->empty_page);
395
396         prefswindow_build_tree(prefswindow->tree_view, prefs_pages);            
397
398         gtk_widget_grab_focus(prefswindow->tree_view);
399
400         gtkut_button_set_create_stock(&prefswindow->confirm_area,
401                                       &prefswindow->ok_btn,     GTK_STOCK_OK,
402                                       &prefswindow->cancel_btn, GTK_STOCK_CANCEL,
403                                       &prefswindow->apply_btn,  GTK_STOCK_APPLY);
404
405         gtk_widget_show_all(prefswindow->confirm_area);
406
407         gtk_table_attach(GTK_TABLE(prefswindow->table1), prefswindow->confirm_area, 0, 2, 1, 2, GTK_FILL | GTK_EXPAND, GTK_FILL, 2, 2);
408
409         g_signal_connect(G_OBJECT(prefswindow->ok_btn), "released", 
410                          G_CALLBACK(ok_button_released), prefswindow);
411         g_signal_connect(G_OBJECT(prefswindow->cancel_btn), "released", 
412                          G_CALLBACK(cancel_button_released), prefswindow);
413         g_signal_connect(G_OBJECT(prefswindow->apply_btn), "released", 
414                          G_CALLBACK(apply_button_released), prefswindow);
415         g_signal_connect(G_OBJECT(prefswindow->window), "delete_event", 
416                          G_CALLBACK(window_closed), prefswindow);
417         g_signal_connect(G_OBJECT(prefswindow->window), "key_press_event",
418                            G_CALLBACK(prefswindow_key_pressed), &(prefswindow->window));
419
420         gtk_widget_show(prefswindow->window);
421 }
422
423 void prefswindow_open(const gchar *title, GSList *prefs_pages, gpointer data)
424 {
425         prefswindow_open_full(title, prefs_pages, data, NULL);
426 }
427
428 /* NOTE: auto pointer could be made more generic, but this works
429  * fine for now. */
430
431 static gpointer g_auto_pointer_new(gpointer p)
432 {       
433         AutoPointerRef *ref = g_new0(AutoPointerRef, 1);
434         AutoPointer    *ptr = g_new0(AutoPointer, 1);
435
436         ref->pointer = p;
437         ref->cnt = 1;
438
439         ptr->ref = ref;
440
441         return ptr;
442 }
443
444 static gpointer g_auto_pointer_copy(gpointer p)
445 {
446         AutoPointer     *ptr = p;
447         AutoPointerRef  *ref = ptr->ref;
448         AutoPointer     *newp = g_new0(AutoPointer, 1);
449         newp->ref = ref;
450
451         ++(ref->cnt);
452         return newp;
453 }
454
455 static void g_auto_pointer_free(gpointer p)
456 {
457         AutoPointer     *ptr = p;
458         AutoPointerRef  *ref = ptr->ref;
459
460         if (--(ref->cnt) == 0) {
461                 g_free(ref->pointer);
462                 g_free(ref);
463         }
464         g_free(ptr);            
465 }
466
467 static void prefswindow_static_init(void)
468 {
469         if (!G_TYPE_AUTO_POINTER)
470                 G_TYPE_AUTO_POINTER = 
471                         g_boxed_type_register_static("G_TYPE_AUTO_POINTER",
472                                                      g_auto_pointer_copy,
473                                                      g_auto_pointer_free);
474 }
475
476 static GtkTreeStore *prefswindow_create_data_store(void)
477 {
478         /* should always be called before using auto pointer type */
479         prefswindow_static_init();
480         
481         return gtk_tree_store_new(N_PREFS_PAGE_COLUMNS,
482                                   G_TYPE_STRING,
483                                   G_TYPE_POINTER,
484                                   G_TYPE_AUTO_POINTER,
485                                   G_TYPE_FLOAT,
486                                   G_TYPE_INT,
487                                   -1);
488 }
489
490 static GtkWidget *prefswindow_tree_view_create(PrefsWindow *prefswindow)
491 {
492         GtkTreeView *tree_view;
493         GtkTreeSelection *selector;
494         GtkTreeModel *model;
495
496         model = GTK_TREE_MODEL(prefswindow_create_data_store());
497         tree_view = GTK_TREE_VIEW(gtk_tree_view_new_with_model(model));
498         g_object_unref(model);
499         gtk_tree_view_set_rules_hint(tree_view, TRUE);
500         
501         selector = gtk_tree_view_get_selection(tree_view);
502         gtk_tree_selection_set_mode(selector, GTK_SELECTION_BROWSE);
503         gtk_tree_selection_set_select_function(selector, prefswindow_row_selected,
504                                                prefswindow, NULL);
505
506         /* create the columns */
507         prefs_filtering_create_tree_view_columns(GTK_WIDGET(tree_view));
508
509         return GTK_WIDGET(tree_view);
510 }
511
512 static void prefs_filtering_create_tree_view_columns(GtkWidget *tree_view)
513 {
514         GtkTreeViewColumn *column;
515         GtkCellRenderer *renderer;
516
517         renderer = gtk_cell_renderer_text_new();
518         column = gtk_tree_view_column_new_with_attributes
519                 (_("Page Index"),
520                  renderer,
521                  "text", PREFS_PAGE_TITLE,
522                  NULL);
523         gtk_tree_view_append_column(GTK_TREE_VIEW(tree_view), column);          
524 }
525
526 static gboolean prefswindow_row_selected(GtkTreeSelection *selector,
527                                          GtkTreeModel *model, 
528                                          GtkTreePath *path,
529                                          gboolean currently_selected,
530                                          gpointer data)
531 {
532         PrefsTreeNode *prefsnode;
533         PrefsPage *page;
534         PrefsWindow *prefswindow = (PrefsWindow *) data;
535         gchar *labeltext;
536         gint pagenum, i;
537         GtkTreeIter iter;
538
539         if (currently_selected) 
540                 return TRUE;
541
542         if (!gtk_tree_model_get_iter(GTK_TREE_MODEL(model), &iter, path))
543                 return TRUE;
544
545         gtk_tree_model_get(model, &iter, PREFS_PAGE_DATA, &prefsnode, -1);
546         page = prefsnode->page;
547
548         debug_print("%f\n", prefsnode->treeweight);
549
550         if (page == NULL) {
551                 gtk_label_set_text(GTK_LABEL(prefswindow->pagelabel), "");
552                 pagenum = gtk_notebook_page_num(GTK_NOTEBOOK(prefswindow->notebook),
553                                                 prefswindow->empty_page);
554                 gtk_notebook_set_page(GTK_NOTEBOOK(prefswindow->notebook), pagenum);
555                 return TRUE;
556         }
557
558         if (!page->page_open) {
559                 page->create_widget(page, GTK_WINDOW(prefswindow->window), prefswindow->data);
560                 gtk_container_add(GTK_CONTAINER(prefswindow->notebook), page->widget);
561                 page->page_open = TRUE;
562         }
563
564         i = 0;
565         while (page->path[i + 1] != 0)
566                 i++;
567         labeltext = page->path[i];
568
569         gtk_label_set_text(GTK_LABEL(prefswindow->pagelabel), labeltext);
570
571         pagenum = gtk_notebook_page_num(GTK_NOTEBOOK(prefswindow->notebook),
572                                         page->widget);
573         gtk_notebook_set_page(GTK_NOTEBOOK(prefswindow->notebook), pagenum);
574
575         return TRUE;
576 }
577