src/ev-sidebar.c

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2004 Red Hat, Inc.
   4  *            (C) 2007 Jan Arne Petersen
   5  *
   6  *  Authors:
   7  *    Jonathan Blandford <jrb@alum.mit.edu>
   8  *    Jan Arne Petersen <jpetersen@jpetersen.org>
   9  *
  10  * Evince is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * Evince is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02110-1301  USA.
  23  *
  24  * Thursday 03 May 2007: Bastien Nocera: Add exception clause.
  25  * See license_change file for details.
  26  *
  27  */
  28
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #include <string.h>
  34 #include <gtk/gtk.h>
  35 #include <gdk/gdkkeysyms.h>
  36
  37 #include "ev-sidebar.h"
  38
  39 enum
  40 {
  41         PAGE_COLUMN_ID,
  42         PAGE_COLUMN_TITLE,
  43         PAGE_COLUMN_NUM_COLS
  44 };
  45
  46 struct _EvSidebarPrivate {
  47         GtkWidget *combobox;
  48         GtkWidget *notebook;
  49 };
  50
  51 enum {
  52         CLOSED,
  53         LAST_SIGNAL
  54 };
  55
  56 static int ev_sidebar_table_signals[LAST_SIGNAL] = { 0 };
  57
  58 G_DEFINE_TYPE (EvSidebar, ev_sidebar, GTK_TYPE_VBOX)
  59
  60 #define EV_SIDEBAR_GET_PRIVATE(object) \
  61                 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR, EvSidebarPrivate))
  62
  63 static void
  64 ev_sidebar_class_init (EvSidebarClass *ev_sidebar_class)
  65 {
  66         GObjectClass *g_object_class;
  67         GtkWidgetClass *widget_class;
  68
  69         g_object_class = G_OBJECT_CLASS (ev_sidebar_class);
  70         widget_class = GTK_WIDGET_CLASS (ev_sidebar_class);
  71
  72         g_type_class_add_private (g_object_class, sizeof (EvSidebarPrivate));
  73
  74         ev_sidebar_table_signals[CLOSED] =
  75                 g_signal_new ("closed",
  76                                 G_TYPE_FROM_CLASS (g_object_class),
  77                                 G_SIGNAL_RUN_LAST,
  78                                 G_STRUCT_OFFSET (EvSidebarClass, closed),
  79                                 NULL, NULL,
  80                                 g_cclosure_marshal_VOID__VOID,
  81                                 G_TYPE_NONE, 0);
  82
  83 }
  84
  85 static void
  86 ev_sidebar_close_clicked_cb (GtkWidget *widget,
  87                              gpointer   user_data)
  88 {
  89         EvSidebar *ev_sidebar = EV_SIDEBAR (user_data);
  90
  91         g_signal_emit (G_OBJECT (ev_sidebar),
  92                         ev_sidebar_table_signals[CLOSED], 0, NULL);
  93         gtk_widget_hide (GTK_WIDGET (ev_sidebar));
  94 }
  95
  96 static void
  97 ev_sidebar_combobox_changed_cb (GtkComboBox *combo_box,
  98                                 gpointer   user_data)
  99 {
 100         EvSidebar *ev_sidebar = EV_SIDEBAR (user_data);
 101         GtkTreeModel *model;
 102         GtkTreeIter iter;
 103
 104         model = gtk_combo_box_get_model (combo_box);
 105
 106         if (gtk_combo_box_get_active_iter (combo_box, &iter)) {
 107                 GtkTreePath *path;
 108                 gint *indices;
 109
 110                 path = gtk_tree_model_get_path (model, &iter);
 111                 indices = gtk_tree_path_get_indices (path);
 112
 113                 if (indices != NULL) {
 114                         gtk_notebook_set_current_page (GTK_NOTEBOOK (ev_sidebar->priv->notebook), indices[0]);
 115                 }
 116
 117                 gtk_tree_path_free (path);
 118         }
 119 }
 120
 121 static void
 122 ev_sidebar_init (EvSidebar *ev_sidebar)
 123 {
 124         GtkTreeModel *page_model;
 125         GtkWidget *vbox, *hbox;
 126         GtkWidget *close_button;
 127         GtkCellRenderer *renderer;
 128         GtkWidget *image;
 129
 130         ev_sidebar->priv = EV_SIDEBAR_GET_PRIVATE (ev_sidebar);
 131
 132         /* data model */
 133         page_model = (GtkTreeModel *)
 134                         gtk_list_store_new (PAGE_COLUMN_NUM_COLS,
 135                                             G_TYPE_STRING,
 136                                             G_TYPE_STRING,
 137                                             GTK_TYPE_WIDGET,
 138                                             G_TYPE_INT);
 139
 140         /* create a 6 6 6 0 border with GtkBoxes */
 141         hbox = gtk_hbox_new (FALSE, 6);
 142         gtk_box_pack_start (GTK_BOX (ev_sidebar), hbox, TRUE, TRUE, 6);
 143
 144         vbox = gtk_vbox_new (FALSE, 6);
 145         gtk_box_pack_start (GTK_BOX (hbox), vbox, TRUE, TRUE, 0);
 146         gtk_box_pack_start (GTK_BOX (hbox), gtk_vbox_new (FALSE, 0), FALSE, FALSE, 0);
 147
 148         /* top option menu */
 149         hbox = gtk_hbox_new (FALSE, 6);
 150         gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
 151         gtk_widget_show (hbox);
 152
 153         ev_sidebar->priv->combobox = gtk_combo_box_new_with_model (page_model);
 154         g_signal_connect (ev_sidebar->priv->combobox, "changed",
 155                           G_CALLBACK (ev_sidebar_combobox_changed_cb),
 156                           ev_sidebar);
 157
 158         renderer = gtk_cell_renderer_text_new ();
 159         gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (ev_sidebar->priv->combobox), renderer, TRUE);
 160         gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (ev_sidebar->priv->combobox), renderer, "text", PAGE_COLUMN_TITLE);
 161
 162         gtk_box_pack_start (GTK_BOX (hbox), ev_sidebar->priv->combobox, TRUE, TRUE, 0);
 163         gtk_widget_show (ev_sidebar->priv->combobox);
 164
 165         g_object_unref (G_OBJECT (page_model));
 166
 167         close_button = gtk_button_new ();
 168         gtk_button_set_relief (GTK_BUTTON (close_button), GTK_RELIEF_NONE);
 169         g_signal_connect (close_button, "clicked",
 170                           G_CALLBACK (ev_sidebar_close_clicked_cb),
 171                           ev_sidebar);
 172
 173         image = gtk_image_new_from_stock (GTK_STOCK_CLOSE,
 174                                           GTK_ICON_SIZE_MENU);
 175         gtk_container_add (GTK_CONTAINER (close_button), image);
 176         gtk_widget_show (image);
 177
 178         gtk_box_pack_end (GTK_BOX (hbox), close_button, FALSE, FALSE, 0);
 179         gtk_widget_show (close_button);
 180
 181         ev_sidebar->priv->notebook = gtk_notebook_new ();
 182         gtk_notebook_set_show_border (GTK_NOTEBOOK (ev_sidebar->priv->notebook), FALSE);
 183         gtk_notebook_set_show_tabs (GTK_NOTEBOOK (ev_sidebar->priv->notebook), FALSE);
 184         gtk_box_pack_start (GTK_BOX (vbox), ev_sidebar->priv->notebook,
 185                             TRUE, TRUE, 0);
 186         gtk_widget_show (ev_sidebar->priv->notebook);
 187 }
 188
 189 /* Public functions */
 190
 191 GtkWidget *
 192 ev_sidebar_new (void)
 193 {
 194         GtkWidget *ev_sidebar;
 195
 196         ev_sidebar = g_object_new (EV_TYPE_SIDEBAR, NULL);
 197
 198         return ev_sidebar;
 199 }
 200
 201 /* NOTE: Return values from this have to be g_free()d */
 202 char *
 203 ev_sidebar_get_current_page (EvSidebar *ev_sidebar)
 204 {
 205         GtkTreeModel *model;
 206         GtkTreeIter iter;
 207         char *id;
 208
 209         g_return_val_if_fail (EV_IS_SIDEBAR (ev_sidebar), NULL);
 210         g_return_val_if_fail (ev_sidebar->priv != NULL, NULL);
 211
 212         model = gtk_combo_box_get_model (GTK_COMBO_BOX (ev_sidebar->priv->combobox));
 213
 214         if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (ev_sidebar->priv->combobox), &iter)) {
 215                 gtk_tree_model_get (model, &iter, PAGE_COLUMN_ID, &id, -1);
 216
 217                 return id;
 218         }
 219
 220         return NULL;
 221 }
 222
 223 static gboolean
 224 ev_sidebar_get_iter_for_page_id (EvSidebar *ev_sidebar,
 225                                  const char *new_page_id,
 226                                  GtkTreeIter *iter)
 227 {
 228         GtkTreeModel *model;
 229         gboolean valid;
 230         gchar *page_id;
 231
 232         g_return_val_if_fail (EV_IS_SIDEBAR (ev_sidebar), FALSE);
 233         g_return_val_if_fail (ev_sidebar->priv != NULL, FALSE);
 234         g_return_val_if_fail (iter != NULL, FALSE);
 235
 236         model = gtk_combo_box_get_model (GTK_COMBO_BOX (ev_sidebar->priv->combobox));
 237
 238         valid = gtk_tree_model_get_iter_first (model, iter);
 239
 240         while (valid) {
 241                 gtk_tree_model_get (model, iter, PAGE_COLUMN_ID, &page_id, -1);
 242
 243                 if (page_id != NULL && strcmp (new_page_id, page_id) == 0) {
 244                         g_free (page_id);
 245                         return TRUE;
 246                 }
 247                 g_free (page_id);
 248
 249                 valid = gtk_tree_model_iter_next (model, iter);
 250         }
 251
 252         return FALSE;
 253 }
 254
 255 void
 256 ev_sidebar_set_current_page (EvSidebar *ev_sidebar, const char *new_page_id)
 257 {
 258         GtkTreeIter iter;
 259
 260         g_return_if_fail (EV_IS_SIDEBAR (ev_sidebar));
 261         g_return_if_fail (new_page_id != NULL);
 262
 263
 264         if (ev_sidebar_get_iter_for_page_id (ev_sidebar, new_page_id, &iter)) {
 265                 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (ev_sidebar->priv->combobox), &iter);
 266         }
 267 }
 268
 269 void
 270 ev_sidebar_add_page (EvSidebar   *ev_sidebar,
 271                      const gchar *page_id,
 272                      const gchar *title,
 273                      GtkWidget   *main_widget)
 274 {
 275         GtkTreeIter iter, iter2;
 276         GtkTreeModel *model;
 277
 278         g_return_if_fail (EV_IS_SIDEBAR (ev_sidebar));
 279         g_return_if_fail (page_id != NULL);
 280         g_return_if_fail (title != NULL);
 281         g_return_if_fail (GTK_IS_WIDGET (main_widget));
 282
 283         model = gtk_combo_box_get_model (GTK_COMBO_BOX (ev_sidebar->priv->combobox));
 284
 285         gtk_widget_set_sensitive (GTK_WIDGET (ev_sidebar), TRUE);
 286
 287         gtk_widget_show (main_widget);
 288         gtk_notebook_append_page (GTK_NOTEBOOK (ev_sidebar->priv->notebook), main_widget, NULL);
 289
 290         gtk_list_store_append (GTK_LIST_STORE (model), &iter);
 291         gtk_list_store_set (GTK_LIST_STORE (model), &iter,
 292                             PAGE_COLUMN_ID, page_id,
 293                             PAGE_COLUMN_TITLE, title,
 294                             -1);
 295
 296         if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (ev_sidebar->priv->combobox), &iter2)) {
 297                 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (ev_sidebar->priv->combobox), &iter);
 298         }
 299 }
 300
 301 void
 302 ev_sidebar_remove_page (EvSidebar   *ev_sidebar,
 303                         const gchar *page_id)
 304 {
 305         GtkTreeIter iter;
 306         GtkTreeModel *model;
 307
 308         g_return_if_fail (EV_IS_SIDEBAR (ev_sidebar));
 309         g_return_if_fail (page_id != NULL);
 310
 311         model = gtk_combo_box_get_model (GTK_COMBO_BOX (ev_sidebar->priv->combobox));
 312
 313         if (ev_sidebar_get_iter_for_page_id (ev_sidebar, page_id, &iter)) {
 314                 GtkTreePath *path;
 315                 gint *indices;
 316
 317                 path = gtk_tree_model_get_path (model, &iter);
 318                 indices = gtk_tree_path_get_indices (path);
 319
 320                 g_assert (indices != NULL);
 321                 gtk_notebook_remove_page (GTK_NOTEBOOK (ev_sidebar->priv->notebook), indices[0]);
 322
 323                 gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
 324
 325                 if (gtk_tree_model_iter_n_children (model, NULL) != 0) {
 326                         gtk_tree_path_prev (path);
 327
 328                         if (gtk_tree_model_get_iter (model, &iter, path)) {
 329                                 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (ev_sidebar->priv->combobox), &iter);
 330                         }
 331                 } else {
 332                         gtk_widget_set_sensitive (GTK_WIDGET (ev_sidebar), FALSE);
 333                 }
 334
 335                 gtk_tree_path_free (path);
 336         }
 337 }
 338