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   gulong populate_id;
  87
  88   /* tooltips for our bookmark items*/
  89   GtkTooltips *tooltips;
  90 };
  91
  92 enum {
  93   PROP_0,
  94
  95   PROP_SHOW_NUMBERS
  96 };
  97
  98 #define FALLBACK_ICON_SIZE      32
  99 #define FALLBACK_ITEM_LIMIT     10
 100
 101 #define GTK_RECENT_CHOOSER_MENU_GET_PRIVATE(obj)        (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_RECENT_CHOOSER_MENU, GtkRecentChooserMenuPrivate))
 102
 103 static void     gtk_recent_chooser_menu_finalize    (GObject                   *object);
 104 static GObject *gtk_recent_chooser_menu_constructor (GType                      type,
 105                                                      guint                      n_construct_properties,
 106                                                      GObjectConstructParam     *construct_params);
 107
 108 static void gtk_recent_chooser_iface_init      (GtkRecentChooserIface     *iface);
 109
 110 static void gtk_recent_chooser_menu_set_property (GObject      *object,
 111                                                   guint         prop_id,
 112                                                   const GValue *value,
 113                                                   GParamSpec   *pspec);
 114 static void gtk_recent_chooser_menu_get_property (GObject      *object,
 115                                                   guint         prop_id,
 116                                                   GValue       *value,
 117                                                   GParamSpec   *pspec);
 118
 119 static gboolean          gtk_recent_chooser_menu_set_current_uri    (GtkRecentChooser  *chooser,
 120                                                                      const gchar       *uri,
 121                                                                      GError           **error);
 122 static gchar *           gtk_recent_chooser_menu_get_current_uri    (GtkRecentChooser  *chooser);
 123 static gboolean          gtk_recent_chooser_menu_select_uri         (GtkRecentChooser  *chooser,
 124                                                                      const gchar       *uri,
 125                                                                      GError           **error);
 126 static void              gtk_recent_chooser_menu_unselect_uri       (GtkRecentChooser  *chooser,
 127                                                                      const gchar       *uri);
 128 static void              gtk_recent_chooser_menu_select_all         (GtkRecentChooser  *chooser);
 129 static void              gtk_recent_chooser_menu_unselect_all       (GtkRecentChooser  *chooser);
 130 static GList *           gtk_recent_chooser_menu_get_items          (GtkRecentChooser  *chooser);
 131 static GtkRecentManager *gtk_recent_chooser_menu_get_recent_manager (GtkRecentChooser  *chooser);
 132 static void              gtk_recent_chooser_menu_set_sort_func      (GtkRecentChooser  *chooser,
 133                                                                      GtkRecentSortFunc  sort_func,
 134                                                                      gpointer           sort_data,
 135                                                                      GDestroyNotify     data_destroy);
 136 static void              gtk_recent_chooser_menu_add_filter         (GtkRecentChooser  *chooser,
 137                                                                      GtkRecentFilter   *filter);
 138 static void              gtk_recent_chooser_menu_remove_filter      (GtkRecentChooser  *chooser,
 139                                                                      GtkRecentFilter   *filter);
 140 static GSList *          gtk_recent_chooser_menu_list_filters       (GtkRecentChooser  *chooser);
 141 static void              gtk_recent_chooser_menu_set_current_filter (GtkRecentChooserMenu *menu,
 142                                                                      GtkRecentFilter      *filter);
 143
 144 static void              gtk_recent_chooser_menu_populate           (GtkRecentChooserMenu *menu);
 145 static void              gtk_recent_chooser_menu_set_show_tips      (GtkRecentChooserMenu *menu,
 146                                                                      gboolean              show_tips);
 147
 148 static void     set_recent_manager (GtkRecentChooserMenu *menu,
 149                                     GtkRecentManager     *manager);
 150
 151 static void     chooser_set_sort_type (GtkRecentChooserMenu *menu,
 152                                        GtkRecentSortType     sort_type);
 153
 154 static gint     get_icon_size_for_widget (GtkWidget *widget);
 155
 156 static void     item_activate_cb   (GtkWidget        *widget,
 157                                     gpointer          user_data);
 158 static void     manager_changed_cb (GtkRecentManager *manager,
 159                                     gpointer          user_data);
 160
 161 G_DEFINE_TYPE_WITH_CODE (GtkRecentChooserMenu,
 162                          gtk_recent_chooser_menu,
 163                          GTK_TYPE_MENU,
 164                          G_IMPLEMENT_INTERFACE (GTK_TYPE_RECENT_CHOOSER,
 165                                                 gtk_recent_chooser_iface_init))
 166
 167
 168 static void
 169 gtk_recent_chooser_iface_init (GtkRecentChooserIface *iface)
 170 {
 171   iface->set_current_uri = gtk_recent_chooser_menu_set_current_uri;
 172   iface->get_current_uri = gtk_recent_chooser_menu_get_current_uri;
 173   iface->select_uri = gtk_recent_chooser_menu_select_uri;
 174   iface->unselect_uri = gtk_recent_chooser_menu_unselect_uri;
 175   iface->select_all = gtk_recent_chooser_menu_select_all;
 176   iface->unselect_all = gtk_recent_chooser_menu_unselect_all;
 177   iface->get_items = gtk_recent_chooser_menu_get_items;
 178   iface->get_recent_manager = gtk_recent_chooser_menu_get_recent_manager;
 179   iface->set_sort_func = gtk_recent_chooser_menu_set_sort_func;
 180   iface->add_filter = gtk_recent_chooser_menu_add_filter;
 181   iface->remove_filter = gtk_recent_chooser_menu_remove_filter;
 182   iface->list_filters = gtk_recent_chooser_menu_list_filters;
 183 }
 184
 185 static void
 186 gtk_recent_chooser_menu_class_init (GtkRecentChooserMenuClass *klass)
 187 {
 188   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 189
 190   gobject_class->constructor = gtk_recent_chooser_menu_constructor;
 191   gobject_class->finalize = gtk_recent_chooser_menu_finalize;
 192   gobject_class->set_property = gtk_recent_chooser_menu_set_property;
 193   gobject_class->get_property = gtk_recent_chooser_menu_get_property;
 194
 195   _gtk_recent_chooser_install_properties (gobject_class);
 196
 197   /**
 198    * GtkRecentChooserMenu:show-numbers
 199    *
 200    * Whether the first ten items in the menu should be prepended by
 201    * a number acting as a unique mnemonic.
 202    *
 203    * Since: 2.10
 204    */
 205   g_object_class_install_property (gobject_class,
 206                                    PROP_SHOW_NUMBERS,
 207                                    g_param_spec_boolean ("show-numbers",
 208                                                          P_("Show Numbers"),
 209                                                          P_("Whether the items should be displayed with a number"),
 210                                                          FALSE,
 211                                                          G_PARAM_READWRITE));
 212
 213   g_type_class_add_private (klass, sizeof (GtkRecentChooserMenuPrivate));
 214 }
 215
 216 static void
 217 gtk_recent_chooser_menu_init (GtkRecentChooserMenu *menu)
 218 {
 219   GtkRecentChooserMenuPrivate *priv;
 220
 221   priv = GTK_RECENT_CHOOSER_MENU_GET_PRIVATE (menu);
 222
 223   menu->priv = priv;
 224
 225   priv->show_icons= TRUE;
 226   priv->show_numbers = FALSE;
 227   priv->show_tips = FALSE;
 228   priv->show_not_found = FALSE;
 229   priv->show_private = FALSE;
 230   priv->local_only = TRUE;
 231
 232   priv->limit = FALLBACK_ITEM_LIMIT;
 233
 234   priv->sort_type = GTK_RECENT_SORT_NONE;
 235
 236   priv->icon_size = FALLBACK_ICON_SIZE;
 237
 238   priv->current_filter = NULL;
 239
 240   priv->tooltips = gtk_tooltips_new ();
 241   g_object_ref_sink (priv->tooltips);
 242 }
 243
 244 static void
 245 gtk_recent_chooser_menu_finalize (GObject *object)
 246 {
 247   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (object);
 248   GtkRecentChooserMenuPrivate *priv = menu->priv;
 249
 250   g_signal_handler_disconnect (priv->manager, priv->manager_changed_id);
 251   priv->manager_changed_id = 0;
 252
 253   priv->manager = NULL;
 254
 255   if (priv->sort_data_destroy)
 256     {
 257       priv->sort_data_destroy (priv->sort_data);
 258
 259       priv->sort_data_destroy = NULL;
 260       priv->sort_data = NULL;
 261       priv->sort_func = NULL;
 262     }
 263
 264   if (priv->tooltips)
 265     g_object_unref (priv->tooltips);
 266
 267   if (priv->current_filter)
 268     g_object_unref (priv->current_filter);
 269
 270   G_OBJECT_CLASS (gtk_recent_chooser_menu_parent_class)->finalize (object);
 271 }
 272
 273 static GObject *
 274 gtk_recent_chooser_menu_constructor (GType                  type,
 275                                      guint                  n_construct_properties,
 276                                      GObjectConstructParam *construct_params)
 277 {
 278   GtkRecentChooserMenu *menu;
 279   GObject *object;
 280
 281   object = G_OBJECT_CLASS (gtk_recent_chooser_menu_parent_class)->constructor (type,
 282                                                                                n_construct_properties,
 283                                                                                construct_params);
 284   menu = GTK_RECENT_CHOOSER_MENU (object);
 285
 286   g_assert (menu->priv->manager);
 287
 288   return object;
 289 }
 290
 291 static void
 292 gtk_recent_chooser_menu_set_property (GObject      *object,
 293                                       guint         prop_id,
 294                                       const GValue *value,
 295                                       GParamSpec   *pspec)
 296 {
 297   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (object);
 298
 299   switch (prop_id)
 300     {
 301     case PROP_SHOW_NUMBERS:
 302       menu->priv->show_numbers = g_value_get_boolean (value);
 303       break;
 304     case GTK_RECENT_CHOOSER_PROP_RECENT_MANAGER:
 305       set_recent_manager (menu, g_value_get_object (value));
 306       break;
 307     case GTK_RECENT_CHOOSER_PROP_SHOW_PRIVATE:
 308       menu->priv->show_private = g_value_get_boolean (value);
 309       break;
 310     case GTK_RECENT_CHOOSER_PROP_SHOW_NOT_FOUND:
 311       menu->priv->show_not_found = g_value_get_boolean (value);
 312       break;
 313     case GTK_RECENT_CHOOSER_PROP_SHOW_TIPS:
 314       gtk_recent_chooser_menu_set_show_tips (menu, g_value_get_boolean (value));
 315       break;
 316     case GTK_RECENT_CHOOSER_PROP_SHOW_ICONS:
 317       menu->priv->show_icons = g_value_get_boolean (value);
 318       break;
 319     case GTK_RECENT_CHOOSER_PROP_SELECT_MULTIPLE:
 320       g_warning ("%s: Choosers of type `%s' do not support selecting multiple items.",
 321                  G_STRFUNC,
 322                  G_OBJECT_TYPE_NAME (object));
 323       break;
 324     case GTK_RECENT_CHOOSER_PROP_LOCAL_ONLY:
 325       menu->priv->local_only = g_value_get_boolean (value);
 326       break;
 327     case GTK_RECENT_CHOOSER_PROP_LIMIT:
 328       menu->priv->limit = g_value_get_int (value);
 329       break;
 330     case GTK_RECENT_CHOOSER_PROP_SORT_TYPE:
 331       chooser_set_sort_type (menu, g_value_get_enum (value));
 332       break;
 333     case GTK_RECENT_CHOOSER_PROP_FILTER:
 334       gtk_recent_chooser_menu_set_current_filter (menu, g_value_get_object (value));
 335       break;
 336     default:
 337       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 338       break;
 339     }
 340 }
 341
 342 static void
 343 gtk_recent_chooser_menu_get_property (GObject    *object,
 344                                       guint       prop_id,
 345                                       GValue     *value,
 346                                       GParamSpec *pspec)
 347 {
 348   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (object);
 349
 350   switch (prop_id)
 351     {
 352     case PROP_SHOW_NUMBERS:
 353       g_value_set_boolean (value, menu->priv->show_numbers);
 354       break;
 355     case GTK_RECENT_CHOOSER_PROP_SHOW_TIPS:
 356       g_value_set_boolean (value, menu->priv->show_tips);
 357       break;
 358     case GTK_RECENT_CHOOSER_PROP_LIMIT:
 359       g_value_set_int (value, menu->priv->limit);
 360       break;
 361     case GTK_RECENT_CHOOSER_PROP_LOCAL_ONLY:
 362       g_value_set_boolean (value, menu->priv->local_only);
 363       break;
 364     case GTK_RECENT_CHOOSER_PROP_SORT_TYPE:
 365       g_value_set_enum (value, menu->priv->sort_type);
 366       break;
 367     case GTK_RECENT_CHOOSER_PROP_SHOW_PRIVATE:
 368       g_value_set_boolean (value, menu->priv->show_private);
 369       break;
 370     case GTK_RECENT_CHOOSER_PROP_SHOW_NOT_FOUND:
 371       g_value_set_boolean (value, menu->priv->show_not_found);
 372       break;
 373     case GTK_RECENT_CHOOSER_PROP_SHOW_ICONS:
 374       g_value_set_boolean (value, menu->priv->show_icons);
 375       break;
 376     case GTK_RECENT_CHOOSER_PROP_SELECT_MULTIPLE:
 377       g_warning ("%s: Choosers of type `%s' do not support selecting multiple items.",
 378                  G_STRFUNC,
 379                  G_OBJECT_TYPE_NAME (object));
 380       break;
 381     case GTK_RECENT_CHOOSER_PROP_FILTER:
 382       g_value_set_object (value, menu->priv->current_filter);
 383       break;
 384     default:
 385       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 386       break;
 387     }
 388 }
 389
 390 static gboolean
 391 gtk_recent_chooser_menu_set_current_uri (GtkRecentChooser  *chooser,
 392                                          const gchar       *uri,
 393                                          GError           **error)
 394 {
 395   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 396   GList *children, *l;
 397   GtkWidget *menu_item = NULL;
 398   gboolean found = FALSE;
 399
 400   children = gtk_container_get_children (GTK_CONTAINER (menu));
 401   for (l = children; l != NULL; l = l->next)
 402     {
 403       GtkRecentInfo *info;
 404
 405       menu_item = GTK_WIDGET (l->data);
 406
 407       info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 408       if (!info)
 409         continue;
 410
 411       if (0 == strcmp (uri, gtk_recent_info_get_uri (info)))
 412         found = TRUE;
 413     }
 414
 415   g_list_free (children);
 416
 417   if (!found)
 418     {
 419       g_set_error (error, GTK_RECENT_CHOOSER_ERROR,
 420                    GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,
 421                    _("No recently used resource found with URI `%s'"),
 422                    uri);
 423       return FALSE;
 424     }
 425   else
 426     {
 427       gtk_menu_shell_activate_item (GTK_MENU_SHELL (menu), menu_item, TRUE);
 428
 429       return TRUE;
 430     }
 431 }
 432
 433 static gchar *
 434 gtk_recent_chooser_menu_get_current_uri (GtkRecentChooser  *chooser)
 435 {
 436   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 437   GtkWidget *menu_item;
 438   GtkRecentInfo *info;
 439
 440   menu_item = gtk_menu_get_active (GTK_MENU (menu));
 441   if (!menu_item)
 442     return NULL;
 443
 444   info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 445   if (!info)
 446     return NULL;
 447
 448   return g_strdup (gtk_recent_info_get_uri (info));
 449 }
 450
 451 static gboolean
 452 gtk_recent_chooser_menu_select_uri (GtkRecentChooser  *chooser,
 453                                     const gchar       *uri,
 454                                     GError           **error)
 455 {
 456   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 457   GList *children, *l;
 458   GtkWidget *menu_item = NULL;
 459   gboolean found = FALSE;
 460
 461   children = gtk_container_get_children (GTK_CONTAINER (menu));
 462   for (l = children; l != NULL; l = l->next)
 463     {
 464       GtkRecentInfo *info;
 465
 466       menu_item = GTK_WIDGET (l->data);
 467
 468       info = g_object_get_data (G_OBJECT (menu_item), "gtk-recent-info");
 469       if (!info)
 470         continue;
 471
 472       if (0 == strcmp (uri, gtk_recent_info_get_uri (info)))
 473         found = TRUE;
 474     }
 475
 476   g_list_free (children);
 477
 478   if (!found)
 479     {
 480       g_set_error (error, GTK_RECENT_CHOOSER_ERROR,
 481                    GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,
 482                    _("No recently used resource found with URI `%s'"),
 483                    uri);
 484       return FALSE;
 485     }
 486   else
 487     {
 488       gtk_menu_shell_select_item (GTK_MENU_SHELL (menu), menu_item);
 489
 490       return TRUE;
 491     }
 492 }
 493
 494 static void
 495 gtk_recent_chooser_menu_unselect_uri (GtkRecentChooser *chooser,
 496                                        const gchar     *uri)
 497 {
 498   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 499
 500   gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
 501 }
 502
 503 static void
 504 gtk_recent_chooser_menu_select_all (GtkRecentChooser *chooser)
 505 {
 506   g_warning (_("This function is not implemented for "
 507                "widgets of class '%s'"),
 508              g_type_name (G_OBJECT_TYPE (chooser)));
 509 }
 510
 511 static void
 512 gtk_recent_chooser_menu_unselect_all (GtkRecentChooser *chooser)
 513 {
 514   g_warning (_("This function is not implemented for "
 515                "widgets of class '%s'"),
 516              g_type_name (G_OBJECT_TYPE (chooser)));
 517 }
 518
 519 static void
 520 gtk_recent_chooser_menu_set_sort_func (GtkRecentChooser  *chooser,
 521                                        GtkRecentSortFunc  sort_func,
 522                                        gpointer           sort_data,
 523                                        GDestroyNotify     data_destroy)
 524 {
 525   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 526   GtkRecentChooserMenuPrivate *priv = menu->priv;
 527
 528   if (priv->sort_data_destroy)
 529     {
 530       priv->sort_data_destroy (priv->sort_data);
 531
 532       priv->sort_func = NULL;
 533       priv->sort_data = NULL;
 534       priv->sort_data_destroy = NULL;
 535     }
 536
 537   if (sort_func)
 538     {
 539       priv->sort_func = sort_func;
 540       priv->sort_data = sort_data;
 541       priv->sort_data_destroy = data_destroy;
 542     }
 543 }
 544
 545 static gint
 546 sort_recent_items_mru (GtkRecentInfo *a,
 547                        GtkRecentInfo *b,
 548                        gpointer       unused)
 549 {
 550   g_assert (a != NULL && b != NULL);
 551
 552   return (gtk_recent_info_get_modified (a) < gtk_recent_info_get_modified (b));
 553 }
 554
 555 static gint
 556 sort_recent_items_lru (GtkRecentInfo *a,
 557                        GtkRecentInfo *b,
 558                        gpointer       unused)
 559 {
 560   g_assert (a != NULL && b != NULL);
 561
 562   return (gtk_recent_info_get_modified (a) > gtk_recent_info_get_modified (b));
 563 }
 564
 565 /* our proxy sorting function */
 566 static gint
 567 sort_recent_items_proxy (gpointer *a,
 568                          gpointer *b,
 569                          gpointer  user_data)
 570 {
 571   GtkRecentInfo *info_a = (GtkRecentInfo *) a;
 572   GtkRecentInfo *info_b = (GtkRecentInfo *) b;
 573   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (user_data);
 574
 575   if (menu->priv->sort_func)
 576     return (* menu->priv->sort_func) (info_a,
 577                                       info_b,
 578                                       menu->priv->sort_data);
 579
 580   /* fallback */
 581   return 0;
 582 }
 583
 584 static void
 585 chooser_set_sort_type (GtkRecentChooserMenu *menu,
 586                        GtkRecentSortType     sort_type)
 587 {
 588   if (menu->priv->sort_type == sort_type)
 589     return;
 590
 591   menu->priv->sort_type = sort_type;
 592 }
 593
 594
 595 static GList *
 596 gtk_recent_chooser_menu_get_items (GtkRecentChooser *chooser)
 597 {
 598   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (chooser);
 599   GtkRecentChooserMenuPrivate *priv;
 600   gint limit;
 601   GtkRecentSortType sort_type;
 602   GList *items;
 603   GCompareDataFunc compare_func;
 604   gint length;
 605
 606   priv = menu->priv;
 607
 608   if (!priv->manager)
 609     return NULL;
 610
 611   limit = gtk_recent_chooser_get_limit (chooser);
 612   sort_type = gtk_recent_chooser_get_sort_type (chooser);
 613
 614   switch (sort_type)
 615     {
 616     case GTK_RECENT_SORT_NONE:
 617       compare_func = NULL;
 618       break;
 619     case GTK_RECENT_SORT_MRU:
 620       compare_func = (GCompareDataFunc) sort_recent_items_mru;
 621       break;
 622     case GTK_RECENT_SORT_LRU:
 623       compare_func = (GCompareDataFunc) sort_recent_items_lru;
 624       break;
 625     case GTK_RECENT_SORT_CUSTOM:
 626       compare_func = (GCompareDataFunc) sort_recent_items_proxy;
 627       break;
 628     default:
 629       g_assert_not_reached ();
 630       break;
 631     }
 632
 633   items = gtk_recent_manager_get_items (priv->manager);
 634   if (!items)
 635     return NULL;
 636
 637   if (compare_func)
 638     items = g_list_sort_with_data (items, compare_func, menu);
 639
 640   length = g_list_length (items);
 641   if ((limit != -1) && (length > limit))
 642     {
 643       GList *clamp, *l;
 644
 645       clamp = g_list_nth (items, limit - 1);
 646
 647       l = clamp->next;
 648       clamp->next = NULL;
 649
 650       g_list_foreach (l, (GFunc) gtk_recent_info_unref, NULL);
 651       g_list_free (l);
 652     }
 653
 654   return items;
 655 }
 656
 657 static GtkRecentManager *
 658 gtk_recent_chooser_menu_get_recent_manager (GtkRecentChooser *chooser)
 659 {
 660   GtkRecentChooserMenuPrivate *priv;
 661
 662   priv = GTK_RECENT_CHOOSER_MENU (chooser)->priv;
 663
 664   return priv->manager;
 665 }
 666
 667 static void
 668 gtk_recent_chooser_menu_add_filter (GtkRecentChooser *chooser,
 669                                     GtkRecentFilter  *filter)
 670 {
 671   g_warning (_("This function is not implemented for "
 672                "widgets of class '%s'"),
 673              g_type_name (G_OBJECT_TYPE (chooser)));
 674 }
 675
 676 static void
 677 gtk_recent_chooser_menu_remove_filter (GtkRecentChooser *chooser,
 678                                        GtkRecentFilter  *filter)
 679 {
 680   g_warning (_("This function is not implemented for "
 681                "widgets of class '%s'"),
 682              g_type_name (G_OBJECT_TYPE (chooser)));
 683 }
 684
 685 static GSList *
 686 gtk_recent_chooser_menu_list_filters (GtkRecentChooser  *chooser)
 687 {
 688   g_warning (_("This function is not implemented for "
 689                "widgets of class '%s'"),
 690              g_type_name (G_OBJECT_TYPE (chooser)));
 691
 692   return NULL;
 693 }
 694
 695 static void
 696 gtk_recent_chooser_menu_set_current_filter (GtkRecentChooserMenu *menu,
 697                                             GtkRecentFilter      *filter)
 698 {
 699   GtkRecentChooserMenuPrivate *priv;
 700
 701   priv = menu->priv;
 702
 703   if (priv->current_filter)
 704     g_object_unref (G_OBJECT (priv->current_filter));
 705
 706   priv->current_filter = filter;
 707   g_object_ref_sink (priv->current_filter);
 708
 709   g_object_notify (G_OBJECT (menu), "filter");
 710 }
 711
 712 static gboolean
 713 get_is_recent_filtered (GtkRecentChooserMenu *menu,
 714                         GtkRecentInfo        *info)
 715 {
 716   GtkRecentChooserMenuPrivate *priv;
 717   GtkRecentFilter *current_filter;
 718   GtkRecentFilterInfo filter_info;
 719   GtkRecentFilterFlags needed;
 720   gboolean retval;
 721
 722   g_assert (info != NULL);
 723
 724   priv = menu->priv;
 725
 726   if (!priv->current_filter)
 727     return FALSE;
 728
 729   current_filter = priv->current_filter;
 730   needed = gtk_recent_filter_get_needed (current_filter);
 731
 732   filter_info.contains = GTK_RECENT_FILTER_URI | GTK_RECENT_FILTER_MIME_TYPE;
 733
 734   filter_info.uri = gtk_recent_info_get_uri (info);
 735   filter_info.mime_type = gtk_recent_info_get_mime_type (info);
 736
 737   if (needed & GTK_RECENT_FILTER_DISPLAY_NAME)
 738     {
 739       filter_info.display_name = gtk_recent_info_get_display_name (info);
 740       filter_info.contains |= GTK_RECENT_FILTER_DISPLAY_NAME;
 741     }
 742   else
 743     filter_info.uri = NULL;
 744
 745   if (needed & GTK_RECENT_FILTER_APPLICATION)
 746     {
 747       filter_info.applications = (const gchar **) gtk_recent_info_get_applications (info, NULL);
 748       filter_info.contains |= GTK_RECENT_FILTER_APPLICATION;
 749     }
 750   else
 751     filter_info.applications = NULL;
 752
 753   if (needed & GTK_RECENT_FILTER_GROUP)
 754     {
 755       filter_info.groups = (const gchar **) gtk_recent_info_get_groups (info, NULL);
 756       filter_info.contains |= GTK_RECENT_FILTER_GROUP;
 757     }
 758   else
 759     filter_info.groups = NULL;
 760
 761   if (needed & GTK_RECENT_FILTER_AGE)
 762     {
 763       filter_info.age = gtk_recent_info_get_age (info);
 764       filter_info.contains |= GTK_RECENT_FILTER_AGE;
 765     }
 766   else
 767     filter_info.age = -1;
 768
 769   retval = gtk_recent_filter_filter (current_filter, &filter_info);
 770
 771   /* this we own */
 772   if (filter_info.applications)
 773     g_strfreev ((gchar **) filter_info.applications);
 774   if (filter_info.groups)
 775     g_strfreev ((gchar **) filter_info.groups);
 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 typedef struct
 943 {
 944   GList *items;
 945   gint n_items;
 946   gint loaded_items;
 947   GtkRecentChooserMenu *menu;
 948 } MenuPopulateData;
 949
 950 static gboolean
 951 idle_populate_func (gpointer data)
 952 {
 953   MenuPopulateData *pdata;
 954   GtkRecentChooserMenuPrivate *priv;
 955   GtkRecentInfo *info;
 956   gboolean retval;
 957   GtkWidget *item;
 958
 959   GDK_THREADS_ENTER ();
 960
 961   pdata = (MenuPopulateData *) data;
 962
 963   if (!pdata->items)
 964     {
 965       pdata->items = gtk_recent_chooser_get_items (GTK_RECENT_CHOOSER (pdata->menu));
 966       if (!pdata->items)
 967         {
 968           item = gtk_menu_item_new_with_label (_("No items found"));
 969           gtk_widget_set_sensitive (item, FALSE);
 970
 971           /* we also mark this item, so that it gets removed when rebuilding
 972            * the menu on the next map event
 973            */
 974           g_object_set_data (G_OBJECT (item), "gtk-recent-menu-mark",
 975                              GINT_TO_POINTER (1));
 976
 977           gtk_menu_shell_prepend (GTK_MENU_SHELL (pdata->menu), item);
 978           gtk_widget_show (item);
 979
 980           /* no items: add a placeholder menu */
 981           GDK_THREADS_LEAVE ();
 982
 983           return FALSE;
 984         }
 985
 986       /* reverse the list */
 987       pdata->items = g_list_reverse (pdata->items);
 988
 989       pdata->n_items = g_list_length (pdata->items);
 990       pdata->loaded_items = 0;
 991     }
 992
 993   info = g_list_nth_data (pdata->items, pdata->loaded_items);
 994   priv = pdata->menu->priv;
 995
 996   /* skip non-local items on request */
 997   if (priv->local_only && !gtk_recent_info_is_local (info))
 998     goto check_and_return;
 999
1000   /* skip private items on request */
1001   if (!priv->show_private && gtk_recent_info_get_private_hint (info))
1002     goto check_and_return;
1003
1004   /* skip non-existing items on request */
1005   if (!priv->show_not_found && !gtk_recent_info_exists (info))
1006     goto check_and_return;
1007
1008   /* filter items based on the currently set filter object */
1009   if (get_is_recent_filtered (pdata->menu, info))
1010     goto check_and_return;
1011
1012   item = gtk_recent_chooser_menu_create_item (pdata->menu,
1013                                               info,
1014                                               pdata->loaded_items);
1015   if (!item)
1016     goto check_and_return;
1017
1018   gtk_recent_chooser_menu_add_tip (pdata->menu, info, item);
1019
1020   /* FIXME
1021    *
1022    * We should really place our items taking into account user
1023    * defined menu items; this would also remove the need of
1024    * reverting the scan order.
1025    */
1026   gtk_menu_shell_prepend (GTK_MENU_SHELL (pdata->menu), item);
1027   gtk_widget_show (item);
1028
1029   /* mark the menu item as one of our own */
1030   g_object_set_data (G_OBJECT (item), "gtk-recent-menu-mark",
1031                      GINT_TO_POINTER (1));
1032
1033   /* attach the RecentInfo object to the menu item, and own a reference
1034    * to it, so that it will be destroyed with the menu item when it's
1035    * not needed anymore.
1036    */
1037   g_object_set_data_full (G_OBJECT (item), "gtk-recent-info",
1038                           gtk_recent_info_ref (info),
1039                           (GDestroyNotify) gtk_recent_info_unref);
1040
1041 check_and_return:
1042   pdata->loaded_items += 1;
1043
1044   if (pdata->loaded_items == pdata->n_items)
1045     {
1046       g_list_foreach (pdata->items, (GFunc) gtk_recent_info_unref, NULL);
1047       g_list_free (pdata->items);
1048
1049       retval = FALSE;
1050     }
1051   else
1052     retval = TRUE;
1053
1054   GDK_THREADS_LEAVE ();
1055
1056   return retval;
1057 }
1058
1059 static void
1060 idle_populate_clean_up (gpointer data)
1061 {
1062   MenuPopulateData *pdata = data;
1063
1064   pdata->menu->priv->populate_id = 0;
1065
1066   g_slice_free (MenuPopulateData, pdata);
1067 }
1068
1069 static void
1070 gtk_recent_chooser_menu_populate (GtkRecentChooserMenu *menu)
1071 {
1072   MenuPopulateData *pdata;
1073
1074   if (menu->priv->populate_id)
1075     return;
1076
1077   pdata = g_slice_new (MenuPopulateData);
1078   pdata->items = NULL;
1079   pdata->n_items = 0;
1080   pdata->loaded_items = 0;
1081   pdata->menu = menu;
1082
1083   menu->priv->icon_size = get_icon_size_for_widget (GTK_WIDGET (menu));
1084
1085   /* dispose our menu items first */
1086   gtk_recent_chooser_menu_dispose_items (menu);
1087
1088   menu->priv->populate_id = g_idle_add_full (G_PRIORITY_HIGH_IDLE + 30,
1089                                              idle_populate_func,
1090                                              pdata,
1091                                              idle_populate_clean_up);
1092 }
1093
1094 /* bounce activate signal from the recent menu item widget
1095  * to the recent menu widget
1096  */
1097 static void
1098 item_activate_cb (GtkWidget *widget,
1099                   gpointer   user_data)
1100 {
1101   GtkRecentChooser *chooser = GTK_RECENT_CHOOSER (user_data);
1102
1103   _gtk_recent_chooser_item_activated (chooser);
1104 }
1105
1106 /* we force a redraw if the manager changes when we are showing */
1107 static void
1108 manager_changed_cb (GtkRecentManager *manager,
1109                     gpointer          user_data)
1110 {
1111   GtkRecentChooserMenu *menu = GTK_RECENT_CHOOSER_MENU (user_data);
1112
1113   gtk_recent_chooser_menu_populate (menu);
1114 }
1115
1116 static void
1117 set_recent_manager (GtkRecentChooserMenu *menu,
1118                     GtkRecentManager     *manager)
1119 {
1120   if (menu->priv->manager)
1121     {
1122       g_signal_handler_disconnect (menu, menu->priv->manager_changed_id);
1123       menu->priv->manager = NULL;
1124     }
1125
1126   if (manager)
1127     menu->priv->manager = manager;
1128   else
1129     menu->priv->manager = gtk_recent_manager_get_default ();
1130
1131   if (menu->priv->manager)
1132     menu->priv->manager_changed_id = g_signal_connect (menu->priv->manager, "changed",
1133                                                        G_CALLBACK (manager_changed_cb),
1134                                                        menu);
1135   /* (re)populate the menu */
1136   gtk_recent_chooser_menu_populate (menu);
1137 }
1138
1139 static gint
1140 get_icon_size_for_widget (GtkWidget *widget)
1141 {
1142   GtkSettings *settings;
1143   gint width, height;
1144
1145   if (gtk_widget_has_screen (widget))
1146     settings = gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
1147   else
1148     settings = gtk_settings_get_default ();
1149
1150   if (gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
1151                                          &width, &height))
1152     return MAX (width, height);
1153
1154   return FALLBACK_ICON_SIZE;
1155 }
1156
1157 static void
1158 gtk_recent_chooser_menu_set_show_tips (GtkRecentChooserMenu *menu,
1159                                        gboolean              show_tips)
1160 {
1161   if (menu->priv->show_tips == show_tips)
1162     return;
1163
1164   g_assert (menu->priv->tooltips != NULL);
1165
1166   if (show_tips)
1167     gtk_tooltips_enable (menu->priv->tooltips);
1168   else
1169     gtk_tooltips_disable (menu->priv->tooltips);
1170
1171   menu->priv->show_tips = show_tips;
1172 }
1173
1174 /*
1175  * Public API
1176  */
1177
1178 /**
1179  * gtk_recent_chooser_menu_new:
1180  *
1181  * Creates a new #GtkRecentChooserMenu widget.
1182  *
1183  * This kind of widget shows the list of recently used resources as
1184  * a menu, each item as a menu item.  Each item inside the menu might
1185  * have an icon, representing its MIME type, and a number, for mnemonic
1186  * access.
1187  *
1188  * This widget implements the #GtkRecentChooser interface.
1189  *
1190  * This widget creates its own #GtkRecentManager object.  See the
1191  * gtk_recent_chooser_menu_new_for_manager() function to know how to create
1192  * a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object.
1193  *
1194  * Return value: a new #GtkRecentChooserMenu
1195  *
1196  * Since: 2.10
1197  */
1198 GtkWidget *
1199 gtk_recent_chooser_menu_new (void)
1200 {
1201   return g_object_new (GTK_TYPE_RECENT_CHOOSER_MENU,
1202                        "recent-manager", NULL,
1203                        NULL);
1204 }
1205
1206 /**
1207  * gtk_recent_chooser_menu_new_for_manager:
1208  * @manager: a #GtkRecentManager
1209  *
1210  * Creates a new #GtkRecentChooserMenu widget using @manager as
1211  * the underlying recently used resources manager.
1212  *
1213  * This is useful if you have implemented your own recent manager,
1214  * or if you have a customized instance of a #GtkRecentManager
1215  * object or if you wish to share a common #GtkRecentManager object
1216  * among multiple #GtkRecentChooser widgets.
1217  *
1218  * Return value: a new #GtkRecentChooserMenu, bound to @manager.
1219  *
1220  * Since: 2.10
1221  */
1222 GtkWidget *
1223 gtk_recent_chooser_menu_new_for_manager (GtkRecentManager *manager)
1224 {
1225   g_return_val_if_fail (manager == NULL || GTK_IS_RECENT_MANAGER (manager), NULL);
1226
1227   return g_object_new (GTK_TYPE_RECENT_CHOOSER_MENU,
1228                        "recent-manager", manager,
1229                        NULL);
1230 }
1231
1232 /**
1233  * gtk_recent_chooser_menu_get_show_numbers:
1234  * @menu: a #GtkRecentChooserMenu
1235  *
1236  * Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
1237  *
1238  * Return value: %TRUE if numbers should be shown.
1239  *
1240  * Since: 2.10
1241  */
1242 gboolean
1243 gtk_recent_chooser_menu_get_show_numbers (GtkRecentChooserMenu *menu)
1244 {
1245   g_return_val_if_fail (GTK_IS_RECENT_CHOOSER_MENU (menu), FALSE);
1246
1247   return menu->priv->show_numbers;
1248 }
1249
1250 /**
1251  * gtk_recent_chooser_menu_set_show_numbers:
1252  * @menu: a #GtkRecentChooserMenu
1253  * @show_numbers: whether to show numbers
1254  *
1255  * Sets whether a number should be added to the items of @menu.  The
1256  * numbers are shown to provide a unique character for a mnemonic to
1257  * be used inside the menu item's label.  Only the first the items
1258  * get a number to avoid clashes.
1259  *
1260  * Since: 2.10
1261  */
1262 void
1263 gtk_recent_chooser_menu_set_show_numbers (GtkRecentChooserMenu *menu,
1264                                           gboolean              show_numbers)
1265 {
1266   g_return_if_fail (GTK_IS_RECENT_CHOOSER_MENU (menu));
1267
1268   if (menu->priv->show_numbers == show_numbers)
1269     return;
1270
1271   menu->priv->show_numbers = show_numbers;
1272   g_object_notify (G_OBJECT (menu), "show-numbers");
1273 }
1274
1275 #define __GTK_RECENT_CHOOSER_MENU_C__
1276 #include "gtkaliasdef.c"