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