shell/ev-sidebar.c

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2004 Red Hat, Inc.
   4  *
   5  *  Author:
   6  *    Jonathan Blandford <jrb@alum.mit.edu>
   7  *
   8  * Evince is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * Evince is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <string.h>
  28
  29 #include <gtk/gtk.h>
  30 #include <gdk/gdkkeysyms.h>
  31
  32 #include "ev-sidebar.h"
  33 #include "ev-sidebar-page.h"
  34
  35 enum
  36 {
  37         PROP_0,
  38         PROP_CURRENT_PAGE
  39 };
  40
  41 enum
  42 {
  43         PAGE_COLUMN_TITLE,
  44         PAGE_COLUMN_MENU_ITEM,
  45         PAGE_COLUMN_MAIN_WIDGET,
  46         PAGE_COLUMN_NOTEBOOK_INDEX,
  47         PAGE_COLUMN_NUM_COLS
  48 };
  49
  50 struct _EvSidebarPrivate {
  51         GtkWidget *notebook;
  52         GtkWidget *select_button;
  53         GtkWidget *menu;
  54         GtkWidget *hbox;
  55         GtkWidget *label;
  56
  57         EvDocumentModel *model;
  58         GtkTreeModel *page_model;
  59 };
  60
  61 G_DEFINE_TYPE (EvSidebar, ev_sidebar, GTK_TYPE_VBOX)
  62
  63 #define EV_SIDEBAR_GET_PRIVATE(object) \
  64                 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR, EvSidebarPrivate))
  65
  66 static void
  67 ev_sidebar_destroy (GtkObject *object)
  68 {
  69         EvSidebar *ev_sidebar = EV_SIDEBAR (object);
  70
  71         if (ev_sidebar->priv->menu) {
  72                 gtk_menu_detach (GTK_MENU (ev_sidebar->priv->menu));
  73                 ev_sidebar->priv->menu = NULL;
  74         }
  75
  76         if (ev_sidebar->priv->page_model) {
  77                 g_object_unref (ev_sidebar->priv->page_model);
  78                 ev_sidebar->priv->page_model = NULL;
  79         }
  80
  81
  82         (* GTK_OBJECT_CLASS (ev_sidebar_parent_class)->destroy) (object);
  83 }
  84
  85 static void
  86 ev_sidebar_select_page (EvSidebar *ev_sidebar,  GtkTreeIter *iter)
  87 {
  88         char *title;
  89         int index;
  90
  91         gtk_tree_model_get (ev_sidebar->priv->page_model, iter,
  92                             PAGE_COLUMN_TITLE, &title,
  93                             PAGE_COLUMN_NOTEBOOK_INDEX, &index,
  94                             -1);
  95
  96         gtk_notebook_set_current_page (GTK_NOTEBOOK (ev_sidebar->priv->notebook), index);
  97         gtk_label_set_text (GTK_LABEL (ev_sidebar->priv->label), title);
  98
  99         g_free (title);
 100 }
 101
 102 void
 103 ev_sidebar_set_page (EvSidebar   *ev_sidebar,
 104                      GtkWidget   *main_widget)
 105 {
 106         GtkTreeIter iter;
 107         gboolean valid;
 108
 109         valid = gtk_tree_model_get_iter_first (ev_sidebar->priv->page_model, &iter);
 110
 111         while (valid) {
 112                 GtkWidget *widget;
 113
 114                 gtk_tree_model_get (ev_sidebar->priv->page_model, &iter,
 115                                     PAGE_COLUMN_MAIN_WIDGET, &widget,
 116                                     -1);
 117
 118                 if (widget == main_widget) {
 119                         ev_sidebar_select_page (ev_sidebar, &iter);
 120                         valid = FALSE;
 121                 } else {
 122                         valid = gtk_tree_model_iter_next (ev_sidebar->priv->page_model, &iter);
 123                 }
 124                 g_object_unref (widget);
 125         }
 126
 127         g_object_notify (G_OBJECT (ev_sidebar), "current-page");
 128 }
 129
 130 static void
 131 ev_sidebar_set_property (GObject      *object,
 132                          guint         prop_id,
 133                          const GValue *value,
 134                          GParamSpec   *pspec)
 135 {
 136         EvSidebar *sidebar = EV_SIDEBAR (object);
 137
 138         switch (prop_id)
 139         {
 140         case PROP_CURRENT_PAGE:
 141                 ev_sidebar_set_page (sidebar, g_value_get_object (value));
 142                 break;
 143         default:
 144                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 145         }
 146 }
 147
 148 static GtkWidget *
 149 ev_sidebar_get_current_page (EvSidebar *sidebar)
 150 {
 151         GtkNotebook *notebook = GTK_NOTEBOOK (sidebar->priv->notebook);
 152
 153         return gtk_notebook_get_nth_page
 154                 (notebook, gtk_notebook_get_current_page (notebook));
 155 }
 156
 157 static void
 158 ev_sidebar_get_property (GObject *object,
 159                          guint prop_id,
 160                          GValue *value,
 161                          GParamSpec *pspec)
 162 {
 163         EvSidebar *sidebar = EV_SIDEBAR (object);
 164
 165         switch (prop_id)
 166         {
 167         case PROP_CURRENT_PAGE:
 168                 g_value_set_object (value, ev_sidebar_get_current_page (sidebar));
 169                 break;
 170         default:
 171                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 172         }
 173 }
 174
 175 static void
 176 ev_sidebar_class_init (EvSidebarClass *ev_sidebar_class)
 177 {
 178         GObjectClass *g_object_class;
 179         GtkWidgetClass *widget_class;
 180         GtkObjectClass *gtk_object_klass;
 181
 182         g_object_class = G_OBJECT_CLASS (ev_sidebar_class);
 183         widget_class = GTK_WIDGET_CLASS (ev_sidebar_class);
 184         gtk_object_klass = GTK_OBJECT_CLASS (ev_sidebar_class);
 185
 186         g_type_class_add_private (g_object_class, sizeof (EvSidebarPrivate));
 187
 188         gtk_object_klass->destroy = ev_sidebar_destroy;
 189         g_object_class->get_property = ev_sidebar_get_property;
 190         g_object_class->set_property = ev_sidebar_set_property;
 191
 192         g_object_class_install_property (g_object_class,
 193                                          PROP_CURRENT_PAGE,
 194                                          g_param_spec_object ("current-page",
 195                                                               "Current page",
 196                                                               "The currently visible page",
 197                                                               GTK_TYPE_WIDGET,
 198                                                               G_PARAM_READWRITE));
 199 }
 200
 201 static void
 202 ev_sidebar_menu_position_under (GtkMenu  *menu,
 203                                 int      *x,
 204                                 int      *y,
 205                                 gboolean *push_in,
 206                                 gpointer  user_data)
 207 {
 208         GtkWidget *widget;
 209
 210         g_return_if_fail (GTK_IS_BUTTON (user_data));
 211         g_return_if_fail (!gtk_widget_get_has_window (GTK_WIDGET (user_data)));
 212
 213         widget = GTK_WIDGET (user_data);
 214
 215         gdk_window_get_origin (widget->window, x, y);
 216
 217         *x += widget->allocation.x;
 218         *y += widget->allocation.y + widget->allocation.height;
 219
 220         *push_in = FALSE;
 221 }
 222
 223 static gboolean
 224 ev_sidebar_select_button_press_cb (GtkWidget      *widget,
 225                                    GdkEventButton *event,
 226                                    gpointer        user_data)
 227 {
 228         EvSidebar *ev_sidebar = EV_SIDEBAR (user_data);
 229
 230         if (event->button == 1) {
 231                 GtkRequisition requisition;
 232                 gint width;
 233
 234                 width = widget->allocation.width;
 235                 gtk_widget_set_size_request (ev_sidebar->priv->menu, -1, -1);
 236                 gtk_widget_size_request (ev_sidebar->priv->menu, &requisition);
 237                 gtk_widget_set_size_request (ev_sidebar->priv->menu,
 238                                              MAX (width, requisition.width), -1);
 239
 240                 gtk_widget_grab_focus (widget);
 241
 242                 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
 243                 gtk_menu_popup (GTK_MENU (ev_sidebar->priv->menu),
 244                                 NULL, NULL, ev_sidebar_menu_position_under, widget,
 245                                 event->button, event->time);
 246
 247                 return TRUE;
 248         }
 249
 250         return FALSE;
 251 }
 252
 253 static gboolean
 254 ev_sidebar_select_button_key_press_cb (GtkWidget   *widget,
 255                                        GdkEventKey *event,
 256                                        gpointer     user_data)
 257 {
 258         EvSidebar *ev_sidebar = EV_SIDEBAR (user_data);
 259
 260         if (event->keyval == GDK_space ||
 261             event->keyval == GDK_KP_Space ||
 262             event->keyval == GDK_Return ||
 263             event->keyval == GDK_KP_Enter) {
 264                 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
 265                 gtk_menu_popup (GTK_MENU (ev_sidebar->priv->menu),
 266                                 NULL, NULL, ev_sidebar_menu_position_under, widget,
 267                                 1, event->time);
 268                 return TRUE;
 269         }
 270
 271         return FALSE;
 272 }
 273
 274 static void
 275 ev_sidebar_close_clicked_cb (GtkWidget *widget,
 276                              gpointer   user_data)
 277 {
 278         EvSidebar *ev_sidebar = EV_SIDEBAR (user_data);
 279
 280         gtk_widget_hide (GTK_WIDGET (ev_sidebar));
 281 }
 282
 283 static void
 284 ev_sidebar_menu_deactivate_cb (GtkWidget *widget,
 285                                gpointer   user_data)
 286 {
 287         GtkWidget *menu_button;
 288
 289         menu_button = GTK_WIDGET (user_data);
 290
 291         gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (menu_button), FALSE);
 292 }
 293
 294 static void
 295 ev_sidebar_menu_detach_cb (GtkWidget *widget,
 296                            GtkMenu   *menu)
 297 {
 298         EvSidebar *ev_sidebar = EV_SIDEBAR (widget);
 299
 300         ev_sidebar->priv->menu = NULL;
 301 }
 302
 303 static void
 304 ev_sidebar_menu_item_activate_cb (GtkWidget *widget,
 305                                   gpointer   user_data)
 306 {
 307         EvSidebar *ev_sidebar = EV_SIDEBAR (user_data);
 308         GtkTreeIter iter;
 309         GtkWidget *menu_item, *item;
 310         gboolean valid;
 311
 312         menu_item = gtk_menu_get_active (GTK_MENU (ev_sidebar->priv->menu));
 313         valid = gtk_tree_model_get_iter_first (ev_sidebar->priv->page_model, &iter);
 314
 315         while (valid) {
 316                 gtk_tree_model_get (ev_sidebar->priv->page_model, &iter,
 317                                     PAGE_COLUMN_MENU_ITEM, &item,
 318                                     -1);
 319
 320                 if (item == menu_item) {
 321                         ev_sidebar_select_page (ev_sidebar, &iter);
 322                         valid = FALSE;
 323                 } else {
 324                         valid = gtk_tree_model_iter_next (ev_sidebar->priv->page_model, &iter);
 325                 }
 326                 g_object_unref (item);
 327         }
 328
 329         g_object_notify (G_OBJECT (ev_sidebar), "current-page");
 330 }
 331
 332 static void
 333 ev_sidebar_init (EvSidebar *ev_sidebar)
 334 {
 335         GtkWidget *hbox;
 336         GtkWidget *close_button;
 337         GtkWidget *select_hbox;
 338         GtkWidget *arrow;
 339         GtkWidget *image;
 340
 341         ev_sidebar->priv = EV_SIDEBAR_GET_PRIVATE (ev_sidebar);
 342
 343         /* data model */
 344         ev_sidebar->priv->page_model = (GtkTreeModel *)
 345                         gtk_list_store_new (PAGE_COLUMN_NUM_COLS,
 346                                             G_TYPE_STRING,
 347                                             GTK_TYPE_WIDGET,
 348                                             GTK_TYPE_WIDGET,
 349                                             G_TYPE_INT);
 350
 351         /* top option menu */
 352         hbox = gtk_hbox_new (FALSE, 0);
 353         ev_sidebar->priv->hbox = hbox;
 354         gtk_box_pack_start (GTK_BOX (ev_sidebar), hbox, FALSE, FALSE, 0);
 355         gtk_widget_show (hbox);
 356
 357         ev_sidebar->priv->select_button = gtk_toggle_button_new ();
 358         gtk_button_set_relief (GTK_BUTTON (ev_sidebar->priv->select_button), GTK_RELIEF_NONE);
 359         g_signal_connect (ev_sidebar->priv->select_button, "button_press_event",
 360                           G_CALLBACK (ev_sidebar_select_button_press_cb),
 361                           ev_sidebar);
 362         g_signal_connect (ev_sidebar->priv->select_button, "key_press_event",
 363                           G_CALLBACK (ev_sidebar_select_button_key_press_cb),
 364                           ev_sidebar);
 365
 366         select_hbox = gtk_hbox_new (FALSE, 0);
 367
 368         ev_sidebar->priv->label = gtk_label_new ("");
 369         gtk_box_pack_start (GTK_BOX (select_hbox),
 370                             ev_sidebar->priv->label,
 371                             FALSE, FALSE, 0);
 372         gtk_widget_show (ev_sidebar->priv->label);
 373
 374         arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
 375         gtk_box_pack_end (GTK_BOX (select_hbox), arrow, FALSE, FALSE, 0);
 376         gtk_widget_show (arrow);
 377
 378         gtk_container_add (GTK_CONTAINER (ev_sidebar->priv->select_button), select_hbox);
 379         gtk_widget_show (select_hbox);
 380
 381         gtk_box_pack_start (GTK_BOX (hbox), ev_sidebar->priv->select_button, TRUE, TRUE, 0);
 382         gtk_widget_show (ev_sidebar->priv->select_button);
 383
 384         close_button = gtk_button_new ();
 385         gtk_button_set_relief (GTK_BUTTON (close_button), GTK_RELIEF_NONE);
 386         g_signal_connect (close_button, "clicked",
 387                           G_CALLBACK (ev_sidebar_close_clicked_cb),
 388                           ev_sidebar);
 389
 390         image = gtk_image_new_from_stock (GTK_STOCK_CLOSE,
 391                                           GTK_ICON_SIZE_MENU);
 392         gtk_container_add (GTK_CONTAINER (close_button), image);
 393         gtk_widget_show (image);
 394
 395         gtk_box_pack_end (GTK_BOX (hbox), close_button, FALSE, FALSE, 0);
 396         gtk_widget_show (close_button);
 397
 398         ev_sidebar->priv->menu = gtk_menu_new ();
 399         g_signal_connect (ev_sidebar->priv->menu, "deactivate",
 400                           G_CALLBACK (ev_sidebar_menu_deactivate_cb),
 401                           ev_sidebar->priv->select_button);
 402         gtk_menu_attach_to_widget (GTK_MENU (ev_sidebar->priv->menu),
 403                                    GTK_WIDGET (ev_sidebar),
 404                                    ev_sidebar_menu_detach_cb);
 405         gtk_widget_show (ev_sidebar->priv->menu);
 406
 407         ev_sidebar->priv->notebook = gtk_notebook_new ();
 408         gtk_notebook_set_show_border (GTK_NOTEBOOK (ev_sidebar->priv->notebook), FALSE);
 409         gtk_notebook_set_show_tabs (GTK_NOTEBOOK (ev_sidebar->priv->notebook), FALSE);
 410         gtk_box_pack_start (GTK_BOX (ev_sidebar), ev_sidebar->priv->notebook,
 411                             TRUE, TRUE, 0);
 412         gtk_widget_show (ev_sidebar->priv->notebook);
 413
 414         gtk_widget_set_sensitive (GTK_WIDGET (ev_sidebar->priv->notebook), FALSE);
 415         gtk_widget_set_sensitive (GTK_WIDGET (ev_sidebar->priv->select_button), FALSE);
 416 }
 417
 418 /* Public functions */
 419
 420 GtkWidget *
 421 ev_sidebar_new (void)
 422 {
 423         GtkWidget *ev_sidebar;
 424
 425         ev_sidebar = g_object_new (EV_TYPE_SIDEBAR, NULL);
 426
 427         return ev_sidebar;
 428 }
 429
 430 void
 431 ev_sidebar_add_page (EvSidebar   *ev_sidebar,
 432                      GtkWidget   *main_widget)
 433 {
 434         GtkTreeIter iter;
 435         GtkWidget *menu_item;
 436         gchar *label_title;
 437         const gchar *title;
 438         int index;
 439
 440         g_return_if_fail (EV_IS_SIDEBAR (ev_sidebar));
 441         g_return_if_fail (EV_IS_SIDEBAR_PAGE (main_widget));
 442         g_return_if_fail (GTK_IS_WIDGET (main_widget));
 443
 444         ev_sidebar_page_set_model (EV_SIDEBAR_PAGE (main_widget),
 445                                    ev_sidebar->priv->model);
 446         title = ev_sidebar_page_get_label (EV_SIDEBAR_PAGE (main_widget));
 447
 448         index = gtk_notebook_append_page (GTK_NOTEBOOK (ev_sidebar->priv->notebook),
 449                                           main_widget, NULL);
 450
 451         menu_item = gtk_image_menu_item_new_with_label (title);
 452         g_signal_connect (menu_item, "activate",
 453                           G_CALLBACK (ev_sidebar_menu_item_activate_cb),
 454                           ev_sidebar);
 455         gtk_widget_show (menu_item);
 456         gtk_menu_shell_append (GTK_MENU_SHELL (ev_sidebar->priv->menu),
 457                                menu_item);
 458
 459         /* Insert and move to end */
 460         gtk_list_store_insert_with_values (GTK_LIST_STORE (ev_sidebar->priv->page_model),
 461                                            &iter, 0,
 462                                            PAGE_COLUMN_TITLE, title,
 463                                            PAGE_COLUMN_MENU_ITEM, menu_item,
 464                                            PAGE_COLUMN_MAIN_WIDGET, main_widget,
 465                                            PAGE_COLUMN_NOTEBOOK_INDEX, index,
 466                                            -1);
 467         gtk_list_store_move_before(GTK_LIST_STORE(ev_sidebar->priv->page_model),
 468                                            &iter, NULL);
 469
 470
 471         /* Set the first item added as active */
 472         gtk_tree_model_get_iter_first (ev_sidebar->priv->page_model, &iter);
 473         gtk_tree_model_get (ev_sidebar->priv->page_model,
 474                             &iter,
 475                             PAGE_COLUMN_TITLE, &label_title,
 476                             PAGE_COLUMN_NOTEBOOK_INDEX, &index,
 477                             -1);
 478
 479         gtk_menu_set_active (GTK_MENU (ev_sidebar->priv->menu), index);
 480         gtk_label_set_text (GTK_LABEL (ev_sidebar->priv->label), label_title);
 481         gtk_notebook_set_current_page (GTK_NOTEBOOK (ev_sidebar->priv->notebook),
 482                                        index);
 483         g_free (label_title);
 484 }
 485
 486 static void
 487 ev_sidebar_document_changed_cb (EvDocumentModel *model,
 488                                 GParamSpec      *pspec,
 489                                 EvSidebar       *sidebar)
 490 {
 491         EvSidebarPrivate *priv = sidebar->priv;
 492         EvDocument *document = ev_document_model_get_document (model);
 493         GtkTreeIter iter;
 494         gboolean valid;
 495         gboolean has_pages = FALSE;
 496
 497         for (valid = gtk_tree_model_get_iter_first (priv->page_model, &iter);
 498              valid;
 499              valid = gtk_tree_model_iter_next (priv->page_model, &iter)) {
 500                 GtkWidget *widget;
 501                 GtkWidget *menu_widget;
 502
 503                 gtk_tree_model_get (priv->page_model, &iter,
 504                                     PAGE_COLUMN_MAIN_WIDGET, &widget,
 505                                     PAGE_COLUMN_MENU_ITEM, &menu_widget,
 506                                     -1);
 507
 508                 if (ev_sidebar_page_support_document (EV_SIDEBAR_PAGE (widget), document)) {
 509                         has_pages = TRUE;
 510                 } else {
 511                         gtk_widget_set_sensitive (menu_widget, FALSE);
 512                 }
 513                 g_object_unref (widget);
 514                 g_object_unref (menu_widget);
 515         }
 516
 517         if (!has_pages) {
 518                 gtk_widget_hide (GTK_WIDGET (sidebar));
 519         } else {
 520                 gtk_widget_set_sensitive (GTK_WIDGET (sidebar->priv->notebook), TRUE);
 521                 gtk_widget_set_sensitive (GTK_WIDGET (sidebar->priv->select_button), TRUE);
 522         }
 523 }
 524
 525 void
 526 ev_sidebar_set_model (EvSidebar       *sidebar,
 527                       EvDocumentModel *model)
 528 {
 529         g_return_if_fail (EV_IS_SIDEBAR (sidebar));
 530         g_return_if_fail (EV_IS_DOCUMENT_MODEL (model));
 531
 532         if (model == sidebar->priv->model)
 533                 return;
 534
 535         sidebar->priv->model = model;
 536         g_signal_connect (model, "notify::document",
 537                           G_CALLBACK (ev_sidebar_document_changed_cb),
 538                           sidebar);
 539 }