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 GtkTreeStore *prefswindow_create_data_store      (void);
  76 static GtkWidget *prefswindow_tree_view_create          (PrefsWindow* prefswindow);
  77 static void prefs_filtering_create_tree_view_columns    (GtkWidget *tree_view);
  78 static gboolean prefswindow_row_selected                (GtkTreeSelection *selector,
  79                                                          GtkTreeModel *model,
  80                                                          GtkTreePath *path,
  81                                                          gboolean currently_selected,
  82                                                          gpointer data);
  83
  84 static void save_all_pages(GSList *prefs_pages)
  85 {
  86         GSList *cur;
  87
  88         for (cur = prefs_pages; cur != NULL; cur = g_slist_next(cur)) {
  89                 PrefsPage *page = (PrefsPage *) cur->data;
  90
  91                 if (page->page_open) {
  92                         page->save_page(page);
  93                 }
  94         }
  95 }
  96
  97 static void close_all_pages(GSList *prefs_pages)
  98 {
  99         GSList *cur;
 100
 101         for (cur = prefs_pages; cur != NULL; cur = g_slist_next(cur)) {
 102                 PrefsPage *page = (PrefsPage *) cur->data;
 103
 104                 if (page->page_open) {
 105                         page->destroy_widget(page);
 106                         page->page_open = FALSE;
 107                 }
 108         }
 109 }
 110
 111 static void apply_button_released(GtkButton *button, gpointer user_data)
 112 {
 113         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
 114
 115         save_all_pages(prefswindow->prefs_pages);
 116 }
 117
 118 static void close_prefs_window(PrefsWindow *prefswindow)
 119 {
 120         debug_print("prefs window closed\n");
 121
 122         close_all_pages(prefswindow->prefs_pages);
 123
 124         gtk_widget_destroy(prefswindow->window);
 125         g_slist_free(prefswindow->prefs_pages);
 126         if(prefswindow->func != NULL)
 127                 prefswindow->func(prefswindow->data);
 128         g_free(prefswindow);
 129 }
 130
 131 static void ok_button_released(GtkButton *button, gpointer user_data)
 132 {
 133         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
 134
 135         save_all_pages(prefswindow->prefs_pages);
 136         close_prefs_window(prefswindow);
 137 }
 138
 139 static void cancel_button_released(GtkButton *button, gpointer user_data)
 140 {
 141         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
 142
 143         close_prefs_window(prefswindow);
 144 }
 145
 146 static gboolean window_closed(GtkWidget *widget, GdkEvent *event, gpointer user_data)
 147 {
 148         PrefsWindow *prefswindow = (PrefsWindow *) user_data;
 149
 150         close_prefs_window(prefswindow);
 151         return FALSE;
 152 }
 153
 154 static gboolean prefswindow_key_pressed(GtkWidget *widget, GdkEventKey *event,
 155                                     PrefsWindow *data)
 156 {
 157         GtkWidget *focused_child;
 158
 159         if (event) {
 160                 switch (event->keyval) {
 161                         case GDK_Escape :
 162                                 cancel_button_released(NULL, data);
 163                                 break;
 164                         case GDK_Return :
 165                         case GDK_KP_Enter :
 166                                 focused_child = gtkut_get_focused_child
 167                                         (GTK_CONTAINER(data->notebook));
 168                                 /* Press ok, if the focused child is not a text view
 169                                  * and text (anything that accepts return) (can pass
 170                                  * NULL to any of the GTK_xxx() casts) */
 171                                 if (!GTK_IS_TEXT_VIEW(focused_child))
 172                                         ok_button_released(NULL, data);
 173                                 break;
 174                         default:
 175                                 break;
 176                 }
 177         }
 178         return FALSE;
 179 }
 180
 181 typedef struct FindNodeByName {
 182         const gchar *name;
 183         gboolean     found;
 184         GtkTreeIter  node;
 185 } FindNodeByName;
 186
 187 static gboolean find_node_by_name(GtkTreeModel *model, GtkTreePath *path,
 188                                   GtkTreeIter *iter, FindNodeByName *data)
 189 {
 190         gchar *name;
 191         gboolean result = FALSE;
 192
 193         gtk_tree_model_get(model, iter, PREFS_PAGE_TITLE, &name, -1);
 194         if (name) {
 195                 result = strcmp(name, data->name) == 0;
 196                 if (result) {
 197                         data->found = TRUE;
 198                         data->node  = *iter;
 199                 }
 200                 g_free(name);
 201         }
 202
 203         return result;
 204 }
 205
 206 static gint prefswindow_tree_sort_by_weight(GtkTreeModel *model,
 207                                             GtkTreeIter  *a,
 208                                             GtkTreeIter  *b,
 209                                             gpointer      context)
 210 {
 211         gfloat f1, f2;
 212         gint i1, i2;
 213
 214         /* From observation sorting should keep in account the original
 215          * order in the prefs_pages list. I.e. if equal weight, prefer
 216          * the index in the pages list */
 217         gtk_tree_model_get(model, a,
 218                            PREFS_PAGE_INDEX,  &i1,
 219                            PREFS_PAGE_WEIGHT, &f1, -1);
 220         gtk_tree_model_get(model, b,
 221                            PREFS_PAGE_INDEX,  &i2,
 222                            PREFS_PAGE_WEIGHT, &f2, -1);
 223
 224         return f1 < f2 ? -1 : (f1 > f2 ?  1 :
 225               (i1 < i2 ?  1 : (i1 > i2 ? -1 : 0)));
 226 }
 227
 228 static void prefswindow_build_tree(GtkWidget *tree_view, GSList *prefs_pages)
 229 {
 230         GtkTreeStore *store = GTK_TREE_STORE(gtk_tree_view_get_model
 231                         (GTK_TREE_VIEW(tree_view)));
 232         GSList *cur;
 233         gint index; /* index in pages list */
 234         GtkTreeSelection *selection;
 235         GtkTreeIter iter;
 236
 237         for (cur = prefs_pages, index = 0; cur != NULL; cur = g_slist_next(cur), index++) {
 238                 PrefsPage *page = (PrefsPage *)cur->data;
 239                 FindNodeByName find_name;
 240                 GtkTreeIter node, child;
 241                 PrefsTreeNode *prefs_node;
 242                 int i;
 243
 244                 /* each page tree component string */
 245                 for (i = 0; page->path[i] != NULL; i++) {
 246                         find_name.found = FALSE;
 247                         find_name.name  = page->path[i];
 248
 249                         /* find node to attach to
 250                          * FIXME: we search the entire tree, so this is suboptimal... */
 251                         gtk_tree_model_foreach(GTK_TREE_MODEL(store),
 252                                                (GtkTreeModelForeachFunc) find_node_by_name,
 253                                                &find_name);
 254                         if (find_name.found) {
 255                                 node = find_name.node;
 256                                 gtk_tree_model_get(GTK_TREE_MODEL(store), &node,
 257                                                    PREFS_PAGE_DATA, &prefs_node,
 258                                                    -1);
 259                         } else {
 260                                 GAuto *autoptr;
 261
 262                                 /* create a new top level */
 263                                 gtk_tree_store_append(store, &child, i == 0 ? NULL : &node);
 264                                 prefs_node = g_new0(PrefsTreeNode, 1);
 265                                 autoptr = g_auto_pointer_new(prefs_node);
 266                                 gtk_tree_store_set(store, &child,
 267                                                    PREFS_PAGE_TITLE, page->path[i],
 268                                                    PREFS_PAGE_DATA,  prefs_node,
 269                                                    PREFS_PAGE_DATA_AUTO_FREE, autoptr,
 270                                                    PREFS_PAGE_INDEX, index,
 271                                                    PREFS_PAGE_WEIGHT, 0.0f,
 272                                                    -1);
 273                                 g_auto_pointer_free(autoptr);
 274                                 node = child;
 275                         }
 276                 }
 277
 278                 /* right now we have a node and its prefs_node */
 279                 prefs_node->page = page;
 280
 281                 /* parents "inherit" the max weight of the children */
 282                 do {
 283                         gfloat f;
 284
 285                         gtk_tree_model_get(GTK_TREE_MODEL(store), &node,
 286                                            PREFS_PAGE_WEIGHT, &f,
 287                                            -1);
 288                         if (page->weight > f) {
 289                                 f = page->weight;
 290                                 gtk_tree_store_set(store, &node,
 291                                                    PREFS_PAGE_WEIGHT, f,
 292                                                    -1);
 293                         }
 294                         child = node;
 295                 } while (gtk_tree_model_iter_parent(GTK_TREE_MODEL(store),
 296                                                     &node, &child));
 297         }
 298
 299         gtk_tree_view_expand_all(GTK_TREE_VIEW(tree_view));
 300
 301         /* set sort func & sort */
 302         gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store),
 303                                         PREFS_PAGE_WEIGHT,
 304                                         prefswindow_tree_sort_by_weight,
 305                                         NULL, NULL);
 306         gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store),
 307                                              PREFS_PAGE_WEIGHT,
 308                                              GTK_SORT_DESCENDING);
 309
 310         /* select first one */
 311         selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tree_view));
 312         if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
 313                 gtk_tree_selection_select_iter(selection, &iter);
 314 }
 315
 316 void prefswindow_open_full(const gchar *title, GSList *prefs_pages, gpointer data, GtkDestroyNotify func)
 317 {
 318         gint optsize;
 319         PrefsWindow *prefswindow;
 320         GtkTreeStore *store;
 321
 322         prefswindow = g_new0(PrefsWindow, 1);
 323
 324         prefswindow->data = data;
 325         prefswindow->func = func;
 326         prefswindow->prefs_pages = g_slist_copy(prefs_pages);
 327
 328         prefswindow->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
 329         gtk_window_set_title(GTK_WINDOW(prefswindow->window), title);
 330         gtk_window_set_default_size(GTK_WINDOW(prefswindow->window), 600, 340);
 331         gtk_window_set_position (GTK_WINDOW(prefswindow->window), GTK_WIN_POS_CENTER);
 332         gtk_window_set_modal (GTK_WINDOW (prefswindow->window), TRUE);
 333         gtk_window_set_resizable (GTK_WINDOW(prefswindow->window), TRUE);
 334         gtk_container_set_border_width(GTK_CONTAINER(prefswindow->window), 4);
 335
 336         prefswindow->table1 = gtk_table_new(2, 2, FALSE);
 337         gtk_widget_show(prefswindow->table1);
 338         gtk_container_add(GTK_CONTAINER(prefswindow->window), prefswindow->table1);
 339
 340         prefswindow->scrolledwindow1 = gtk_scrolled_window_new(NULL, NULL);
 341         gtk_widget_show(prefswindow->scrolledwindow1);
 342         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(prefswindow->scrolledwindow1), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 343         gtk_table_attach(GTK_TABLE(prefswindow->table1), prefswindow->scrolledwindow1, 0, 1, 0, 1, GTK_FILL, GTK_FILL | GTK_EXPAND, 2, 2);
 344
 345         prefswindow->tree_view = prefswindow_tree_view_create(prefswindow);
 346         gtk_widget_show(prefswindow->tree_view);
 347         gtk_container_add(GTK_CONTAINER(prefswindow->scrolledwindow1),
 348                           prefswindow->tree_view);
 349
 350         prefswindow->frame = gtk_frame_new(NULL);
 351         gtk_widget_show(prefswindow->frame);
 352         gtk_frame_set_shadow_type(GTK_FRAME(prefswindow->frame), GTK_SHADOW_IN);
 353         gtk_table_attach(GTK_TABLE(prefswindow->table1), prefswindow->frame, 1, 2, 0, 1, GTK_FILL | GTK_EXPAND, GTK_FILL | GTK_EXPAND, 2, 2);
 354
 355         prefswindow->table2 = gtk_table_new(1, 2, FALSE);
 356         gtk_widget_show(prefswindow->table2);
 357         gtk_container_add(GTK_CONTAINER(prefswindow->frame), prefswindow->table2);
 358
 359         prefswindow->labelframe = gtk_frame_new(NULL);
 360         gtk_widget_show(prefswindow->labelframe);
 361         gtk_frame_set_shadow_type(GTK_FRAME(prefswindow->labelframe), GTK_SHADOW_OUT);
 362         gtk_table_attach(GTK_TABLE(prefswindow->table2), prefswindow->labelframe, 0, 1, 0, 1, GTK_FILL | GTK_EXPAND, GTK_FILL, 1, 1);
 363
 364         prefswindow->pagelabel = gtk_label_new("");
 365         gtk_widget_show(prefswindow->pagelabel);
 366         gtk_label_set_justify(GTK_LABEL(prefswindow->pagelabel), GTK_JUSTIFY_LEFT);
 367         gtk_misc_set_alignment(GTK_MISC(prefswindow->pagelabel), 0, 0.0);
 368         gtk_container_add(GTK_CONTAINER(prefswindow->labelframe), prefswindow->pagelabel);
 369
 370         prefswindow->notebook = gtk_notebook_new();
 371         gtk_widget_show(prefswindow->notebook);
 372         gtk_notebook_set_scrollable(GTK_NOTEBOOK(prefswindow->notebook), TRUE);
 373         gtk_notebook_set_show_tabs(GTK_NOTEBOOK(prefswindow->notebook), FALSE);
 374         gtk_notebook_set_show_border(GTK_NOTEBOOK(prefswindow->notebook), FALSE);
 375         gtk_table_attach(GTK_TABLE(prefswindow->table2), prefswindow->notebook, 0, 1, 1, 2, GTK_FILL | GTK_EXPAND, GTK_FILL | GTK_EXPAND, 8, 8);
 376
 377         prefswindow->empty_page = gtk_label_new("");
 378         gtk_widget_show(prefswindow->empty_page);
 379         gtk_container_add(GTK_CONTAINER(prefswindow->notebook), prefswindow->empty_page);
 380
 381         prefswindow_build_tree(prefswindow->tree_view, prefs_pages);
 382
 383         gtk_widget_grab_focus(prefswindow->tree_view);
 384
 385         gtkut_stock_button_set_create(&prefswindow->confirm_area,
 386                                       &prefswindow->ok_btn,     GTK_STOCK_OK,
 387                                       &prefswindow->cancel_btn, GTK_STOCK_CANCEL,
 388                                       &prefswindow->apply_btn,  GTK_STOCK_APPLY);
 389
 390         gtk_widget_show_all(prefswindow->confirm_area);
 391
 392         gtk_table_attach(GTK_TABLE(prefswindow->table1), prefswindow->confirm_area, 0, 2, 1, 2, GTK_FILL | GTK_EXPAND, GTK_FILL, 2, 2);
 393
 394         g_signal_connect(G_OBJECT(prefswindow->ok_btn), "released",
 395                          G_CALLBACK(ok_button_released), prefswindow);
 396         g_signal_connect(G_OBJECT(prefswindow->cancel_btn), "released",
 397                          G_CALLBACK(cancel_button_released), prefswindow);
 398         g_signal_connect(G_OBJECT(prefswindow->apply_btn), "released",
 399                          G_CALLBACK(apply_button_released), prefswindow);
 400         g_signal_connect(G_OBJECT(prefswindow->window), "delete_event",
 401                          G_CALLBACK(window_closed), prefswindow);
 402         g_signal_connect(G_OBJECT(prefswindow->window), "key_press_event",
 403                            G_CALLBACK(prefswindow_key_pressed), &(prefswindow->window));
 404
 405         gtk_widget_show(prefswindow->window);
 406 }
 407
 408 void prefswindow_open(const gchar *title, GSList *prefs_pages, gpointer data)
 409 {
 410         prefswindow_open_full(title, prefs_pages, data, NULL);
 411 }
 412
 413 static GtkTreeStore *prefswindow_create_data_store(void)
 414 {
 415         return gtk_tree_store_new(N_PREFS_PAGE_COLUMNS,
 416                                   G_TYPE_STRING,
 417                                   G_TYPE_POINTER,
 418                                   G_TYPE_AUTO_POINTER,
 419                                   G_TYPE_FLOAT,
 420                                   G_TYPE_INT,
 421                                   -1);
 422 }
 423
 424 static GtkWidget *prefswindow_tree_view_create(PrefsWindow *prefswindow)
 425 {
 426         GtkTreeView *tree_view;
 427         GtkTreeSelection *selector;
 428         GtkTreeModel *model;
 429
 430         model = GTK_TREE_MODEL(prefswindow_create_data_store());
 431         tree_view = GTK_TREE_VIEW(gtk_tree_view_new_with_model(model));
 432         g_object_unref(model);
 433         gtk_tree_view_set_rules_hint(tree_view, TRUE);
 434
 435         selector = gtk_tree_view_get_selection(tree_view);
 436         gtk_tree_selection_set_mode(selector, GTK_SELECTION_BROWSE);
 437         gtk_tree_selection_set_select_function(selector, prefswindow_row_selected,
 438                                                prefswindow, NULL);
 439
 440         /* create the columns */
 441         prefs_filtering_create_tree_view_columns(GTK_WIDGET(tree_view));
 442
 443         return GTK_WIDGET(tree_view);
 444 }
 445
 446 static void prefs_filtering_create_tree_view_columns(GtkWidget *tree_view)
 447 {
 448         GtkTreeViewColumn *column;
 449         GtkCellRenderer *renderer;
 450
 451         renderer = gtk_cell_renderer_text_new();
 452         column = gtk_tree_view_column_new_with_attributes
 453                 (_("Page Index"),
 454                  renderer,
 455                  "text", PREFS_PAGE_TITLE,
 456                  NULL);
 457         gtk_tree_view_append_column(GTK_TREE_VIEW(tree_view), column);
 458 }
 459
 460 static gboolean prefswindow_row_selected(GtkTreeSelection *selector,
 461                                          GtkTreeModel *model,
 462                                          GtkTreePath *path,
 463                                          gboolean currently_selected,
 464                                          gpointer data)
 465 {
 466         PrefsTreeNode *prefsnode;
 467         PrefsPage *page;
 468         PrefsWindow *prefswindow = (PrefsWindow *) data;
 469         gchar *labeltext;
 470         gint pagenum, i;
 471         GtkTreeIter iter;
 472
 473         if (currently_selected)
 474                 return TRUE;
 475
 476         if (!gtk_tree_model_get_iter(GTK_TREE_MODEL(model), &iter, path))
 477                 return TRUE;
 478
 479         gtk_tree_model_get(model, &iter, PREFS_PAGE_DATA, &prefsnode, -1);
 480         page = prefsnode->page;
 481
 482         debug_print("%f\n", prefsnode->treeweight);
 483
 484         if (page == NULL) {
 485                 gtk_label_set_text(GTK_LABEL(prefswindow->pagelabel), "");
 486                 pagenum = gtk_notebook_page_num(GTK_NOTEBOOK(prefswindow->notebook),
 487                                                 prefswindow->empty_page);
 488                 gtk_notebook_set_page(GTK_NOTEBOOK(prefswindow->notebook), pagenum);
 489                 return TRUE;
 490         }
 491
 492         if (!page->page_open) {
 493                 page->create_widget(page, GTK_WINDOW(prefswindow->window), prefswindow->data);
 494                 gtk_container_add(GTK_CONTAINER(prefswindow->notebook), page->widget);
 495                 page->page_open = TRUE;
 496         }
 497
 498         i = 0;
 499         while (page->path[i + 1] != 0)
 500                 i++;
 501         labeltext = page->path[i];
 502
 503         gtk_label_set_text(GTK_LABEL(prefswindow->pagelabel), labeltext);
 504
 505         pagenum = gtk_notebook_page_num(GTK_NOTEBOOK(prefswindow->notebook),
 506                                         page->widget);
 507         gtk_notebook_set_page(GTK_NOTEBOOK(prefswindow->notebook), pagenum);
 508
 509         return TRUE;
 510 }
 511