GNOME.org
 

[gtk+/places-sidebar] Add a GtkTrashMonitor private API

commit ee261203cbf1de122b43d8672c6c52c91b4abcd6
Author: Federico Mena Quintero <federico gnome org>
Date:   Thu Jan 10 14:36:27 2013 -0600

    Add a GtkTrashMonitor private API
    
    This is analogous to NautilusTrashMonitor in that it just monitors trash:///
    and is able to return the appropriate icon for the trash's current state.
    
    Later we may want to move this utility object into GIO or something.
    
    Signed-off-by: Federico Mena Quintero <federico gnome org>

 gtk/Makefile.am       |    2 +
 gtk/gtktrashmonitor.c |  271 +++++++++++++++++++++++++++++++++++++++++++++++++
 gtk/gtktrashmonitor.h |   48 +++++++++
 3 files changed, 321 insertions(+), 0 deletions(-)
---
diff --git a/gtk/Makefile.am b/gtk/Makefile.am
index 939ffa5..1104664 100644
--- a/gtk/Makefile.am
+++ b/gtk/Makefile.am
@@ -539,6 +539,7 @@ gtk_private_h_sources =		\
 	gtktextutil.h		\
 	gtkthemingbackgroundprivate.h \
 	gtkthemingengineprivate.h \
+	gtktrashmonitor.h	\
 	gtktoolpaletteprivate.h	\
 	gtktreedatalist.h	\
 	gtktreeprivate.h	\
@@ -853,6 +854,7 @@ gtk_base_c_sources = 		\
 	gtktoolpalette.c	\
 	gtktoolshell.c		\
 	gtktooltip.c		\
+	gtktrashmonitor.c	\
 	gtktreedatalist.c	\
 	gtktreednd.c		\
 	gtktreemenu.c		\
diff --git a/gtk/gtktrashmonitor.c b/gtk/gtktrashmonitor.c
new file mode 100644
index 0000000..ef22a8d
--- /dev/null
+++ b/gtk/gtktrashmonitor.c
@@ -0,0 +1,271 @@
+/* GTK - The GIMP Toolkit
+ * gtktrashmonitor.h: Monitor the trash:/// folder to see if there is trash or not
+ * Copyright (C) 2011 Suse
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Authors: Federico Mena Quintero <federico gnome org>
+ */
+
+#include "config.h"
+
+#include "gtkintl.h"
+#include "gtkmarshalers.h"
+#include "gtktrashmonitor.h"
+
+struct _GtkTrashMonitor
+{
+  GObject parent;
+
+  GFileMonitor *file_monitor;
+  gulong file_monitor_changed_id;
+  
+  GIcon *icon;
+
+  guint has_trash : 1;
+};
+
+struct _GtkTrashMonitorClass
+{
+  GObjectClass parent_class;
+
+  void (* trash_state_changed) (GtkTrashMonitor *monitor);
+};
+
+enum {
+  TRASH_STATE_CHANGED,
+  LAST_SIGNAL
+};
+
+static guint signals[LAST_SIGNAL];
+
+G_DEFINE_TYPE (GtkTrashMonitor, _gtk_trash_monitor, G_TYPE_OBJECT)
+
+static GtkTrashMonitor *the_trash_monitor;
+
+#define ICON_NAME_TRASH_EMPTY "user-trash-symbolic"
+#define ICON_NAME_TRASH_FULL  "user-trash-full-symbolic"
+
+static void
+gtk_trash_monitor_dispose (GObject *object)
+{
+  GtkTrashMonitor *monitor;
+
+  monitor = GTK_TRASH_MONITOR (object);
+
+  if (monitor->file_monitor)
+    {
+      g_signal_handler_disconnect (monitor->file_monitor, monitor->file_monitor_changed_id);
+      monitor->file_monitor_changed_id = 0;
+
+      g_clear_object (&monitor->file_monitor);
+    }
+
+  g_clear_object (&monitor->icon);
+
+  G_OBJECT_CLASS (_gtk_trash_monitor_parent_class)->dispose (object);
+}
+
+static void
+_gtk_trash_monitor_class_init (GtkTrashMonitorClass *class)
+{
+  GObjectClass *gobject_class;
+
+  gobject_class = (GObjectClass *) class;
+
+  gobject_class->dispose = gtk_trash_monitor_dispose;
+
+  signals[TRASH_STATE_CHANGED] =
+    g_signal_new (I_("trash-state-changed"),
+		  G_OBJECT_CLASS_TYPE (gobject_class),
+		  G_SIGNAL_RUN_FIRST,
+		  G_STRUCT_OFFSET (GtkTrashMonitorClass, trash_state_changed),
+		  NULL, NULL,
+		  _gtk_marshal_VOID__VOID,
+		  G_TYPE_NONE, 0);
+}
+
+/* Updates the internal has_trash flag and emits the "trash-state-changed" signal */
+static void
+update_has_trash_and_notify (GtkTrashMonitor *monitor,
+			     gboolean has_trash)
+{
+  monitor->has_trash = !!has_trash;
+
+  g_signal_emit (monitor, signals[TRASH_STATE_CHANGED], 0); 
+}
+
+static void
+trash_enumerate_next_files_cb (GObject *source,
+			       GAsyncResult *result,
+			       gpointer user_data)
+{
+  GtkTrashMonitor *monitor = GTK_TRASH_MONITOR (user_data);
+  GFileEnumerator *enumerator;
+  GList *infos;
+
+  enumerator = G_FILE_ENUMERATOR (source);
+
+  infos = g_file_enumerator_next_files_finish (enumerator, result, NULL);
+  if (infos)
+    {
+      update_has_trash_and_notify (monitor, TRUE);
+      g_list_free_full (infos, g_object_unref);
+    }
+  else
+    {
+      update_has_trash_and_notify (monitor, FALSE);
+    }
+
+  g_object_unref (monitor); /* was reffed in recompute_trash_state() */
+}
+
+/* Callback used from g_file_enumerate_children_async() - this is what enumerates "trash:///" */
+static void
+trash_enumerate_children_cb (GObject *source,
+			     GAsyncResult *result,
+			     gpointer user_data)
+{
+  GtkTrashMonitor *monitor = GTK_TRASH_MONITOR (user_data);
+  GFileEnumerator *enumerator;
+
+  enumerator = g_file_enumerate_children_finish (G_FILE (source), result, NULL);
+  if (enumerator)
+    {
+      g_file_enumerator_next_files_async (enumerator,
+					  1,
+					  G_PRIORITY_DEFAULT,
+					  NULL,
+					  trash_enumerate_next_files_cb,
+					  monitor);
+      g_object_unref (enumerator);
+    }
+  else
+    {
+      update_has_trash_and_notify (monitor, FALSE);
+      g_object_unref (monitor); /* was reffed in recompute_trash_state() */
+    }
+}
+
+/* Asynchronously recomputes whether there is trash or not */
+static void
+recompute_trash_state (GtkTrashMonitor *monitor)
+{
+  GFile *file;
+
+  g_object_ref (monitor);
+
+  file = g_file_new_for_uri ("trash:///");
+  g_file_enumerate_children_async (file,
+				   G_FILE_ATTRIBUTE_STANDARD_TYPE,
+				   G_FILE_QUERY_INFO_NONE,
+				   G_PRIORITY_DEFAULT,
+				   NULL,
+				   trash_enumerate_children_cb,
+				   monitor);
+
+  g_object_unref (file);
+}
+
+/* Callback used when the "trash:///" file monitor changes; we just recompute the trash state
+ * whenever something happens.
+ */
+static void
+file_monitor_changed_cb (GFileMonitor	   *file_monitor,
+			 GFile		   *child,
+			 GFile		   *other_file,
+			 GFileMonitorEvent  event_type,
+			 GtkTrashMonitor   *monitor)
+{
+  recompute_trash_state (monitor);
+}
+
+static void
+_gtk_trash_monitor_init (GtkTrashMonitor *monitor)
+{
+  GFile *file;
+
+  file = g_file_new_for_uri ("trash:///");
+
+  monitor->file_monitor = g_file_monitor_file (file, G_FILE_MONITOR_NONE, NULL, NULL);
+
+  g_object_unref (file);
+
+  if (monitor->file_monitor)
+    monitor->file_monitor_changed_id = g_signal_connect (monitor->file_monitor, "changed",
+							 G_CALLBACK (file_monitor_changed_cb), monitor);
+
+  recompute_trash_state (monitor);
+}
+
+/**
+ * _gtk_trash_monitor_get:
+ *
+ * Return value: (transfer full): a new reference to the singleton
+ * #GtkTrashMonitor object.  Be sure to call g_object_unref() on it when you are
+ * done with the trash monitor.
+ */
+GtkTrashMonitor *
+_gtk_trash_monitor_get (void)
+{
+  if (the_trash_monitor != NULL)
+    {
+      g_object_ref (the_trash_monitor);
+    }
+  else
+    {
+      the_trash_monitor = g_object_new (GTK_TYPE_TRASH_MONITOR, NULL);
+      g_object_add_weak_pointer (G_OBJECT (the_trash_monitor), (gpointer *) &the_trash_monitor);
+    }
+
+  return the_trash_monitor;
+}
+
+/**
+ * _gtk_trash_monitor_get_icon:
+ * @monitor: a #GtkTrashMonitor
+ *
+ * Return value: (transfer full): the #GIcon that should be used to represent
+ * the state of the trash folder on screen, based on whether there is trash or
+ * not.
+ */
+GIcon *
+_gtk_trash_monitor_get_icon (GtkTrashMonitor *monitor)
+{
+  const char *icon_name;
+
+  g_return_val_if_fail (GTK_IS_TRASH_MONITOR (monitor), NULL);
+
+  if (monitor->has_trash)
+    icon_name = ICON_NAME_TRASH_FULL;
+  else
+    icon_name = ICON_NAME_TRASH_EMPTY;
+
+  return g_themed_icon_new (icon_name);
+}
+
+/**
+ * _gtk_trash_monitor_get_has_trash:
+ * @monitor: a #GtkTrashMonitor
+ *
+ * Return value: #TRUE if there is trash in the trash:/// folder, or #FALSE otherwise.
+ */
+gboolean
+_gtk_trash_monitor_get_has_trash (GtkTrashMonitor *monitor)
+{
+  g_return_val_if_fail (GTK_IS_TRASH_MONITOR (monitor), FALSE);
+
+  return monitor->has_trash;
+}
diff --git a/gtk/gtktrashmonitor.h b/gtk/gtktrashmonitor.h
new file mode 100644
index 0000000..f458b2b
--- /dev/null
+++ b/gtk/gtktrashmonitor.h
@@ -0,0 +1,48 @@
+/* GTK - The GIMP Toolkit
+ * gtktrashmonitor.h: Monitor the trash:/// folder to see if there is trash or not
+ * Copyright (C) 2011 Suse
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Authors: Federico Mena Quintero <federico gnome org>
+ */
+
+#ifndef __GTK_TRASH_MONITOR_H__
+#define __GTK_TRASH_MONITOR_H__
+
+#include <gio/gio.h>
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_TRASH_MONITOR			(_gtk_trash_monitor_get_type ())
+#define GTK_TRASH_MONITOR(obj)			(G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TRASH_MONITOR, GtkTrashMonitor))
+#define GTK_TRASH_MONITOR_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TRASH_MONITOR, GtkTrashMonitorClass))
+#define GTK_IS_TRASH_MONITOR(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TRASH_MONITOR))
+#define GTK_IS_TRASH_MONITOR_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TRASH_MONITOR))
+#define GTK_TRASH_MONITOR_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TRASH_MONITOR, GtkTrashMonitorClass))
+
+typedef struct _GtkTrashMonitor GtkTrashMonitor;
+typedef struct _GtkTrashMonitorClass GtkTrashMonitorClass;
+
+GType _gtk_trash_monitor_get_type (void);
+GtkTrashMonitor *_gtk_trash_monitor_get (void);
+
+GIcon *_gtk_trash_monitor_get_icon (GtkTrashMonitor *monitor);
+
+gboolean _gtk_trash_monitor_get_has_trash (GtkTrashMonitor *monitor);
+
+G_END_DECLS
+
+#endif /* __GTK_TRASH_MONITOR_H__ */
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]