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