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