PsppireSelector: new properties: "source-widget" and "dest-widget".

[pspp-builds.git] / src / ui / gui / psppire-selector.c

diff --git a/src/ui/gui/psppire-selector.c b/src/ui/gui/psppire-selector.c
index a041fd5a05cae1ef23356a206f563f2a4961fc6e..8e0be3a3590b37015877e4b7ebb452c006f6e900 100644 (file)
--- a/src/ui/gui/psppire-selector.c
+++ b/src/ui/gui/psppire-selector.c
@@ -1,10 +1,9 @@
-/*
-   PSPPIRE --- A Graphical User Interface for PSPP
-   Copyright (C) 2007  Free Software Foundation
+/* PSPPIRE - a graphical user interface for PSPP.
+   Copyright (C) 2007, 2009 Free Software Foundation

 
 

-   This program is free software; you can redistribute it and/or modify
+   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
    it under the terms of the GNU General Public License as published by

-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,


@@ -13,9 +12,7 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    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., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */

 
 /*
   This module provides a widget, PsppireSelector derived from
 
 /*
   This module provides a widget, PsppireSelector derived from


@@ -115,20 +112,50 @@ psppire_selector_get_type (void)
   return psppire_selector_type;
 }
 
   return psppire_selector_type;
 }
 

+static GObjectClass * parent_class = NULL;

 
 static void
 
 static void

-psppire_selector_finalize (GObject *object)
+psppire_selector_finalize (GObject *obj)

 {
 {

+   /* Chain up to the parent class */
+   G_OBJECT_CLASS (parent_class)->finalize (obj);

 }
 
 }
 

+
+static void
+psppire_selector_dispose (GObject *obj)
+{
+  PsppireSelector *sel = PSPPIRE_SELECTOR (obj);
+
+  if (sel->dispose_has_run)
+    return;
+
+  /* Make sure dispose does not run twice. */
+  sel->dispose_has_run = TRUE;
+
+  g_object_unref (sel->dest);
+  g_object_unref (sel->source);
+
+  /* Chain up to the parent class */
+  G_OBJECT_CLASS (parent_class)->dispose (obj);
+}
+
+

 /* Properties */
 enum
 {
   PROP_0,
 /* Properties */
 enum
 {
   PROP_0,

-  PROP_ORIENTATION
+  PROP_ORIENTATION,
+  PROP_SOURCE_WIDGET,
+  PROP_DEST_WIDGET

 };
 
 
 };
 
 

+static void on_activate (PsppireSelector *selector, gpointer data);
+
+static void update_subjects (PsppireSelector *selector);
+
+

 static void
 psppire_selector_set_property (GObject         *object,
                               guint            prop_id,
 static void
 psppire_selector_set_property (GObject         *object,
                               guint            prop_id,


@@ -143,6 +170,14 @@ psppire_selector_set_property (GObject         *object,
       selector->orientation = g_value_get_enum (value);
       set_direction (selector, selector->direction);
       break;
       selector->orientation = g_value_get_enum (value);
       set_direction (selector, selector->direction);
       break;

+    case PROP_SOURCE_WIDGET:
+      selector->source = g_value_dup_object (value);
+      update_subjects (selector);
+      break;
+    case PROP_DEST_WIDGET:
+      selector->dest = g_value_dup_object (value);
+      update_subjects (selector);
+      break;

     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;


@@ -163,6 +198,12 @@ psppire_selector_get_property (GObject         *object,
     case PROP_ORIENTATION:
       g_value_set_enum (value, selector->orientation);
       break;
     case PROP_ORIENTATION:
       g_value_set_enum (value, selector->orientation);
       break;

+    case PROP_SOURCE_WIDGET:
+      g_value_take_object (value, selector->source);
+      break;
+    case PROP_DEST_WIDGET:
+      g_value_take_object (value, selector->dest);
+      break;

     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;


@@ -179,10 +220,24 @@ psppire_selector_class_init (PsppireSelectorClass *class)
     g_param_spec_enum ("orientation",
                       "Orientation",
                       "Where the selector is relative to its subjects",
     g_param_spec_enum ("orientation",
                       "Orientation",
                       "Where the selector is relative to its subjects",

-                      G_TYPE_PSPPIRE_SELECTOR_ORIENTATION,
+                      PSPPIRE_TYPE_SELECTOR_ORIENTATION,

                       PSPPIRE_SELECT_SOURCE_BEFORE_DEST /* default value */,
                       G_PARAM_CONSTRUCT_ONLY |G_PARAM_READWRITE);
 
                       PSPPIRE_SELECT_SOURCE_BEFORE_DEST /* default value */,
                       G_PARAM_CONSTRUCT_ONLY |G_PARAM_READWRITE);
 

+  GParamSpec *source_widget_spec = 
+    g_param_spec_object ("source-widget",
+                        "Source Widget",
+                        "The widget to be used as the source for this selector",
+                        GTK_TYPE_WIDGET,
+                        G_PARAM_READWRITE);
+
+  GParamSpec *dest_widget_spec = 
+    g_param_spec_object ("dest-widget",
+                        "Destination Widget",
+                        "The widget to be used as the destination for this selector",
+                        GTK_TYPE_WIDGET,
+                        G_PARAM_READWRITE);
+

 
   object_class->set_property = psppire_selector_set_property;
   object_class->get_property = psppire_selector_get_property;
 
   object_class->set_property = psppire_selector_set_property;
   object_class->get_property = psppire_selector_get_property;


@@ -191,6 +246,16 @@ psppire_selector_class_init (PsppireSelectorClass *class)
                                    PROP_ORIENTATION,
                                    orientation_spec);
 
                                    PROP_ORIENTATION,
                                    orientation_spec);
 

+  g_object_class_install_property (object_class,
+                                   PROP_SOURCE_WIDGET,
+                                   source_widget_spec);
+
+  g_object_class_install_property (object_class,
+                                   PROP_DEST_WIDGET,
+                                   dest_widget_spec);
+
+  parent_class = g_type_class_peek_parent (class);
+

   signals [SELECTED] =
     g_signal_new ("selected",
                  G_TYPE_FROM_CLASS (class),
   signals [SELECTED] =
     g_signal_new ("selected",
                  G_TYPE_FROM_CLASS (class),


@@ -219,6 +284,7 @@ psppire_selector_base_init (PsppireSelectorClass *class)
   GObjectClass *object_class = G_OBJECT_CLASS (class);
 
   object_class->finalize = psppire_selector_finalize;
   GObjectClass *object_class = G_OBJECT_CLASS (class);
 
   object_class->finalize = psppire_selector_finalize;

+  object_class->dispose = psppire_selector_dispose;

 
   class->source_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
 }
 
   class->source_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
 }


@@ -233,17 +299,28 @@ psppire_selector_base_finalize(PsppireSelectorClass *class,
 }
 
 
 }
 
 

+

 static void
 psppire_selector_init (PsppireSelector *selector)
 {
   selector->arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
   selector->filtered_source = NULL;
 
 static void
 psppire_selector_init (PsppireSelector *selector)
 {
   selector->arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
   selector->filtered_source = NULL;
 

+  selector->action = gtk_action_new ("select", NULL, NULL, "pspp-stock-select");
+
+  gtk_action_connect_proxy (selector->action, GTK_WIDGET (selector));
+

   gtk_container_add (GTK_CONTAINER (selector), selector->arrow);
 
   gtk_widget_show (selector->arrow);
 
   gtk_container_add (GTK_CONTAINER (selector), selector->arrow);
 
   gtk_widget_show (selector->arrow);
 

+  g_signal_connect_swapped (selector->action, "activate", G_CALLBACK (on_activate), selector);
+

   selector->selecting = FALSE;
   selector->selecting = FALSE;

+
+  selector->source = NULL;
+  selector->dest = NULL;
+  selector->dispose_has_run = FALSE;

 }
 
 
 }
 
 


@@ -314,9 +391,14 @@ on_source_select (GtkTreeSelection *treeselection, gpointer data)
 
   set_direction (selector, PSPPIRE_SELECTOR_SOURCE_TO_DEST);
 
 
   set_direction (selector, PSPPIRE_SELECTOR_SOURCE_TO_DEST);
 

-  if ( GTK_IS_ENTRY (selector->dest) )
+  if ( selector->allow_selection )
+    {
+      gtk_action_set_sensitive (selector->action,
+                               selector->allow_selection (selector->source, selector->dest));
+    }
+  else if ( GTK_IS_ENTRY (selector->dest) )

     {
     {

-      gtk_widget_set_sensitive (GTK_WIDGET (selector),
+      gtk_action_set_sensitive (selector->action,

                                gtk_tree_selection_count_selected_rows
                                (treeselection) <= 1 );
     }
                                gtk_tree_selection_count_selected_rows
                                (treeselection) <= 1 );
     }


@@ -328,6 +410,8 @@ on_dest_treeview_select (GtkTreeSelection *treeselection, gpointer data)
 {
   PsppireSelector *selector = data;
 
 {
   PsppireSelector *selector = data;
 

+  gtk_tree_selection_unselect_all (gtk_tree_view_get_selection (GTK_TREE_VIEW (selector->source)));
+

   set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
 }
 
   set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
 }
 


@@ -451,7 +535,9 @@ select_selection (PsppireSelector *selector)
 
       selector->select_items (child_iter,
                              selector->dest,
 
       selector->select_items (child_iter,
                              selector->dest,

-                             childmodel);
+                             childmodel,
+                             selector->select_user_data
+                             );

     }
 
   g_list_foreach (selected_rows, (GFunc) gtk_tree_path_free, NULL);
     }
 
   g_list_foreach (selected_rows, (GFunc) gtk_tree_path_free, NULL);


@@ -473,12 +559,14 @@ on_row_activate (GtkTreeView       *tree_view,
 {
   PsppireSelector *selector  = data;
 
 {
   PsppireSelector *selector  = data;
 

-  select_selection (selector);
+  gtk_action_activate (selector->action);

 }
 
 }
 

-/* Callback for when the selector button is clicked */
+/* Callback for when the selector button is clicked,
+   or other event which causes the selector's action to occur.
+ */

 static void
 static void

-on_click (PsppireSelector *selector, gpointer data)
+on_activate (PsppireSelector *selector, gpointer data)

 {
   switch (selector->direction)
     {
 {
   switch (selector->direction)
     {


@@ -533,10 +621,21 @@ is_item_in_dest (GtkTreeModel *model, GtkTreeIter *iter,
 
   do
     {
 
   do
     {

+      int x;

       GValue value = {0};
       GValue value = {0};

+      GValue int_value = {0};

       gtk_tree_model_get_value (dest_model, &dest_iter, 0, &value);
 
       gtk_tree_model_get_value (dest_model, &dest_iter, 0, &value);
 

-      if ( g_value_get_int (&value) == index)
+      g_value_init (&int_value, G_TYPE_INT);
+
+      g_value_transform (&value, &int_value);
+
+      x = g_value_get_int (&int_value);
+
+      g_value_unset (&int_value);
+      g_value_unset (&value);
+
+      if ( x == index )

        return TRUE;
     }
   while (gtk_tree_model_iter_next (dest_model, &dest_iter));
        return TRUE;
     }
   while (gtk_tree_model_iter_next (dest_model, &dest_iter));


@@ -653,7 +752,17 @@ on_dest_data_delete (GtkTreeModel *tree_model,
 }
 
 
 }
 
 

+static void
+xxx (PsppireSelector *selector)
+{
+  GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
+
+  g_signal_connect (model, "row-changed", G_CALLBACK (on_dest_data_change),
+                   selector);

 
 

+  g_signal_connect (model, "row-deleted", G_CALLBACK (on_dest_data_delete),
+                   selector);
+}

 
 /* Set the destination widget to DEST */
 static void
 
 /* Set the destination widget to DEST */
 static void


@@ -661,28 +770,28 @@ set_tree_view_dest (PsppireSelector *selector,
                    GtkTreeView *dest)
 {
   GtkTreeSelection* selection = gtk_tree_view_get_selection (dest);
                    GtkTreeView *dest)
 {
   GtkTreeSelection* selection = gtk_tree_view_get_selection (dest);

-  GtkTreeModel *model = gtk_tree_view_get_model (dest);
+

 
   gtk_tree_selection_set_mode (selection, GTK_SELECTION_MULTIPLE);
 
   g_signal_connect (selection, "changed", G_CALLBACK (on_dest_treeview_select),
                    selector);
 
 
   gtk_tree_selection_set_mode (selection, GTK_SELECTION_MULTIPLE);
 
   g_signal_connect (selection, "changed", G_CALLBACK (on_dest_treeview_select),
                    selector);
 

-  g_signal_connect (model, "row-changed", G_CALLBACK (on_dest_data_change),
-                     selector);

 
 

-  g_signal_connect (model, "row-deleted", G_CALLBACK (on_dest_data_delete),
-                     selector);
+  g_signal_connect_swapped (dest, "notify::model",
+                           G_CALLBACK (xxx), selector);

 
 }
 
 
 }
 

-/* Callback for when the DEST GtkEntry is activated (Enter is pressed) */
-static void
-on_entry_activate (GtkEntry *w, gpointer data)
+/* Callback which causes the filter to be refiltered.
+   Called when the DEST GtkEntry is activated (Enter is pressed), or when it
+   looses focus.
+*/
+static gboolean
+refilter (PsppireSelector *selector)

 {
 {

-  PsppireSelector * selector = data;
-

   gtk_tree_model_filter_refilter (selector->filtered_source);
   gtk_tree_model_filter_refilter (selector->filtered_source);

+  return FALSE;

 }
 
 /* Callback for when the DEST GtkEntry is selected (clicked) */
 }
 
 /* Callback for when the DEST GtkEntry is selected (clicked) */


@@ -691,74 +800,138 @@ on_entry_dest_select (GtkWidget *widget, GdkEventFocus *event, gpointer data)
 {
   PsppireSelector * selector = data;
 
 {
   PsppireSelector * selector = data;
 

+  gtk_tree_selection_unselect_all (gtk_tree_view_get_selection (GTK_TREE_VIEW (selector->source)));

   set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
 
   return FALSE;
 }
 
   set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
 
   return FALSE;
 }
 

+
+
+/* Callback for when an item disappears from the source list.
+   By implication, this means that the item has been inserted into the
+   destination.
+ */
+static void
+on_row_deleted (PsppireSelector *selector)
+{
+  g_signal_emit (selector, signals [SELECTED], 0);
+}
+
+/* Callback for when a new item appears in the source list.
+   By implication, this means that an item has been deleted from the
+   destination.
+ */
+static void
+on_row_inserted (PsppireSelector *selector)
+{
+  g_signal_emit (selector, signals [DE_SELECTED], 0);
+}
+
+
+

 /* Set DEST to be the destination GtkEntry widget */
 static void
 set_entry_dest (PsppireSelector *selector,
                GtkEntry *dest)
 {
 /* Set DEST to be the destination GtkEntry widget */
 static void
 set_entry_dest (PsppireSelector *selector,
                GtkEntry *dest)
 {

-  g_signal_connect (dest, "activate", G_CALLBACK (on_entry_activate),
+  g_signal_connect_swapped (dest, "activate", G_CALLBACK (refilter),
+                   selector);
+
+  g_signal_connect_swapped (dest, "changed", G_CALLBACK (refilter),

                    selector);
 
   g_signal_connect (dest, "focus-in-event", G_CALLBACK (on_entry_dest_select),
                    selector);
                    selector);
 
   g_signal_connect (dest, "focus-in-event", G_CALLBACK (on_entry_dest_select),
                    selector);

-}

 
 

+  g_signal_connect_swapped (dest, "focus-out-event", G_CALLBACK (refilter),
+                   selector);

 
 

-/* Set SOURCE and DEST for this selector, and
-   set SELECT_FUNC and FILTER_FUNC */
-void
-psppire_selector_set_subjects (PsppireSelector *selector,
-                              GtkWidget *source,
-                              GtkWidget *dest,
-                              SelectItemsFunc *select_func,
-                              FilterItemsFunc *filter_func )
+
+  g_signal_connect_swapped (selector->filtered_source, "row-deleted",
+                   G_CALLBACK (on_row_deleted), selector);
+
+  g_signal_connect_swapped (selector->filtered_source, "row-inserted",
+                   G_CALLBACK (on_row_inserted), selector);
+}
+
+static void
+update_subjects (PsppireSelector *selector)

 {
 {

-  g_assert(selector);
+  GtkTreeModel *model = NULL;

 
 

-  selector->filter = filter_func ;
+  if ( NULL == selector->dest )
+    return;

 
 

-  selector->source = source;
-  selector->dest = dest;
+  if ( NULL == selector->source )
+    return;

 
 

-  if ( filter_func == NULL)
+  g_signal_connect_swapped (selector->source, "notify::dictionary",
+                           G_CALLBACK (update_subjects), selector);
+
+  g_signal_connect_swapped (selector->source, "notify::model",
+                           G_CALLBACK (update_subjects), selector);
+
+  model = gtk_tree_view_get_model (GTK_TREE_VIEW (selector->source));
+
+  if ( NULL == model)
+    return;
+
+
+  if ( GTK_IS_TREE_VIEW (selector->source))
+    set_tree_view_source (selector, GTK_TREE_VIEW (selector->source) );
+  else
+    g_error ("Unsupported source widget: %s", G_OBJECT_TYPE_NAME (selector->source));
+
+  if ( NULL == selector->dest)
+    ;
+  else if  ( GTK_IS_TREE_VIEW (selector->dest))

     {
     {

-      if  (GTK_IS_TREE_VIEW (dest))
-       selector->filter = is_item_in_dest;
+      set_tree_view_dest (selector, GTK_TREE_VIEW (selector->dest));

     }
 
     }
 

-  g_signal_connect (selector, "clicked", G_CALLBACK (on_click), NULL);
+  else if ( GTK_IS_ENTRY (selector->dest))
+    set_entry_dest (selector, GTK_ENTRY (selector->dest));

 
 

-  if ( GTK_IS_TREE_VIEW (source))
-    set_tree_view_source (selector, GTK_TREE_VIEW (source) );
+  else if (GTK_IS_TEXT_VIEW (selector->dest))
+    {
+      /* Nothing to be done */
+    }

   else
   else

-    g_error ("Unsupported source widget: %s", G_OBJECT_TYPE_NAME (source));
+    g_error ("Unsupported destination widget: %s", G_OBJECT_TYPE_NAME (selector->dest));

 
 

-  g_assert ( GTK_IS_TREE_MODEL_FILTER (selector->filtered_source));
+}

 
 

-  if  ( GTK_IS_TREE_VIEW (dest))
-    set_tree_view_dest (selector, GTK_TREE_VIEW (dest));

 
 

-  else if ( GTK_IS_ENTRY (dest))
-    set_entry_dest (selector, GTK_ENTRY (dest));
+/* Set SELECT_FUNC and FILTER_FUNC for this selector */
+void
+psppire_selector_set_subjects (PsppireSelector *selector,
+                              SelectItemsFunc *select_func,
+                              FilterItemsFunc *filter_func,
+                              gpointer user_data)
+{
+  selector->filter = filter_func ;
+  selector->select_user_data = user_data;

 
 

-  else if (GTK_IS_TEXT_VIEW (dest))
+  if ( filter_func == NULL)

     {
     {

-      /* Nothing to be done */
+      if  (GTK_IS_TREE_VIEW (selector->dest))
+       selector->filter = is_item_in_dest;

     }
 
     }
 

-  else
-    g_error ("Unsupported destination widget: %s", G_OBJECT_TYPE_NAME (dest));
-

   selector->select_items = select_func;
 }
 
 
 
   selector->select_items = select_func;
 }
 
 
 

+void
+psppire_selector_set_allow (PsppireSelector *selector, AllowSelectionFunc *allow)
+{
+  selector->allow_selection = allow;
+}
+
+
+

 GType
 psppire_selector_orientation_get_type (void)
 {
 GType
 psppire_selector_orientation_get_type (void)
 {