A model-view separation for menus and toolbars, using the EggMenu code by

2003-08-24  Matthias Clasen  <maclas@gmx.de>

	* gtk/gtkaction.[ch]:
	* gtk/gtktoggleaction.[ch]:
	* gtk/gtktoggleactionprivate.h:
	* gtk/gtkradioaction.[ch]:
	* gtk/gtkactiongroup.[ch]:
	* gtk/gtkmenumerge.[ch]: A model-view separation for menus and
	toolbars, using the EggMenu code by James Henstridge.

	* gtk/gtk.h: Include new headers.
	* gtk/Makefile.am: Add new files.

	* tests/testactions.c: Test for actions.
	* tests/testmerge.c: Test for menu merging.
	* tests/merge-[123].ui: Test data for testmerge.
	* tests/Makefile.am: Add testactions and testmerge.

	* demos/gtk-demo/appwindow.c: Use GtkMenuMerge to construct the
	menubar and toolbar.

1 files changed, 356 insertions, 0 deletions

diff --git a/gtk/gtkactiongroup.c b/gtk/gtkactiongroup.c
new file mode 100644
index 0000000000..69122755ef
--- /dev/null
+++ b/gtk/gtkactiongroup.c
@@ -0,0 +1,356 @@
+/*
+ * GTK - The GIMP Toolkit
+ * Copyright (C) 1998, 1999 Red Hat, Inc.
+ * All rights reserved.
+ *
+ * This Library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This Library 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with the Gnome Library; see the file COPYING.LIB.  If not,
+ * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+/*
+ * Author: James Henstridge <james@daa.com.au>
+ *
+ * Modified by the GTK+ Team and others 2003.  See the AUTHORS
+ * file for a list of people on the GTK+ Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
+ */
+
+#include <config.h>
+
+#include "gtkactiongroup.h"
+#include "gtktoggleaction.h"
+#include "gtkradioaction.h"
+#include "gtkaccelmap.h"
+#include "gtkintl.h"
+
+#define GTK_ACTION_GROUP_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_ACTION_GROUP, GtkActionGroupPrivate))
+
+struct _GtkActionGroupPrivate 
+{
+  gchar      *name;
+  GHashTable *actions;
+};
+
+static void gtk_action_group_init       (GtkActionGroup *self);
+static void gtk_action_group_class_init (GtkActionGroupClass *class);
+
+GType
+gtk_action_group_get_type (void)
+{
+  static GType type = 0;
+
+  if (!type)
+    {
+      static const GTypeInfo type_info =
+      {
+        sizeof (GtkActionGroupClass),
+	NULL,           /* base_init */
+        NULL,           /* base_finalize */
+        (GClassInitFunc) gtk_action_group_class_init,
+        NULL,           /* class_finalize */
+        NULL,           /* class_data */
+        sizeof (GtkActionGroup),
+        0, /* n_preallocs */
+        (GInstanceInitFunc) gtk_action_group_init,
+      };
+
+      type = g_type_register_static (G_TYPE_OBJECT, "GtkActionGroup",
+				     &type_info, 0);
+    }
+
+  return type;
+}
+
+static GObjectClass *parent_class = NULL;
+static void       gtk_action_group_finalize        (GObject        *object);
+static GtkAction *gtk_action_group_real_get_action (GtkActionGroup *self,
+						    const gchar    *name);
+
+static void
+gtk_action_group_class_init (GtkActionGroupClass *klass)
+{
+  GObjectClass *gobject_class;
+
+  gobject_class = G_OBJECT_CLASS (klass);
+  parent_class = g_type_class_peek_parent (klass);
+
+  gobject_class->finalize = gtk_action_group_finalize;
+  klass->get_action = gtk_action_group_real_get_action;
+
+  g_type_class_add_private (gobject_class, sizeof (GtkActionGroupPrivate));
+}
+
+static void
+gtk_action_group_init (GtkActionGroup *self)
+{
+  self->private_data = GTK_ACTION_GROUP_GET_PRIVATE (self);
+  self->private_data->name = NULL;
+  self->private_data->actions = g_hash_table_new_full (g_str_hash, g_str_equal,
+						       (GDestroyNotify) g_free,
+						       (GDestroyNotify) g_object_unref);
+}
+
+/**
+ * gtk_action_group_new:
+ * @name: the name of the action group
+ *
+ * Creates a new #GtkActionGroup object.
+ *
+ * Returns: the new #GtkActionGroup
+ *
+ * Since: 2.4
+ */
+GtkActionGroup *
+gtk_action_group_new (const gchar *name)
+{
+  GtkActionGroup *self;
+
+  self = g_object_new (GTK_TYPE_ACTION_GROUP, NULL);
+  self->private_data->name = g_strdup (name);
+
+  return self;
+}
+
+static void
+gtk_action_group_finalize (GObject *object)
+{
+  GtkActionGroup *self;
+
+  self = GTK_ACTION_GROUP (object);
+
+  g_free (self->private_data->name);
+  self->private_data->name = NULL;
+
+  g_hash_table_destroy (self->private_data->actions);
+  self->private_data->actions = NULL;
+
+  if (parent_class->finalize)
+    (* parent_class->finalize) (object);
+}
+
+static GtkAction *
+gtk_action_group_real_get_action (GtkActionGroup *self,
+				  const gchar    *action_name)
+{
+  return g_hash_table_lookup (self->private_data->actions, action_name);
+}
+
+/**
+ * gtk_action_group_get_name:
+ * @action_group: the action group
+ *
+ * Gets the name of the action group.
+ *
+ * Returns: the name of the action group.
+ * 
+ * Since: 2.4
+ */
+const gchar *
+gtk_action_group_get_name (GtkActionGroup *action_group)
+{
+  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
+
+  return action_group->private_data->name;
+}
+
+/**
+ * gtk_action_group_get_action:
+ * @action_group: the action group
+ * @action_name: the name of the action
+ *
+ * Looks up an action in the action group by name.
+ *
+ * Returns: the action, or %NULL if no action by that name exists
+ *
+ * Since: 2.4
+ */
+GtkAction *
+gtk_action_group_get_action (GtkActionGroup *action_group,
+			     const gchar    *action_name)
+{
+  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
+  g_return_val_if_fail (GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action != NULL, NULL);
+
+  return (* GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action)
+    (action_group, action_name);
+}
+
+/**
+ * gtk_action_group_add_action:
+ * @action_group: the action group
+ * @action: an action
+ *
+ * Adds an action object to the action group.
+ *
+ * Since: 2.4
+ */
+void
+gtk_action_group_add_action (GtkActionGroup *action_group,
+			     GtkAction      *action)
+{
+  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
+  g_return_if_fail (GTK_IS_ACTION (action));
+  g_return_if_fail (gtk_action_get_name (action) != NULL);
+
+  g_hash_table_insert (action_group->private_data->actions, 
+		       g_strdup (gtk_action_get_name (action)),
+                       g_object_ref (action));
+}
+
+/**
+ * gtk_action_group_removes_action:
+ * @action_group: the action group
+ * @action: an action
+ *
+ * Removes an action object from the action group.
+ *
+ * Since: 2.4
+ */
+void
+gtk_action_group_remove_action (GtkActionGroup *action_group,
+				GtkAction      *action)
+{
+  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
+  g_return_if_fail (GTK_IS_ACTION (action));
+  g_return_if_fail (gtk_action_get_name (action) != NULL);
+
+  /* extra protection to make sure action->name is valid */
+  g_object_ref (action);
+  g_hash_table_remove (action_group->private_data->actions, gtk_action_get_name (action));
+  g_object_unref (action);
+}
+
+static void
+add_single_action (gpointer key, 
+		   gpointer value, 
+		   gpointer user_data)
+{
+  GList **list = user_data;
+
+  *list = g_list_prepend (*list, value);
+}
+
+/**
+ * gtk_action_group_list_actions:
+ * @action_group: the action group
+ *
+ * Lists the actions in the action group.
+ *
+ * Returns: an allocated list of the action objects in the action group
+ * 
+ * Since: 2.4
+ */
+GList *
+gtk_action_group_list_actions (GtkActionGroup *action_group)
+{
+  GList *actions = NULL;
+  
+  g_hash_table_foreach (action_group->private_data->actions, add_single_action, &actions);
+
+  return g_list_reverse (actions);
+}
+
+
+/**
+ * gtk_action_group_add_actions:
+ * @action_group: the action group
+ * @entries: an array of action descriptions
+ * @n_entries: the number of entries
+ *
+ * This is a convenience routine to create a number of actions and add
+ * them to the action group.  Each member of the array describes an
+ * action to create.
+ * 
+ * Since: 2.4
+ */
+void
+gtk_action_group_add_actions (GtkActionGroup      *action_group,
+			      GtkActionGroupEntry *entries,
+			      guint                n_entries)
+{
+  guint i;
+
+  for (i = 0; i < n_entries; i++)
+    {
+      GtkAction *action;
+      GType action_type;
+      gchar *accel_path;
+
+      switch (entries[i].entry_type) {
+      case NORMAL_ACTION:
+	action_type = GTK_TYPE_ACTION;
+	break;
+      case TOGGLE_ACTION:
+	action_type = GTK_TYPE_TOGGLE_ACTION;
+	break;
+      case RADIO_ACTION:
+	action_type = GTK_TYPE_RADIO_ACTION;
+	break;
+      default:
+	g_warning ("unsupported action type");
+	action_type = GTK_TYPE_ACTION;
+      }
+
+      action = g_object_new (action_type,
+			     "name", entries[i].name,
+			     "label", _(entries[i].label),
+			     "tooltip", _(entries[i].tooltip),
+			     "stock_id", entries[i].stock_id,
+			     NULL);
+
+      if (entries[i].entry_type == RADIO_ACTION &&
+	  entries[i].extra_data != NULL)
+	{
+	  GtkAction *radio_action;
+	  GSList *group;
+
+	  radio_action =
+	    gtk_action_group_get_action (GTK_ACTION_GROUP (action_group),
+					 entries[i].extra_data);
+	  if (radio_action)
+	    {
+	      group = gtk_radio_action_get_group (GTK_RADIO_ACTION (radio_action));
+	      gtk_radio_action_set_group (GTK_RADIO_ACTION (action), group);
+	    }
+	  else
+	    g_warning (G_STRLOC " could not look up `%s'", entries[i].extra_data);
+	}
+
+      if (entries[i].callback)
+	g_signal_connect (action, "activate",
+			  entries[i].callback, entries[i].user_data);
+
+      /* set the accel path for the menu item */
+      accel_path = g_strconcat ("<Actions>/", action_group->private_data->name, "/",
+				entries[i].name, NULL);
+      if (entries[i].accelerator)
+	{
+	  guint accel_key = 0;
+	  GdkModifierType accel_mods;
+
+	  gtk_accelerator_parse (entries[i].accelerator, &accel_key,
+				 &accel_mods);
+	  if (accel_key)
+	    gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
+	}
+
+      gtk_action_set_accel_path (action, accel_path);
+      g_free (accel_path);
+
+      gtk_action_group_add_action (action_group, action);
+      g_object_unref (action);
+    }
+}