Replace "usage" property with a "description" property
[pspp-builds.git] / src / ui / gui / psppire-window.c
index 3848b897300744611007d2b22e407d94228d65d2..79149ea7adf162fa207c8074cc9c7ead09c1c347 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPPIRE - a graphical user interface for PSPP.
-   Copyright (C) 2008  Free Software Foundation
+   Copyright (C) 2009  Free Software Foundation
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -18,6 +18,7 @@
 
 #include <gtk/gtksignal.h>
 #include <gtk/gtkwindow.h>
+#include <gtk/gtkcheckmenuitem.h>
 
 #include <stdlib.h>
 
@@ -26,7 +27,7 @@
 #define N_(msgid) msgid
 
 #include "psppire-window.h"
-
+#include "psppire-window-register.h"
 
 static void psppire_window_base_finalize (PsppireWindowClass *, gpointer);
 static void psppire_window_base_init     (PsppireWindowClass *class);
@@ -34,6 +35,8 @@ static void psppire_window_class_init    (PsppireWindowClass *class);
 static void psppire_window_init          (PsppireWindow      *window);
 
 
+static PsppireWindowClass *the_class;
+static GObjectClass *parent_class;
 
 GType
 psppire_window_get_type (void)
@@ -47,7 +50,7 @@ psppire_window_get_type (void)
        sizeof (PsppireWindowClass),
        (GBaseInitFunc) psppire_window_base_init,
         (GBaseFinalizeFunc) psppire_window_base_finalize,
-       (GClassInitFunc)psppire_window_class_init,
+       (GClassInitFunc) psppire_window_class_init,
        (GClassFinalizeFunc) NULL,
        NULL,
         sizeof (PsppireWindow),
@@ -68,7 +71,8 @@ psppire_window_get_type (void)
 enum
 {
   PROP_0,
-  PROP_FILENAME
+  PROP_FILENAME,
+  PROP_DESCRIPTION
 };
 
 
@@ -78,6 +82,20 @@ uniquify (const gchar *str, int *x)
   return g_strdup_printf ("%s%d", str, (*x)++);
 }
 
+static gchar mdash[6] = {0,0,0,0,0,0};
+
+static void
+psppire_window_set_title (PsppireWindow *window)
+{
+  gchar *title =
+    g_strdup_printf ( _("%s %s PSPPIRE %s"),
+                     window->basename, mdash, window->description);
+
+  gtk_window_set_title (GTK_WINDOW (window), title);
+
+  free (title);
+}
+
 static void
 psppire_window_set_property (GObject         *object,
                             guint            prop_id,
@@ -86,39 +104,52 @@ psppire_window_set_property (GObject         *object,
 {
   PsppireWindow *window = PSPPIRE_WINDOW (object);
 
-  PsppireWindowClass *class = PSPPIRE_WINDOW_CLASS (G_OBJECT_GET_CLASS (object));
-  
   switch (prop_id)
     {
+    case PROP_DESCRIPTION:
+      window->description = g_value_dup_string (value);
+      psppire_window_set_title (window);
+      break;
     case PROP_FILENAME:
       {
-       gchar mdash[6] = {0,0,0,0,0,0};
-       gchar *basename, *title;
-       const gchar *name = g_value_get_string (value);
-       gchar *candidate_name = strdup (name);
-       int x = 0;
+       PsppireWindowRegister *reg = psppire_window_register_new ();
 
-       while ( g_hash_table_lookup (class->name_table, candidate_name))
-         {
-           free (candidate_name);
-           candidate_name = uniquify (name, &x);
-         }
+       gchar *candidate_name ;
 
-       basename = g_path_get_basename (candidate_name);
-       g_unichar_to_utf8 (0x2014, mdash);
+       {
+         const gchar *name = g_value_get_string (value);
+         int x = 0;
+         GValue def = {0};
+         g_value_init (&def, pspec->value_type);
 
-       title = g_strdup_printf ( _("%s %s PSPPIRE Syntax Editor"), basename, mdash);
+         if ( NULL == name)
+           {
+             g_param_value_set_default (pspec, &def);
+             name = g_value_get_string (&def);
+           }
 
-       gtk_window_set_title (GTK_WINDOW (window), title);
+         candidate_name = strdup (name);
 
-       free (window->name);
-       window->name = candidate_name;
+         while ( psppire_window_register_lookup (reg, candidate_name))
+           {
+             free (candidate_name);
+             candidate_name = uniquify (name, &x);
+           }
 
+         window->basename = g_path_get_basename (candidate_name);
 
-       g_hash_table_insert (class->name_table, window->name, window);
+         g_value_unset (&def);
+       }
 
-       free (basename);
-       free (title);
+       psppire_window_set_title (window);
+
+       if ( window->name)
+         psppire_window_register_remove (reg, window->name);
+
+       free (window->name);
+       window->name = candidate_name;
+
+       psppire_window_register_insert (reg, window, window->name);
       }
       break;
     default:
@@ -141,6 +172,9 @@ psppire_window_get_property (GObject         *object,
     case PROP_FILENAME:
       g_value_set_string (value, window->name);
       break;
+    case PROP_DESCRIPTION:
+      g_value_set_string (value, window->description);
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -153,51 +187,60 @@ static void
 psppire_window_finalize (GObject *object)
 {
   PsppireWindow *window = PSPPIRE_WINDOW (object);
-  PsppireWindowClass *class = PSPPIRE_WINDOW_CLASS (G_OBJECT_GET_CLASS (object));
 
-  GtkWindowClass *parent_class = g_type_class_peek_parent (class);
+  PsppireWindowRegister *reg = psppire_window_register_new ();
 
-  if ( window->finalized )
-    return;
+  psppire_window_register_remove (reg, window->name);
+  free (window->name);
+  free (window->description);
 
-  window->finalized = TRUE;
+  g_signal_handler_disconnect (psppire_window_register_new (),
+                              window->remove_handler);
 
-  g_debug ("%s %p", __FUNCTION__, object);
+  g_signal_handler_disconnect (psppire_window_register_new (),
+                              window->insert_handler);
 
-  g_hash_table_remove (class->name_table, window->name);
-  free (window->name);
+  g_hash_table_destroy (window->menuitem_table);
 
   if (G_OBJECT_CLASS (parent_class)->finalize)
-     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
+    G_OBJECT_CLASS (parent_class)->finalize (object);
 }
 
 
 static void
 psppire_window_class_init (PsppireWindowClass *class)
 {
- GObjectClass *object_class = G_OBJECT_CLASS (class);
+  GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+  GParamSpec *description_spec =
+    g_param_spec_string ("description",
+                      "Description",
+                      "A string describing the usage of the window",
+                        "??????", /*Should be overridden by derived classes */
+                      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+
   GParamSpec *filename_spec =
     g_param_spec_string ("filename",
                       "File name",
                       "The name of the file associated with this window, if any",
                         "Untitled",
-                        G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT
-                        );
+                        G_PARAM_CONSTRUCT | G_PARAM_READWRITE);
 
+  g_unichar_to_utf8 (0x2014, mdash);
 
   object_class->set_property = psppire_window_set_property;
   object_class->get_property = psppire_window_get_property;
 
+  g_object_class_install_property (object_class,
+                                   PROP_DESCRIPTION,
+                                   description_spec);
+
   g_object_class_install_property (object_class,
                                    PROP_FILENAME,
                                    filename_spec);
 
-
-
-  class->name_table = g_hash_table_new (g_str_hash, g_str_equal);
-
-  g_hash_table_insert (class->name_table, "Untitled", NULL);
+  the_class = class;
+  parent_class = g_type_class_peek_parent (class);
 }
 
 
@@ -207,7 +250,6 @@ psppire_window_base_init (PsppireWindowClass *class)
   GObjectClass *object_class = G_OBJECT_CLASS (class);
 
   object_class->finalize = psppire_window_finalize;
-  
 }
 
 
@@ -216,23 +258,118 @@ static void
 psppire_window_base_finalize (PsppireWindowClass *class,
                                gpointer class_data)
 {
-  g_hash_table_destroy (class->name_table);
+}
+
+static void
+menu_toggled (GtkCheckMenuItem *mi, gpointer data)
+{
+  /* Prohibit changes to the state */
+  mi->active = !mi->active;
 }
 
 
+/* Look up the window associated with this menuitem and present it to the user */
+static void
+menu_activate (GtkMenuItem *mi, gpointer data)
+{
+  const gchar *key = data;
+
+  PsppireWindowRegister *reg = psppire_window_register_new ();
+
+  PsppireWindow *window = psppire_window_register_lookup (reg, key);
+
+  gtk_window_present (GTK_WINDOW (window));
+}
+
+static void
+insert_menuitem_into_menu (PsppireWindow *window, gpointer key)
+{
+  GtkWidget *item = gtk_check_menu_item_new_with_label (key);
+
+  g_signal_connect (item, "toggled", G_CALLBACK (menu_toggled), NULL);
+  g_signal_connect (item, "activate", G_CALLBACK (menu_activate), key);
+
+  gtk_widget_show (item);
+  
+  gtk_menu_shell_append (window->menu, item);
+
+  /* Set the state without emitting a signal */
+  GTK_CHECK_MENU_ITEM (item)->active =
+   (psppire_window_register_lookup (psppire_window_register_new (), key) == window);
+
+  g_hash_table_insert (window->menuitem_table, key, item);
+}
+
+static void
+insert_item (gpointer key, gpointer value, gpointer data)
+{
+  PsppireWindow *window = PSPPIRE_WINDOW (data);
+
+  if ( NULL != g_hash_table_lookup (window->menuitem_table, key))
+    return;
+
+  insert_menuitem_into_menu (window, key);
+}
+
+/* Insert a new item into the window menu */
+static void
+insert_menuitem (GObject *reg, const gchar *key, gpointer data)
+{
+  PsppireWindow *window = PSPPIRE_WINDOW (data);
+  
+  insert_menuitem_into_menu (window, (gpointer) key);
+}
+
+
+static void
+remove_menuitem (PsppireWindowRegister *reg, const gchar *key, gpointer data)
+{
+  PsppireWindow *window = PSPPIRE_WINDOW (data);
+  GtkWidget *item ;
+
+  item = g_hash_table_lookup (window->menuitem_table, key);
+
+  g_hash_table_remove (window->menuitem_table, key);
+
+  if (GTK_IS_CONTAINER (window->menu))
+    gtk_container_remove (GTK_CONTAINER (window->menu), item);
+}
+
+static void
+insert_existing_items (PsppireWindow *window)
+{
+  psppire_window_register_foreach (psppire_window_register_new (), insert_item, window);
+}
 
 static void
 psppire_window_init (PsppireWindow *window)
 {
   window->name = NULL;
-  window->finalized = FALSE;
+  window->menu = NULL;
+
+  window->menuitem_table  = g_hash_table_new (g_str_hash, g_str_equal);
+
+
+  g_signal_connect (window,  "realize", G_CALLBACK (insert_existing_items), NULL);
+
+  window->insert_handler = g_signal_connect (psppire_window_register_new (),
+                                            "inserted",
+                                            G_CALLBACK (insert_menuitem),
+                                            window);
+
+  window->remove_handler = g_signal_connect (psppire_window_register_new (),
+                                            "removed",
+                                            G_CALLBACK (remove_menuitem),
+                                            window);
 }
 
 
 GtkWidget*
 psppire_window_new (void)
 {
-  return GTK_WIDGET (g_object_new (psppire_window_get_type (), "type", GTK_WINDOW_TOPLEVEL, NULL));
+  return GTK_WIDGET (g_object_new (psppire_window_get_type (),
+                                  "type", GTK_WINDOW_TOPLEVEL,
+                                  NULL));
 }
 
 
@@ -240,7 +377,7 @@ const gchar *
 psppire_window_get_filename (PsppireWindow *w)
 {
   const gchar *name = NULL;
-  g_object_get (w, "filename", name, NULL);
+  g_object_get (w, "filename", &name, NULL);
   return name;
 }
 
@@ -251,3 +388,20 @@ psppire_window_set_filename (PsppireWindow *w, const gchar *filename)
   g_object_set (w, "filename", filename, NULL);
 }
 
+\f
+
+
+static void
+minimise_window (gpointer key, gpointer value, gpointer data)
+{
+  gtk_window_iconify (GTK_WINDOW (value));
+}
+
+
+void
+psppire_window_minimise_all (void)
+{
+  PsppireWindowRegister *reg = psppire_window_register_new ();
+
+  g_hash_table_foreach (reg->name_table, minimise_window, NULL);
+}