Pileus Git - ~andy/gtk/blob - gtk/gtkrecentchoosermenu.c

   1 /* GTK - The GIMP Toolkit
   2  * gtkrecentchoosermenu.c - Recently used items menu widget
   3  * Copyright (C) 2005, Emmanuele Bassi
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library 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 GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include "config.h"
  22
  23 #include <string.h>
  24
  25 #include <gdk/gdkscreen.h>
  26
  27 #include "gtkrecentmanager.h"
  28 #include "gtkrecentfilter.h"
  29 #include "gtkrecentchooser.h"
  30 #include "gtkrecentchooserutils.h"
  31 #include "gtkrecentchooserprivate.h"
  32 #include "gtkrecentchoosermenu.h"
  33
  34 #include "gtkstock.h"
  35 #include "gtkicontheme.h"
  36 #include "gtkiconfactory.h"
  37 #include "gtkintl.h"
  38 #include "gtksettings.h"
  39 #include "gtkmenushell.h"
  40 #include "gtkmenuitem.h"
  41 #include "gtkimagemenuitem.h"
  42 #include "gtkseparatormenuitem.h"
  43 #include "gtkmenu.h"
  44 #include "gtkimage.h"
  45 #include "gtkobject.h"
  46 #include "gtktooltips.h"
  47 #include "gtktypebuiltins.h"
  48
  49 #include "gtkrecentmanager.h"
  50 #include "gtkrecentfilter.h"
  51 #include "gtkrecentchooser.h"
  52 #include "gtkrecentchooserutils.h"
  53 #include "gtkrecentchooserprivate.h"
  54 #include "gtkrecentchoosermenu.h"
  55 #include "gtkalias.h"
  56
  57 struct _GtkRecentChooserMenuPrivate
  58 {
  59   /* the recent manager object */
  60   GtkRecentManager *manager;
  61
  62   /* size of the icons of the menu items */
  63   gint icon_size;
  64
  65   /* RecentChooser properties */
  66   gint limit;
  67   guint show_private : 1;
  68   guint show_not_found : 1;
  69   guint show_tips : 1;
  70   guint show_icons : 1;
  71   guint local_only : 1;
  72
  73   guint show_numbers : 1;
  74
  75   GtkRecentSortType sort_type;
  76   GtkRecentSortFunc sort_func;
  77   gpointer sort_data;
  78   GDestroyNotify sort_data_destroy;
  79
  80   GSList *filters;
  81   GtkRecentFilter *current_filter;
  82
  83   guint local_manager : 1;
  84   gulong manager_changed_id;
  85
  86   /* tooltips for our bookmark items*/
  87   GtkTooltips *tooltips;
  88 };
  89
  90 enum {
  91   PROP_0,
  92
  93   PROP_SHOW_NUMBERS
  94 };
  95
  96 #define FALLBACK_ICON_SIZE      32
  97 #define FALLBACK_ITEM_LIMIT     10
  98
  99 #define GTK_RECENT_CHOOSER_MENU_GET_PRIVATE(obj)        (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_RECENT_CHOOSER_MENU, GtkRecentChooserMenuPrivate))
 100
 101 static void     gtk_recent_chooser_menu_finalize    (GObject                   *object);
 102 static GObject *gtk_recent_chooser_menu_constructor (GType                      type,
 103                                                      guint                      n_construct_properties,
 104                                                      GObjectConstructParam     *construct_params);
 105
 106 static void gtk_recent_chooser_iface_init      (GtkRecentChooserIface     *iface);
 107
 108 static void gtk_recent_chooser_menu_set_property (GObject      *object,
 109                                                   guint         prop_id,
 110                                                   const GValue *value,
 111                                                   GParamSpec   *pspec);
 112 static void gtk_recent_chooser_menu_get_property (GObject      *object,
 113                                                   guint         prop_id,
 114                                                   GValue       *value,
 115                                                   GParamSpec   *pspec);
 116
 117 static gboolean          gtk_recent_chooser_menu_set_current_uri    (GtkRecentChooser  *chooser,
 118                                                                      const gchar       *uri,
 119                                                                      GError           **error);
 120 static gchar *           gtk_recent_chooser_menu_get_current_uri    (GtkRecentChooser  *chooser);
 121 static gboolean          gtk_recent_chooser_menu_select_uri         (GtkRecentChooser  *chooser,
 122                                                                      const gchar       *uri,
 123                                                                      GError           **error);
 124 static void              gtk_recent_chooser_menu_unselect_uri       (GtkRecentChooser  *chooser,
 125                                                                      const gchar       *uri);
 126 static void              gtk_recent_chooser_menu_select_all         (GtkRecentChooser  *chooser);
 127 static void              gtk_recent_chooser_menu_unselect_all       (GtkRecentChooser  *chooser);
 128 static GList *           gtk_recent_chooser_menu_get_items          (GtkRecentChooser  *chooser);
 129 static GtkRecentManager *gtk_recent_chooser_menu_get_recent_manager (GtkRecentChooser  *chooser);
 130 static void              gtk_recent_chooser_menu_set_sort_func      (GtkRecentChooser  *chooser,
 131                                                                      GtkRecentSortFunc  sort_func,
 132                                                                      gpointer           sort_data,
 133                                                                      GDestroyNotify     data_destroy);
 134 static void              gtk_recent_chooser_menu_add_filter         (GtkRecentChooser  *chooser,
 135                                                                      GtkRecentFilter   *filter);
 136 static void              gtk_recent_chooser_menu_remove_filter      (GtkRecentChooser  *chooser,
 137                                                                      GtkRecentFilter   *filter);
 138 static GSList *          gtk_recent_chooser_menu_list_filters       (GtkRecentChooser  *chooser);
 139 static void              gtk_recent_chooser_menu_set_current_filter (GtkRecentChooserMenu *menu,
 140                                                                      GtkRecentFilter      *filter);
 141
 142 static void              gtk_recent_chooser_menu_map (GtkWidget *widget);
 143 static void              gtk_recent_chooser_menu_set_show_tips      (GtkRecentChooserMenu *menu,
 144                                                                      gboolean              show_tips);
 145
 146 static void     set_recent_manager (GtkRecentChooserMenu *menu,
 147                                     GtkRecentManager     *manager);
 148
 149 static void     chooser_set_sort_type (GtkRecentChooserMenu *menu,
 150                                        GtkRecentSortType     sort_type);
 151
 152 static gint     get_icon_size_for_widget (GtkWidget *widget);
 153
 154 static void     item_activate_cb   (GtkWidget        *widget,
 155                                     gpointer          user_data);
 156 static void     manager_changed_cb (GtkRecentManager *manager,
 157                                     gpointer          user_data);
 158
 159 G_DEFINE_TYPE_WITH_CODE (GtkRecentChooserMenu,
 160                          gtk_recent_chooser_menu,
 161                          GTK_TYPE_MENU,
 162                          G_IMPLEMENT_INTERFACE (GTK_TYPE_RECENT_CHOOSER,
 163                                                 gtk_recent_chooser_iface_init));
 164
 165
 166 static void
 167 gtk_recent_chooser_iface_init (GtkRecentChooserIface *iface)
 168 {
 169   iface->set_current_uri = gtk_recent_chooser_menu_set_current_uri;
 170   iface->get_current_uri = gtk_recent_chooser_menu_get_current_uri;
 171   iface->select_uri = gtk_recent_chooser_menu_select_uri;
 172   iface->unselect_uri = gtk_recent_chooser_menu_unselect_uri;
 173   iface->select_all = gtk_recent_chooser_menu_select_all;
 174   iface->unselect_all = gtk_recent_chooser_menu_unselect_all;
 175   iface->get_items = gtk_recent_chooser_menu_get_items;
 176   iface->get_recent_manager = gtk_recent_chooser_menu_get_recent_manager;
 177   iface->set_sort_func = gtk_recent_chooser_menu_set_sort_func;
 178   iface->add_filter = gtk_recent_chooser_menu_add_filter;
 179   iface->remove_filter = gtk_recent_chooser_menu_remove_filter;
 180   iface->list_filters = gtk_recent_chooser_menu_list_filters;
 181 }
 182
 183 static void
 184 gtk_recent_chooser_menu_class_init (GtkRecentChooserMenuClass *klass)
 185 {
 186   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 187   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 188
 189   gobject_class->constructor = gtk_recent_chooser_menu_constructor;
 190   gobject_class->finalize = gtk_recent_chooser_menu_finalize;
 191   gobject_class->set_property = gtk_recent_chooser_menu_set_property;
 192   gobject_class->get_property = gtk_recent_chooser_menu_get_property;
 193
 194   widget_class->map = gtk_recent_chooser_menu_map;
 195
 196   _gtk_recent_chooser_install_properties (gobject_class);
 197
 198   /**
 199    * GtkRecentChooserMenu:show-numbers
 200    *
 201    * Whether the first ten items in the menu should be prepended by
 202    * a number acting as a unique mnemonic.
 203    *
 204    * Since: 2.10
 205    */
 206   g_object_class_install_property (gobject_class,
 207                                    PROP_SHOW_NUMBERS,
 208                                    g_param_spec_boolean ("show-numbers",
 209                                                          P_("Show Numbers"),
 210                                                          P_("Whether the items should be displayed with a number"),
 211                                                          FALSE,
 212                                                          G_PARAM_READWRITE));
 213
 214   g_type_class_add_private (klass, sizeof (GtkRecentChooserMenuPrivate));
 215 }
 216
 217 static void
 218 gtk_recent_chooser_menu_init (GtkRecentChooserMenu *menu)
 219 {
 220   GtkRecentChooserMenuPrivate *priv;
 221
 222   priv = GTK_RECENT_CHOOSER_MENU_GET_PRIVATE (menu);
 223
 224   menu->priv = priv;
 225
 226   priv->show_icons= TRUE;
 227   priv->show_numbers = FALSE;
 228   priv->show_tips = FALSE;
 229   priv->show_not_found = FALSE;
 230   priv->show_private = FALSE;
 231   priv->local_only = TRUE;
 232
 233   priv->limit = FALLBACK_ITEM_LIMIT;
 234
 235   priv->sort_type = GTK_RECENT_SORT_NONE;
 236
 237   priv->icon_size = FALLBACK_ICON_SIZE;
 238
 239   priv->current_filter = NULL;
 240
 241   priv->tooltips = gtk_tooltips_new ();
 242   g_object_ref_sink (priv->tooltips);
 243 }
 244
 245 static void
 246 gtk_recent_chooser_menu_finalize (GObject *object)
 247 {
 248   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (object);
 249   GtkRecentChooserMenuPrivate *priv = menu->priv;
 250
 251   g_signal_handler_disconnect (priv->manager, priv->manager_changed_id);
 252   priv->manager_changed_id = 0;
 253
 254   priv->manager = NULL;
 255
 256   if (priv->sort_data_destroy)
 257     {
 258       priv->sort_data_destroy (priv->sort_data);
 259
 260       priv->sort_data_destroy = NULL;
 261       priv->sort_data = NULL;
 262       priv->sort_func = NULL;
 263     }
 264
 265   if (priv->tooltips)
 266     g_object_unref (priv->tooltips);
 267
 268   if (priv->current_filter)
 269     g_object_unref (priv->current_filter);
 270
 271   G_OBJECT_CLASS (gtk_recent_chooser_menu_parent_class)->finalize;
 272 }
 273
 274 static GObject *
 275 gtk_recent_chooser_menu_constructor (GType                  type,
 276                                      guint                  n_construct_properties,
 277                                      GObjectConstructParam *construct_params)
 278 {
 279   GtkRecentChooserMenu *menu;
 280   GObject *object;
 281
 282   object = G_OBJECT_CLASS (gtk_recent_chooser_menu_parent_class)->constructor (type,
 283                                                                                n_construct_properties,
 284                                                                                construct_params);
 285   menu = GTK_RECENT_CHOOSER_MENU (object);
 286
 287   g_assert (menu->priv->manager);
 288
 289   return object;
 290 }
 291
 292 static void
 293 gtk_recent_chooser_menu_set_property (GObject      *object,
 294                                       guint         prop_id,
 295                                       const GValue *value,
 296                                       GParamSpec   *pspec)
 297 {
 298   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (object);
 299
 300   switch (prop_id)
 301     {
 302     case PROP_SHOW_NUMBERS:
 303       menu->priv->show_numbers = g_value_get_boolean (value);
 304       break;
 305     case GTK_RECENT_CHOOSER_PROP_RECENT_MANAGER:
 306       set_recent_manager (menu, g_value_get_object (value));
 307       break;
 308     case GTK_RECENT_CHOOSER_PROP_SHOW_PRIVATE:
 309       menu->priv->show_private = g_value_get_boolean (value);
 310       break;
 311     case GTK_RECENT_CHOOSER_PROP_SHOW_NOT_FOUND:
 312       menu->priv->show_not_found = g_value_get_boolean (value);
 313       break;
 314     case GTK_RECENT_CHOOSER_PROP_SHOW_TIPS:
 315       gtk_recent_chooser_menu_set_show_tips (menu, g_value_get_boolean (value));
 316       break;
 317     case GTK_RECENT_CHOOSER_PROP_SHOW_ICONS:
 318       menu->priv->show_icons = g_value_get_boolean (value);
 319       break;
 320     case GTK_RECENT_CHOOSER_PROP_SELECT_MULTIPLE:
 321       g_warning ("%s: RecentChoosers of type `%s' do not support "
 322                  "selecting multiple items.",
 323                  G_STRFUNC,
 324                  G_OBJECT_TYPE_NAME (object));
 325       break;
 326     case GTK_RECENT_CHOOSER_PROP_LOCAL_ONLY:
 327       menu->priv->local_only = g_value_get_boolean (value);
 328       break;
 329     case GTK_RECENT_CHOOSER_PROP_LIMIT:
 330       menu->priv->limit = g_value_get_int (value);
 331       break;
 332     case GTK_RECENT_CHOOSER_PROP_SORT_TYPE:
 333       chooser_set_sort_type (menu, g_value_get_enum (value));
 334       break;
 335     case GTK_RECENT_CHOOSER_PROP_FILTER:
 336       gtk_recent_chooser_menu_set_current_filter (menu, g_value_get_object (value));
 337       break;
 338     default:
 339       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 340       break;
 341     }
 342 }
 343
 344 static void
 345 gtk_recent_chooser_menu_get_property (GObject    *object,
 346                                       guint       prop_id,
 347                                       GValue     *value,
 348                                       GParamSpec *pspec)
 349 {
 350   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (object);
 351
 352   switch (prop_id)
 353     {
 354     case PROP_SHOW_NUMBERS:
 355       g_value_set_boolean (value, menu->priv->show_numbers);
 356       break;
 357     case GTK_RECENT_CHOOSER_PROP_SHOW_TIPS:
 358       g_value_set_boolean (value, menu->priv->show_tips);
 359       break;
 360     case GTK_RECENT_CHOOSER_PROP_LIMIT:
 361       g_value_set_int (value, menu->priv->limit);
 362       break;
 363     case GTK_RECENT_CHOOSER_PROP_LOCAL_ONLY:
 364       g_value_set_boolean (value, menu->priv->local_only);
 365     case GTK_RECENT_CHOOSER_PROP_SORT_TYPE:
 366       g_value_set_enum (value, menu->priv->sort_type);
 367       break;
 368     case GTK_RECENT_CHOOSER_PROP_SHOW_PRIVATE:
 369       g_value_set_boolean (value, menu->priv->show_private);
 370       break;
 371     case GTK_RECENT_CHOOSER_PROP_SHOW_NOT_FOUND:
 372       g_value_set_boolean (value, menu->priv->show_not_found);
 373       break;
 374     case GTK_RECENT_CHOOSER_PROP_SHOW_ICONS:
 375       g_value_set_boolean (value, menu->priv->show_icons);
 376       break;
 377     case GTK_RECENT_CHOOSER_PROP_SELECT_MULTIPLE:
 378       g_warning ("%s: Recent Choosers of type `%s' do not support "
 379                  "selecting multiple items.",
 380                  G_STRFUNC,
 381                  G_OBJECT_TYPE_NAME (object));
 382       break;
 383     case GTK_RECENT_CHOOSER_PROP_FILTER:
 384       g_value_set_object (value, menu->priv->current_filter);
 385       break;
 386     default:
 387       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 388       break;
 389     }
 390 }
 391
 392 static gboolean
 393 gtk_recent_chooser_menu_set_current_uri (GtkRecentChooser  *chooser,
 394                                          const gchar       *uri,
 395                                          GError           **error)
 396 {
 397   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 398   GList *children, *l;
 399   GtkWidget *menu_item = NULL;
 400   gboolean found = FALSE;
 401
 402   children = gtk_container_get_children (GTK_CONTAINER (menu));
 403   for (l = children; l != NULL; l = l->next)
 404     {
 405       GtkRecentInfo *info;
 406
 407       menu_item = GTK_WIDGET (l->data);
 408
 409       info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 410       if (!info)
 411         continue;
 412
 413       if (0 == strcmp (uri, gtk_recent_info_get_uri (info)))
 414         found = TRUE;
 415     }
 416
 417   g_list_free (children);
 418
 419   if (!found)
 420     {
 421       g_set_error (error, GTK_RECENT_CHOOSER_ERROR,
 422                    GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,
 423                    _("No recently used resource found with URI `%s'"),
 424                    uri);
 425       return FALSE;
 426     }
 427   else
 428     {
 429       gtk_menu_shell_activate_item (GTK_MENU_SHELL (menu), menu_item, TRUE);
 430
 431       return TRUE;
 432     }
 433 }
 434
 435 static gchar *
 436 gtk_recent_chooser_menu_get_current_uri (GtkRecentChooser  *chooser)
 437 {
 438   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 439   GtkWidget *menu_item;
 440   GtkRecentInfo *info;
 441
 442   menu_item = gtk_menu_get_active (GTK_MENU (menu));
 443   if (!menu_item)
 444     return NULL;
 445
 446   info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 447   if (!info)
 448     return NULL;
 449
 450   return g_strdup (gtk_recent_info_get_uri (info));
 451 }
 452
 453 static gboolean
 454 gtk_recent_chooser_menu_select_uri (GtkRecentChooser  *chooser,
 455                                     const gchar       *uri,
 456                                     GError           **error)
 457 {
 458   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 459   GList *children, *l;
 460   GtkWidget *menu_item = NULL;
 461   gboolean found = FALSE;
 462
 463   children = gtk_container_get_children (GTK_CONTAINER (menu));
 464   for (l = children; l != NULL; l = l->next)
 465     {
 466       GtkRecentInfo *info;
 467
 468       menu_item = GTK_WIDGET (l->data);
 469
 470       info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 471       if (!info)
 472         continue;
 473
 474       if (0 == strcmp (uri, gtk_recent_info_get_uri (info)))
 475         found = TRUE;
 476     }
 477
 478   g_list_free (children);
 479
 480   if (!found)
 481     {
 482       g_set_error (error, GTK_RECENT_CHOOSER_ERROR,
 483                    GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,
 484                    _("No recently used resource found with URI `%s'"),
 485                    uri);
 486       return FALSE;
 487     }
 488   else
 489     {
 490       gtk_menu_shell_select_item (GTK_MENU_SHELL (menu), menu_item);
 491
 492       return TRUE;
 493     }
 494 }
 495
 496 static void
 497 gtk_recent_chooser_menu_unselect_uri (GtkRecentChooser *chooser,
 498                                        const gchar     *uri)
 499 {
 500   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 501
 502   gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
 503 }
 504
 505 static void
 506 gtk_recent_chooser_menu_select_all (GtkRecentChooser *chooser)
 507 {
 508   g_warning (_("This function is not implemented for "
 509                "widgets of class '%s'"),
 510              g_type_name (G_OBJECT_TYPE (chooser)));
 511 }
 512
 513 static void
 514 gtk_recent_chooser_menu_unselect_all (GtkRecentChooser *chooser)
 515 {
 516   g_warning (_("This function is not implemented for "
 517                "widgets of class '%s'."),
 518              g_type_name (G_OBJECT_TYPE (chooser)));
 519 }
 520
 521 static void
 522 gtk_recent_chooser_menu_set_sort_func (GtkRecentChooser  *chooser,
 523                                        GtkRecentSortFunc  sort_func,
 524                                        gpointer           sort_data,
 525                                        GDestroyNotify     data_destroy)
 526 {
 527   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 528   GtkRecentChooserMenuPrivate *priv = menu->priv;
 529
 530   if (priv->sort_data_destroy)
 531     {
 532       priv->sort_data_destroy (priv->sort_data);
 533
 534       priv->sort_func = NULL;
 535       priv->sort_data = NULL;
 536       priv->sort_data_destroy = NULL;
 537     }
 538
 539   if (sort_func)
 540     {
 541       priv->sort_func = sort_func;
 542       priv->sort_data = sort_data;
 543       priv->sort_data_destroy = data_destroy;
 544     }
 545 }
 546
 547 static gint
 548 sort_recent_items_mru (GtkRecentInfo *a,
 549                        GtkRecentInfo *b,
 550                        gpointer       unused)
 551 {
 552   g_assert (a != NULL && b != NULL);
 553
 554   return (gtk_recent_info_get_modified (a) < gtk_recent_info_get_modified (b));
 555 }
 556
 557 static gint
 558 sort_recent_items_lru (GtkRecentInfo *a,
 559                        GtkRecentInfo *b,
 560                        gpointer       unused)
 561 {
 562   g_assert (a != NULL && b != NULL);
 563
 564   return (gtk_recent_info_get_modified (a) > gtk_recent_info_get_modified (b));
 565 }
 566
 567 /* our proxy sorting function */
 568 static gint
 569 sort_recent_items_proxy (gpointer *a,
 570                          gpointer *b,
 571                          gpointer  user_data)
 572 {
 573   GtkRecentInfo *info_a = (GtkRecentInfo *) a;
 574   GtkRecentInfo *info_b = (GtkRecentInfo *) b;
 575   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (user_data);
 576
 577   if (menu->priv->sort_func)
 578     return (* menu->priv->sort_func) (info_a,
 579                                       info_b,
 580                                       menu->priv->sort_data);
 581
 582   /* fallback */
 583   return 0;
 584 }
 585
 586 static void
 587 chooser_set_sort_type (GtkRecentChooserMenu *menu,
 588                        GtkRecentSortType     sort_type)
 589 {
 590   if (menu->priv->sort_type == sort_type)
 591     return;
 592
 593   menu->priv->sort_type = sort_type;
 594 }
 595
 596
 597 static GList *
 598 gtk_recent_chooser_menu_get_items (GtkRecentChooser *chooser)
 599 {
 600   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 601   GtkRecentChooserMenuPrivate *priv;
 602   gint limit;
 603   GtkRecentSortType sort_type;
 604   GList *items;
 605   GCompareDataFunc compare_func;
 606   gint length;
 607
 608   priv = menu->priv;
 609
 610   if (!priv->manager)
 611     return NULL;
 612
 613   limit = gtk_recent_chooser_get_limit (chooser);
 614   sort_type = gtk_recent_chooser_get_sort_type (chooser);
 615
 616   switch (sort_type)
 617     {
 618     case GTK_RECENT_SORT_NONE:
 619       compare_func = NULL;
 620       break;
 621     case GTK_RECENT_SORT_MRU:
 622       compare_func = (GCompareDataFunc) sort_recent_items_mru;
 623       break;
 624     case GTK_RECENT_SORT_LRU:
 625       compare_func = (GCompareDataFunc) sort_recent_items_lru;
 626       break;
 627     case GTK_RECENT_SORT_CUSTOM:
 628       compare_func = (GCompareDataFunc) sort_recent_items_proxy;
 629       break;
 630     default:
 631       g_assert_not_reached ();
 632       break;
 633     }
 634
 635   items = gtk_recent_manager_get_items (priv->manager);
 636   if (!items)
 637     return NULL;
 638
 639   if (compare_func)
 640     items = g_list_sort_with_data (items, compare_func, menu);
 641
 642   length = g_list_length (items);
 643   if ((limit != -1) && (length > limit))
 644     {
 645       GList *clamp, *l;
 646
 647       clamp = g_list_nth (items, limit - 1);
 648
 649       l = clamp->next;
 650       clamp->next = NULL;
 651
 652       g_list_foreach (l, (GFunc) gtk_recent_info_unref, NULL);
 653       g_list_free (l);
 654     }
 655
 656   return items;
 657 }
 658
 659 static GtkRecentManager *
 660 gtk_recent_chooser_menu_get_recent_manager (GtkRecentChooser *chooser)
 661 {
 662   GtkRecentChooserMenuPrivate *priv;
 663
 664   priv = GTK_RECENT_CHOOSER_MENU (chooser)->priv;
 665
 666   return priv->manager;
 667 }
 668
 669 static void
 670 gtk_recent_chooser_menu_add_filter (GtkRecentChooser *chooser,
 671                                     GtkRecentFilter  *filter)
 672 {
 673   g_warning (_("This function is not implemented for "
 674                "widgets of class '%s'"),
 675              g_type_name (G_OBJECT_TYPE (chooser)));
 676 }
 677
 678 static void
 679 gtk_recent_chooser_menu_remove_filter (GtkRecentChooser *chooser,
 680                                        GtkRecentFilter  *filter)
 681 {
 682   g_warning (_("This function is not implemented for "
 683                "widgets of class '%s'"),
 684              g_type_name (G_OBJECT_TYPE (chooser)));
 685 }
 686
 687 static GSList *
 688 gtk_recent_chooser_menu_list_filters (GtkRecentChooser  *chooser)
 689 {
 690   g_warning (_("This function is not implemented for "
 691                "widgets of class '%s'"),
 692              g_type_name (G_OBJECT_TYPE (chooser)));
 693
 694   return NULL;
 695 }
 696
 697 static void
 698 gtk_recent_chooser_menu_set_current_filter (GtkRecentChooserMenu *menu,
 699                                             GtkRecentFilter      *filter)
 700 {
 701   GtkRecentChooserMenuPrivate *priv;
 702
 703   priv = menu->priv;
 704
 705   if (priv->current_filter)
 706     g_object_unref (G_OBJECT (priv->current_filter));
 707
 708   priv->current_filter = filter;
 709   g_object_ref_sink (priv->current_filter);
 710
 711   g_object_notify (G_OBJECT (menu), "filter");
 712 }
 713
 714 static gboolean
 715 get_is_recent_filtered (GtkRecentChooserMenu *menu,
 716                         GtkRecentInfo        *info)
 717 {
 718   GtkRecentChooserMenuPrivate *priv;
 719   GtkRecentFilter *current_filter;
 720   GtkRecentFilterInfo filter_info;
 721   GtkRecentFilterFlags needed;
 722   gboolean retval;
 723
 724   g_assert (info != NULL);
 725
 726   priv = menu->priv;
 727
 728   if (!priv->current_filter)
 729     return FALSE;
 730
 731   current_filter = priv->current_filter;
 732   needed = gtk_recent_filter_get_needed (current_filter);
 733
 734   filter_info.contains = GTK_RECENT_FILTER_URI | GTK_RECENT_FILTER_MIME_TYPE;
 735
 736   filter_info.uri = gtk_recent_info_get_uri (info);
 737   filter_info.mime_type = gtk_recent_info_get_mime_type (info);
 738
 739   if (needed & GTK_RECENT_FILTER_DISPLAY_NAME)
 740     {
 741       filter_info.display_name = gtk_recent_info_get_display_name (info);
 742       filter_info.contains |= GTK_RECENT_FILTER_DISPLAY_NAME;
 743     }
 744   else
 745     filter_info.uri = NULL;
 746
 747   if (needed & GTK_RECENT_FILTER_APPLICATION)
 748     {
 749       filter_info.applications = (const gchar **) gtk_recent_info_get_applications (info, NULL);
 750       filter_info.contains |= GTK_RECENT_FILTER_APPLICATION;
 751     }
 752   else
 753     filter_info.applications = NULL;
 754
 755   if (needed & GTK_RECENT_FILTER_GROUP)
 756     {
 757       filter_info.groups = (const gchar **) gtk_recent_info_get_groups (info, NULL);
 758       filter_info.contains |= GTK_RECENT_FILTER_GROUP;
 759     }
 760   else
 761     filter_info.groups = NULL;
 762
 763   if (needed & GTK_RECENT_FILTER_AGE)
 764     {
 765       filter_info.age = gtk_recent_info_get_age (info);
 766       filter_info.contains |= GTK_RECENT_FILTER_AGE;
 767     }
 768   else
 769     filter_info.age = -1;
 770
 771   retval = gtk_recent_filter_filter (current_filter, &filter_info);
 772
 773   /* this we own */
 774   if (filter_info.applications)
 775     g_strfreev ((gchar **) filter_info.applications);
 776
 777   return !retval;
 778 }
 779
 780 /* taken from libeel/eel-strings.c */
 781 static gchar *
 782 escape_underscores (const gchar *string)
 783 {
 784   gint underscores;
 785   const gchar *p;
 786   gchar *q;
 787   gchar *escaped;
 788
 789   if (!string)
 790     return NULL;
 791
 792   underscores = 0;
 793   for (p = string; *p != '\0'; p++)
 794     underscores += (*p == '_');
 795
 796   if (underscores == 0)
 797     return g_strdup (string);
 798
 799   escaped = g_new (char, strlen (string) + underscores + 1);
 800   for (p = string, q = escaped; *p != '\0'; p++, q++)
 801     {
 802       /* Add an extra underscore. */
 803       if (*p == '_')
 804         *q++ = '_';
 805
 806       *q = *p;
 807     }
 808
 809   *q = '\0';
 810
 811   return escaped;
 812 }
 813
 814 static void
 815 gtk_recent_chooser_menu_add_tip (GtkRecentChooserMenu *menu,
 816                                  GtkRecentInfo        *info,
 817                                  GtkWidget            *item)
 818 {
 819   GtkRecentChooserMenuPrivate *priv;
 820   gchar *path, *tip_text;
 821
 822   g_assert (info != NULL);
 823   g_assert (item != NULL);
 824
 825   priv = menu->priv;
 826
 827   if (!priv->tooltips)
 828     return;
 829
 830   path = gtk_recent_info_get_uri_display (info);
 831
 832   tip_text = g_strdup_printf (_("Open '%s'"), path);
 833
 834   gtk_tooltips_set_tip (priv->tooltips,
 835                         item,
 836                         tip_text,
 837                         NULL);
 838
 839   g_free (path);
 840   g_free (tip_text);
 841 }
 842
 843 static GtkWidget *
 844 gtk_recent_chooser_menu_create_item (GtkRecentChooserMenu *menu,
 845                                      GtkRecentInfo        *info,
 846                                      gint                  count)
 847 {
 848   GtkRecentChooserMenuPrivate *priv;
 849   gchar *label;
 850   GtkWidget *item, *image;
 851   GdkPixbuf *icon;
 852
 853   g_assert (info != NULL);
 854
 855   priv = menu->priv;
 856
 857   if (priv->show_numbers)
 858     {
 859       gchar *name, *escaped;
 860
 861       name = g_strdup (gtk_recent_info_get_display_name (info));
 862       if (!name)
 863         name = g_strdup (_("Unknown item"));
 864
 865       escaped = escape_underscores (name);
 866
 867       /* avoid clashing mnemonics */
 868       if (count <= 10)
 869         label = g_strdup_printf ("_%d. %s", count, escaped);
 870       else
 871         label = g_strdup_printf ("%d. %s", count, escaped);
 872
 873       item = gtk_image_menu_item_new_with_mnemonic (label);
 874
 875       g_free (escaped);
 876       g_free (name);
 877     }
 878   else
 879     {
 880       label = g_strdup (gtk_recent_info_get_display_name (info));
 881       item = gtk_image_menu_item_new_with_label (label);
 882     }
 883
 884   if (priv->show_icons)
 885     {
 886       icon = gtk_recent_info_get_icon (info, priv->icon_size);
 887
 888       image = gtk_image_new_from_pixbuf (icon);
 889       gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
 890     }
 891
 892   if (!gtk_recent_info_exists (info))
 893     {
 894       gtk_widget_set_sensitive (item, FALSE);
 895
 896       goto out;
 897     }
 898
 899   g_signal_connect (item, "activate",
 900                     G_CALLBACK (item_activate_cb),
 901                     menu);
 902
 903 out:
 904   g_free (label);
 905
 906   return item;
 907 }
 908
 909 /* removes the items we own from the menu */
 910 static void
 911 gtk_recent_chooser_menu_dispose_items (GtkRecentChooserMenu *menu)
 912 {
 913   GList *children, *l;
 914
 915   children = gtk_container_get_children (GTK_CONTAINER (menu));
 916   for (l = children; l != NULL; l = l->next)
 917     {
 918       GtkWidget *menu_item = GTK_WIDGET (l->data);
 919       gint mark = 0;
 920
 921       /* check for our mark, in order to remove just the items we own */
 922       mark = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (menu_item),
 923                                                  "gtk-recent-menu-mark"));
 924       if (mark == 1)
 925         {
 926           GtkRecentInfo *info;
 927
 928           /* destroy the attached RecentInfo struct, if found */
 929           info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 930           if (info)
 931             g_object_set_data_full (G_OBJECT (menu_item), "gtk-recent-info",
 932                                     NULL, NULL);
 933
 934           /* and finally remove the item from the menu */
 935           gtk_container_remove (GTK_CONTAINER (menu), menu_item);
 936         }
 937     }
 938
 939   g_list_free (children);
 940 }
 941
 942 /* GtkWidget::map method override
 943  *
 944  * We override this method in order to populate the menu with our
 945  * menu items linked to the recently used resources.
 946  */
 947 static void
 948 gtk_recent_chooser_menu_map (GtkWidget *widget)
 949 {
 950   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (widget);
 951   GtkRecentChooserMenuPrivate *priv = menu->priv;
 952   GList *items, *l;
 953   gint count;
 954   gboolean has_items = FALSE;
 955
 956   if (GTK_WIDGET_CLASS (gtk_recent_chooser_menu_parent_class)->map)
 957     GTK_WIDGET_CLASS (gtk_recent_chooser_menu_parent_class)->map (widget);
 958
 959   priv->icon_size = get_icon_size_for_widget (widget);
 960
 961   /* dispose our menu items first */
 962   gtk_recent_chooser_menu_dispose_items (menu);
 963
 964   items = gtk_recent_chooser_get_items (GTK_RECENT_CHOOSER (menu));
 965
 966   count = g_list_length (items);
 967   items = g_list_reverse (items);
 968
 969   for (l = items; l != NULL; l = l->next)
 970     {
 971       GtkRecentInfo *info = (GtkRecentInfo *) l->data;
 972       GtkWidget *item;
 973
 974       g_assert (info != NULL);
 975
 976       /* skip non-local items on request */
 977       if (priv->local_only && !gtk_recent_info_is_local (info))
 978         continue;
 979
 980       /* skip private items on request */
 981       if (!priv->show_private && gtk_recent_info_get_private_hint (info))
 982         continue;
 983
 984       /* skip non-existing items on request */
 985       if (!priv->show_not_found && !gtk_recent_info_exists (info))
 986         continue;
 987
 988       /* filter items based on the currently set filter object */
 989       if (get_is_recent_filtered (menu, info))
 990         continue;
 991
 992       item = gtk_recent_chooser_menu_create_item (menu, info, count);
 993       if (!item)
 994         continue;
 995
 996       gtk_recent_chooser_menu_add_tip (menu, info, item);
 997
 998       /* FIXME
 999        *
1000        * We should really place our items taking into account user
1001        * defined menu items; this would also remove the need of
1002        * reverting the scan order.
1003        */
1004       gtk_menu_shell_prepend (GTK_MENU_SHELL (menu), item);
1005       gtk_widget_show (item);
1006
1007       /* mark the menu item as one of our own */
1008       g_object_set_data (G_OBJECT (item), "gtk-recent-menu-mark",
1009                          GINT_TO_POINTER (1));
1010
1011       /* attach the RecentInfo object to the menu item, and own a reference
1012        * to it, so that it will be destroyed with the menu item when it's
1013        * not needed anymore.
1014        */
1015       g_object_set_data_full (G_OBJECT (item), "gtk-recent-info",
1016                               gtk_recent_info_ref (info),
1017                               (GDestroyNotify) gtk_recent_info_unref);
1018
1019       /* we have at least one item */
1020       if (!has_items)
1021         has_items = TRUE;
1022     }
1023
1024   /* now, the RecentInfo objects are bound to the lifetime of the menu */
1025   if (items)
1026     {
1027       g_list_foreach (items,
1028                       (GFunc) gtk_recent_info_unref,
1029                       NULL);
1030       g_list_free (items);
1031     }
1032
1033   /* no recently used resources were found, or they were filtered out, so
1034    * we build an item stating that no recently used resources were found
1035    * (as night follows the day...).
1036    */
1037   if (!has_items)
1038     {
1039       GtkWidget *item;
1040
1041       item = gtk_menu_item_new_with_label ("No items found");
1042       gtk_widget_set_sensitive (item, FALSE);
1043
1044       /* we also mark this item, so that it gets removed when rebuilding
1045        * the menu on the next map event
1046        */
1047       g_object_set_data (G_OBJECT (item), "gtk-recent-menu-mark",
1048                          GINT_TO_POINTER (1));
1049
1050       gtk_menu_shell_prepend (GTK_MENU_SHELL (menu), item);
1051       gtk_widget_show (item);
1052     }
1053 }
1054
1055 /* bounce activate signal from the recent menu item widget
1056  * to the recent menu widget
1057  */
1058 static void
1059 item_activate_cb (GtkWidget *widget,
1060                   gpointer   user_data)
1061 {
1062   GtkRecentChooser *chooser = GTK_RECENT_CHOOSER (user_data);
1063
1064   _gtk_recent_chooser_item_activated (chooser);
1065 }
1066
1067 /* we force a redraw if the manager changes when we are showing */
1068 static void
1069 manager_changed_cb (GtkRecentManager *manager,
1070                     gpointer          user_data)
1071 {
1072   gtk_widget_queue_draw (GTK_WIDGET (user_data));
1073 }
1074
1075 static void
1076 set_recent_manager (GtkRecentChooserMenu *menu,
1077                     GtkRecentManager     *manager)
1078 {
1079   if (menu->priv->manager)
1080     g_signal_handler_disconnect (menu, menu->priv->manager_changed_id);
1081
1082   menu->priv->manager = NULL;
1083
1084   if (manager)
1085     menu->priv->manager = manager;
1086   else
1087     menu->priv->manager = gtk_recent_manager_get_default ();
1088
1089   if (menu->priv->manager)
1090     menu->priv->manager_changed_id = g_signal_connect (menu->priv->manager, "changed",
1091                                                        G_CALLBACK (manager_changed_cb),
1092                                                        menu);
1093 }
1094
1095 static gint
1096 get_icon_size_for_widget (GtkWidget *widget)
1097 {
1098   GtkSettings *settings;
1099   gint width, height;
1100
1101   if (gtk_widget_has_screen (widget))
1102     settings = gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
1103   else
1104     settings = gtk_settings_get_default ();
1105
1106   if (gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
1107                                          &width, &height))
1108     return MAX (width, height);
1109
1110   return FALLBACK_ICON_SIZE;
1111 }
1112
1113 static void
1114 gtk_recent_chooser_menu_set_show_tips (GtkRecentChooserMenu *menu,
1115                                        gboolean              show_tips)
1116 {
1117   if (menu->priv->show_tips == show_tips)
1118     return;
1119
1120   g_assert (menu->priv->tooltips != NULL);
1121
1122   if (show_tips)
1123     gtk_tooltips_enable (menu->priv->tooltips);
1124   else
1125     gtk_tooltips_disable (menu->priv->tooltips);
1126
1127   menu->priv->show_tips = show_tips;
1128 }
1129
1130 /*
1131  * Public API
1132  */
1133
1134 /**
1135  * gtk_recent_chooser_menu_new:
1136  *
1137  * Creates a new #GtkRecentChooserMenu widget.
1138  *
1139  * This kind of widget shows the list of recently used resources as
1140  * a menu, each item as a menu item.  Each item inside the menu might
1141  * have an icon, representing its MIME type, and a number, for mnemonic
1142  * access.
1143  *
1144  * This widget implements the #GtkRecentChooser interface.
1145  *
1146  * This widget creates its own #GtkRecentManager object.  See the
1147  * gtk_recent_chooser_menu_new_for_manager() function to know how to create
1148  * a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object.
1149  *
1150  * Return value: a new #GtkRecentChooserMenu
1151  *
1152  * Since: 2.10
1153  */
1154 GtkWidget *
1155 gtk_recent_chooser_menu_new (void)
1156 {
1157   return g_object_new (GTK_TYPE_RECENT_CHOOSER_MENU,
1158                        "recent-manager", NULL,
1159                        NULL);
1160 }
1161
1162 /**
1163  * gtk_recent_chooser_menu_new_for_manager:
1164  * @manager: a #GtkRecentManager
1165  *
1166  * Creates a new #GtkRecentChooserMenu widget using @manager as
1167  * the underlying recently used resources manager.
1168  *
1169  * This is useful if you have implemented your own recent manager,
1170  * or if you have a customized instance of a #GtkRecentManager
1171  * object or if you wish to share a common #GtkRecentManager object
1172  * among multiple #GtkRecentChooser widgets.
1173  *
1174  * Return value: a new #GtkRecentChooserMenu, bound to @manager.
1175  *
1176  * Since: 2.10
1177  */
1178 GtkWidget *
1179 gtk_recent_chooser_menu_new_for_manager (GtkRecentManager *manager)
1180 {
1181   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1182
1183   return g_object_new (GTK_TYPE_RECENT_CHOOSER_MENU,
1184                        "recent-manager", manager,
1185                        NULL);
1186 }
1187
1188 /**
1189  * gtk_recent_chooser_menu_get_show_numbers:
1190  * @menu: a #GtkRecentChooserMenu
1191  *
1192  * Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
1193  *
1194  * Return value: %TRUE if numbers should be shown.
1195  *
1196  * Since: 2.10
1197  */
1198 gboolean
1199 gtk_recent_chooser_menu_get_show_numbers (GtkRecentChooserMenu *menu)
1200 {
1201   g_return_val_if_fail (GTK_IS_RECENT_CHOOSER_MENU (menu), FALSE);
1202
1203   return menu->priv->show_numbers;
1204 }
1205
1206 /**
1207  * gtk_recent_chooser_menu_set_show_numbers:
1208  * @menu: a #GtkRecentChooserMenu
1209  * @show_numbers: whether to show numbers
1210  *
1211  * Sets whether a number should be added to the items of @menu.  The
1212  * numbers are shown to provide a unique character for a mnemonic to
1213  * be used inside the menu item's label.  Only the first the items
1214  * get a number to avoid clashes.
1215  *
1216  * Since: 2.10
1217  */
1218 void
1219 gtk_recent_chooser_menu_set_show_numbers (GtkRecentChooserMenu *menu,
1220                                           gboolean              show_numbers)
1221 {
1222   g_return_if_fail (GTK_IS_RECENT_CHOOSER_MENU (menu));
1223
1224   if (menu->priv->show_numbers == show_numbers)
1225     return;
1226
1227   menu->priv->show_numbers = show_numbers;
1228   g_object_notify (G_OBJECT (menu), "show-numbers");
1229 }
1230
1231 #define __GTK_RECENT_CHOOSER_MENU_C__
1232 #include "gtkaliasdef.c"