* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
*/
+/**
+ * SECTION:gtkrecentmanager
+ * @Title: GtkRecentManager
+ * @short_description: Managing recently used files
+ * @See_Also: #GBookmarkFile, #GtkSettings, #GtkRecentChooser
+ *
+ * #GtkRecentManager provides a facility for adding, removing and
+ * looking up recently used files. Each recently used file is
+ * identified by its URI, and has meta-data associated to it, like
+ * the names and command lines of the applications that have
+ * registered it, the number of time each application has registered
+ * the same file, the mime type of the file and whether the file
+ * should be displayed only by the applications that have
+ * registered it.
+ *
+ * <note><para>The recently used files list is per user.</para></note>
+ *
+ * The #GtkRecentManager acts like a database of all the recently
+ * used files. You can create new #GtkRecentManager objects, but
+ * it is more efficient to use the default manager created by GTK+.
+ *
+ * Adding a new recently used file is as simple as:
+ *
+ * |[
+ * GtkRecentManager *manager;
+ *
+ * manager = gtk_recent_manager_get_default ();
+ * gtk_recent_manager_add_item (manager, file_uri);
+ * ]|
+ *
+ * The #GtkRecentManager will try to gather all the needed information
+ * from the file itself through GIO.
+ *
+ * Looking up the meta-data associated with a recently used file
+ * given its URI requires calling gtk_recent_manager_lookup_item():
+ *
+ * |[
+ * GtkRecentManager *manager;
+ * GtkRecentInfo *info;
+ * GError *error = NULL;
+ *
+ * manager = gtk_recent_manager_get_default ();
+ * info = gtk_recent_manager_lookup_item (manager, file_uri, &error);
+ * if (error)
+ * {
+ * g_warning ("Could not find the file: %s", error->message);
+ * g_error_free (error);
+ * }
+ * else
+ * {
+ * /* Use the info object */
+ * gtk_recent_info_unref (info);
+ * }
+ * ]|
+ *
+ * In order to retrieve the list of recently used files, you can use
+ * gtk_recent_manager_get_items(), which returns a list of #GtkRecentInfo
+ * structures.
+ *
+ * A #GtkRecentManager is the model used to populate the contents of
+ * one, or more #GtkRecentChooser implementations.
+ *
+ * <note><para>The maximum age of the recently used files list is
+ * controllable through the #GtkSettings:gtk-recent-files-max-age
+ * property.</para></note>
+ *
+ * Recently used files are supported since GTK+ 2.10.
+ */
+
#include "config.h"
#include <sys/types.h>
#include "gtkrecentmanager.h"
#include "gtkintl.h"
+#include "gtksettings.h"
#include "gtkstock.h"
#include "gtkicontheme.h"
#include "gtktypebuiltins.h"
#include "gtkmarshalers.h"
/* the file where we store the recently used items */
-#define GTK_RECENTLY_USED_FILE ".recently-used.xbel"
+#define GTK_RECENTLY_USED_FILE "recently-used.xbel"
/* return all items by default */
#define DEFAULT_LIMIT -1
time_t stamp;
} RecentAppInfo;
+/**
+ * GtkRecentInfo:
+ *
+ * #GtkRecentInfo is an opaque data structure
+ * whose members can only be accessed using the provided API.
+ *
+ * #GtkRecentInfo constains all the meta-data
+ * associated with an entry in the recently used files list.
+ *
+ * Since: 2.10
+ */
struct _GtkRecentInfo
{
gchar *uri;
gint ref_count;
};
-#define GTK_RECENT_MANAGER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_RECENT_MANAGER, GtkRecentManagerPrivate))
-
struct _GtkRecentManagerPrivate
{
gchar *filename;
guint is_dirty : 1;
- gint limit;
gint size;
GBookmarkFile *recent_items;
GFileMonitor *monitor;
+
+ guint changed_timeout;
+ guint changed_age;
};
enum
P_("The full path to the file to be used to store and read the list"),
NULL,
(G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE)));
- /**
- * GtkRecentManager:limit
- *
- * The maximum number of items to be returned by the
- * gtk_recent_manager_get_items() function.
- *
- * Since: 2.10
- */
- g_object_class_install_property (gobject_class,
- PROP_LIMIT,
- g_param_spec_int ("limit",
- P_("Limit"),
- P_("The maximum number of items to be returned by gtk_recent_manager_get_items()"),
- -1,
- G_MAXINT,
- DEFAULT_LIMIT,
- G_PARAM_READWRITE));
+
/**
* GtkRecentManager:size
*
* @recent_manager: the recent manager
*
* Emitted when the current recently used resources manager changes its
- * contents.
+ * contents, either by calling gtk_recent_manager_add_item() or by another
+ * application.
*
* Since: 2.10
*/
{
GtkRecentManagerPrivate *priv;
- manager->priv = priv = GTK_RECENT_MANAGER_GET_PRIVATE (manager);
-
- priv->limit = DEFAULT_LIMIT;
- priv->size = 0;
+ manager->priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
+ GTK_TYPE_RECENT_MANAGER,
+ GtkRecentManagerPrivate);
+ priv = manager->priv;
+ priv->size = 0;
priv->filename = NULL;
}
{
case PROP_FILENAME:
gtk_recent_manager_set_filename (recent_manager, g_value_get_string (value));
- break;
- case PROP_LIMIT:
- gtk_recent_manager_set_limit (recent_manager, g_value_get_int (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
case PROP_FILENAME:
g_value_set_string (value, recent_manager->priv->filename);
break;
- case PROP_LIMIT:
- g_value_set_int (value, recent_manager->priv->limit);
- break;
case PROP_SIZE:
g_value_set_int (value, recent_manager->priv->size);
break;
}
static void
-gtk_recent_manager_dispose (GObject *object)
+gtk_recent_manager_finalize (GObject *object)
{
GtkRecentManager *manager = GTK_RECENT_MANAGER (object);
GtkRecentManagerPrivate *priv = manager->priv;
- if (priv->monitor)
+ g_free (priv->filename);
+
+ if (priv->recent_items != NULL)
+ g_bookmark_file_free (priv->recent_items);
+
+ G_OBJECT_CLASS (gtk_recent_manager_parent_class)->finalize (object);
+}
+
+static void
+gtk_recent_manager_dispose (GObject *gobject)
+{
+ GtkRecentManager *manager = GTK_RECENT_MANAGER (gobject);
+ GtkRecentManagerPrivate *priv = manager->priv;
+
+ if (priv->monitor != NULL)
{
g_signal_handlers_disconnect_by_func (priv->monitor,
G_CALLBACK (gtk_recent_manager_monitor_changed),
priv->monitor = NULL;
}
- G_OBJECT_CLASS (gtk_recent_manager_parent_class)->dispose (object);
-}
-
-static void
-gtk_recent_manager_finalize (GObject *object)
-{
- GtkRecentManager *manager = GTK_RECENT_MANAGER (object);
- GtkRecentManagerPrivate *priv = manager->priv;
+ if (priv->changed_timeout != 0)
+ {
+ g_source_remove (priv->changed_timeout);
+ priv->changed_timeout = 0;
+ priv->changed_age = 0;
+ }
- g_free (priv->filename);
-
- if (priv->recent_items)
- g_bookmark_file_free (priv->recent_items);
+ if (priv->is_dirty)
+ {
+ g_object_ref (manager);
+ g_signal_emit (manager, signal_changed, 0);
+ g_object_unref (manager);
+ }
- G_OBJECT_CLASS (gtk_recent_manager_parent_class)->finalize (object);
+ G_OBJECT_CLASS (gtk_recent_manager_parent_class)->dispose (gobject);
}
static void
else if (age == 0)
{
g_bookmark_file_free (priv->recent_items);
- priv->recent_items = NULL;
-
priv->recent_items = g_bookmark_file_new ();
}
}
}
}
+static gchar *
+get_default_filename (void)
+{
+ return g_build_filename (g_get_user_data_dir (),
+ GTK_RECENTLY_USED_FILE,
+ NULL);
+}
+
static void
gtk_recent_manager_set_filename (GtkRecentManager *manager,
const gchar *filename)
else
{
if (!filename || *filename == '\0')
- priv->filename = g_build_filename (g_get_home_dir (),
- GTK_RECENTLY_USED_FILE,
- NULL);
+ priv->filename = get_default_filename ();
else
priv->filename = g_strdup (filename);
}
* gtk_recent_manager_get_default:
*
* Gets a unique instance of #GtkRecentManager, that you can share
- * in your application without caring about memory management. The
- * returned instance will be freed when you application terminates.
+ * in your application without caring about memory management.
*
* Return value: (transfer none): A unique #GtkRecentManager. Do not ref or unref it.
*
return recent_manager_singleton;
}
-/**
- * gtk_recent_manager_set_limit:
- * @manager: a #GtkRecentManager
- * @limit: the maximum number of items to return, or -1.
- *
- * Sets the maximum number of item that the gtk_recent_manager_get_items()
- * function should return. If @limit is set to -1, then return all the
- * items.
- *
- * Since: 2.10
- */
-void
-gtk_recent_manager_set_limit (GtkRecentManager *manager,
- gint limit)
-{
- GtkRecentManagerPrivate *priv;
-
- g_return_if_fail (GTK_IS_RECENT_MANAGER (manager));
-
- priv = manager->priv;
- priv->limit = limit;
-}
-
-/**
- * gtk_recent_manager_get_limit:
- * @manager: a #GtkRecentManager
- *
- * Gets the maximum number of items that the gtk_recent_manager_get_items()
- * function should return.
- *
- * Return value: the number of items to return, or -1 for every item.
- *
- * Since: 2.10
- */
-gint
-gtk_recent_manager_get_limit (GtkRecentManager *manager)
-{
- GtkRecentManagerPrivate *priv;
-
- g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), DEFAULT_LIMIT);
-
- priv = manager->priv;
- return priv->limit;
-}
static void
gtk_recent_manager_add_item_query_info (GObject *source_object,
* will dump our changes
*/
priv->is_dirty = TRUE;
-
gtk_recent_manager_changed (manager);
return TRUE;
}
priv->is_dirty = TRUE;
-
gtk_recent_manager_changed (manager);
return TRUE;
* Return value: %TRUE on success.
*
* Since: 2.10
- */
+ */
gboolean
gtk_recent_manager_move_item (GtkRecentManager *recent_manager,
- const gchar *uri,
- const gchar *new_uri,
- GError **error)
+ const gchar *uri,
+ const gchar *new_uri,
+ GError **error)
{
GtkRecentManagerPrivate *priv;
GError *move_error;
- gboolean res;
-
+
g_return_val_if_fail (GTK_IS_RECENT_MANAGER (recent_manager), FALSE);
g_return_val_if_fail (uri != NULL, FALSE);
g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
-
+
priv = recent_manager->priv;
if (!priv->recent_items)
{
g_set_error (error, GTK_RECENT_MANAGER_ERROR,
- GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
- _("Unable to find an item with URI '%s'"),
- uri);
+ GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
+ _("Unable to find an item with URI '%s'"),
+ uri);
return FALSE;
}
if (!g_bookmark_file_has_item (priv->recent_items, uri))
{
g_set_error (error, GTK_RECENT_MANAGER_ERROR,
- GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
- _("Unable to find an item with URI '%s'"),
- uri);
+ GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
+ _("Unable to find an item with URI '%s'"),
+ uri);
return FALSE;
}
-
+
move_error = NULL;
- res = g_bookmark_file_move_item (priv->recent_items,
- uri, new_uri,
- &move_error);
- if (move_error)
+ if (!g_bookmark_file_move_item (priv->recent_items,
+ uri,
+ new_uri,
+ &move_error))
{
g_error_free (move_error);
g_set_error (error, GTK_RECENT_MANAGER_ERROR,
- GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
- _("Unable to find an item with URI '%s'"),
- uri);
+ GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
+ _("Unable to find an item with URI '%s'"),
+ uri);
return FALSE;
}
-
- priv->is_dirty = TRUE;
+ priv->is_dirty = TRUE;
gtk_recent_manager_changed (recent_manager);
-
+
return TRUE;
}
if (!priv->recent_items)
return NULL;
- if (priv->limit == 0)
- return NULL;
-
uris = g_bookmark_file_get_uris (priv->recent_items, &uris_len);
for (i = 0; i < uris_len; i++)
{
GtkRecentInfo *info;
- if (priv->limit != -1 && i == priv->limit)
- break;
-
info = gtk_recent_info_new (uris[i]);
build_recent_info (priv->recent_items, info);
{
GtkRecentManagerPrivate *priv = manager->priv;
- if (!priv->recent_items)
+ if (priv->recent_items == NULL)
return;
-
+
g_bookmark_file_free (priv->recent_items);
- priv->recent_items = NULL;
-
priv->recent_items = g_bookmark_file_new ();
priv->size = 0;
- priv->is_dirty = TRUE;
-
+
/* emit the changed signal, to ensure that the purge is written */
+ priv->is_dirty = TRUE;
gtk_recent_manager_changed (manager);
}
return purged;
}
+static gboolean
+emit_manager_changed (gpointer data)
+{
+ GtkRecentManager *manager = data;
+
+ manager->priv->changed_age = 0;
+ manager->priv->changed_timeout = 0;
+
+ g_signal_emit (manager, signal_changed, 0);
+
+ return FALSE;
+}
+
static void
-gtk_recent_manager_changed (GtkRecentManager *recent_manager)
+gtk_recent_manager_changed (GtkRecentManager *manager)
{
- g_signal_emit (recent_manager, signal_changed, 0);
+ /* coalesce consecutive changes
+ *
+ * we schedule a write in 250 msecs immediately; if we get more than one
+ * request per millisecond before the timeout has a chance to run, we
+ * schedule an emission immediately.
+ */
+ if (manager->priv->changed_timeout == 0)
+ manager->priv->changed_timeout = gdk_threads_add_timeout (250, emit_manager_changed, manager);
+ else
+ {
+ manager->priv->changed_age += 1;
+
+ if (manager->priv->changed_age > 250)
+ {
+ g_source_remove (manager->priv->changed_timeout);
+ g_signal_emit (manager, signal_changed, 0);
+
+ manager->priv->changed_age = 0;
+ manager->priv->changed_timeout = 0;
+ }
+ }
}
static void
* GtkRecentInfo *
*****************/
-GType
-gtk_recent_info_get_type (void)
-{
- static GType info_type = 0;
-
- if (!info_type)
- info_type = g_boxed_type_register_static (I_("GtkRecentInfo"),
- (GBoxedCopyFunc) gtk_recent_info_ref,
- (GBoxedFreeFunc) gtk_recent_info_unref);
- return info_type;
-}
+G_DEFINE_BOXED_TYPE (GtkRecentInfo, gtk_recent_info,
+ gtk_recent_info_ref,
+ gtk_recent_info_unref)
static GtkRecentInfo *
gtk_recent_info_new (const gchar *uri)
*
* Retrieves the list of applications that have registered this resource.
*
- * Return value: (array length=length zero-terminated=1): a newly allocated
- * %NULL-terminated array of strings. Use g_strfreev() to free it.
+ * Return value: (array length=length zero-terminated=1) (transfer full):
+ * a newly allocated %NULL-terminated array of strings.
+ * Use g_strfreev() to free it.
*
* Since: 2.10
*/
*
* Retrieves the icon of size @size associated to the resource MIME type.
*
- * Return value: a #GdkPixbuf containing the icon, or %NULL. Use
- * g_object_unref() when finished using the icon.
+ * Return value: (transfer full): a #GdkPixbuf containing the icon,
+ * or %NULL. Use g_object_unref() when finished using the icon.
*
* Since: 2.10
*/
{
if (info->mime_type &&
strcmp (info->mime_type, "x-directory/normal") == 0)
- retval = get_icon_fallback (GTK_STOCK_DIRECTORY, size);
+ retval = get_icon_fallback ("folder", size);
else
- retval = get_icon_fallback (GTK_STOCK_FILE, size);
+ retval = get_icon_fallback ("document-x-generic", size);
}
return retval;
}
+/**
+ * gtk_recent_info_get_gicon:
+ * @info: a #GtkRecentInfo
+ *
+ * Retrieves the icon associated to the resource MIME type.
+ *
+ * Return value: (transfer full): a #GIcon containing the icon, or %NULL. Use
+ * g_object_unref() when finished using the icon
+ *
+ * Since: 2.22
+ */
+GIcon *
+gtk_recent_info_get_gicon (GtkRecentInfo *info)
+{
+ GIcon *icon = NULL;
+ gchar *content_type;
+
+ g_return_val_if_fail (info != NULL, NULL);
+
+ if (info->mime_type != NULL &&
+ (content_type = g_content_type_from_mime_type (info->mime_type)) != NULL)
+ {
+ icon = g_content_type_get_icon (content_type);
+ g_free (content_type);
+ }
+
+ return icon;
+}
+
/**
* gtk_recent_info_is_local:
* @info: a #GtkRecentInfo
* array of returned group names will be %NULL terminated, so length might
* optionally be %NULL.
*
- * Return value: (array length=length zero-terminated=1): a newly allocated
- * %NULL terminated array of strings. Use g_strfreev() to free it.
+ * Return value: (array length=length zero-terminated=1) (transfer full):
+ * a newly allocated %NULL terminated array of strings.
+ * Use g_strfreev() to free it.
*
* Since: 2.10
*/
return FALSE;
}
+/**
+ * gtk_recent_info_create_app_info:
+ * @info: a #GtkRecentInfo
+ * @app_name: (allow-none): the name of the application that should
+ * be mapped to a #GAppInfo; if %NULL is used then the default
+ * application for the MIME type is used
+ * @error: (allow-none): return location for a #GError, or %NULL
+ *
+ * Creates a #GAppInfo for the specified #GtkRecentInfo
+ *
+ * Return value: (transfer full): the newly created #GAppInfo, or %NULL.
+ * In case of error, @error will be set either with a
+ * %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR
+ */
+GAppInfo *
+gtk_recent_info_create_app_info (GtkRecentInfo *info,
+ const gchar *app_name,
+ GError **error)
+{
+ RecentAppInfo *ai;
+ GAppInfo *app_info;
+ GError *internal_error = NULL;
+
+ g_return_val_if_fail (info != NULL, NULL);
+
+ if (app_name == NULL || *app_name == '\0')
+ {
+ char *content_type;
+
+ if (info->mime_type == NULL)
+ return NULL;
+
+ content_type = g_content_type_from_mime_type (info->mime_type);
+ if (content_type == NULL)
+ return NULL;
+
+ app_info = g_app_info_get_default_for_type (content_type, TRUE);
+ g_free (content_type);
+
+ return app_info;
+ }
+
+ ai = g_hash_table_lookup (info->apps_lookup, app_name);
+ if (ai == NULL)
+ {
+ g_set_error (error, GTK_RECENT_MANAGER_ERROR,
+ GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED,
+ _("No registered application with name '%s' for item with URI '%s' found"),
+ app_name,
+ info->uri);
+ return NULL;
+ }
+
+ internal_error = NULL;
+ app_info = g_app_info_create_from_commandline (ai->exec, ai->name,
+ G_APP_INFO_CREATE_NONE,
+ &internal_error);
+ if (internal_error != NULL)
+ {
+ g_propagate_error (error, internal_error);
+ return NULL;
+ }
+
+ return app_info;
+}
+
/*
* _gtk_recent_manager_sync:
*
projects / ~andy / gtk / blobdiff