Added custom psppire-selector 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
new file mode 100644 (file)
index 0000000..753a9dc
--- /dev/null
@@ -0,0 +1,598 @@
+/*
+   PSPPIRE --- A Graphical User Interface for PSPP
+   Copyright (C) 2007  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
+   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., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA. */
+
+/*
+  This module provides a widget, PsppireSelector derived from
+  GtkButton.
+
+  It contains a GtkArrow, and is used for selecting objects from a
+  GtkTreeView and putting them into a destination widget (often
+  another GtkTreeView).  Typically this is used in psppire for
+  selecting variables, thus:
+
+
+  +----------------------------------------------------------+
+  |                                                         |
+  |    Source Widget                       Dest Widget      |
+  |   +----------------+                        +----------------+  |
+  |   |        Variable0      |                 | Variable2      |  |
+  |   |        Variable1      |                 |                |  |
+  |   | Variable3      |                |                |  |
+  |   |                       |    Selector     |                |  |
+  |   |                       |                 |                |  |
+  |   |                       |    +------+     |                |  |
+  |   |                       |    | |\   |     |                |  |
+  |   |                       |    | | \  |     |                |  |
+  |   |                       |    | | /  |     |                |  |
+  |   |                       |    | |/   |     |                |  |
+  |   |                       |    +------+     |                |  |
+  |   |                       |                 |                |  |
+  |   |                       |                 |                |  |
+  |   |                       |                 |                |  |
+  |   |                       |                 |                |  |
+  |   +----------------+                +----------------+  |
+  |                                                         |
+  +----------------------------------------------------------+
+
+  The Source Widget is always a GtkTreeView.  The Dest Widget may be a
+  GtkTreeView or a GtkEntry (other destination widgets may be
+  supported in the future).
+
+  Widgets may be source to more than one PsppireSelector.
+*/
+
+
+#include <config.h>
+
+#include <gtk/gtksignal.h>
+#include <gtk/gtkbutton.h>
+
+#include "psppire-selector.h"
+
+#include <gtk/gtktreeview.h>
+#include <gtk/gtktreeselection.h>
+#include <gtk/gtkwidget.h>
+
+static void psppire_selector_base_finalize (PsppireSelectorClass *, gpointer);
+static void psppire_selector_base_init     (PsppireSelectorClass *class);
+static void psppire_selector_class_init    (PsppireSelectorClass *class);
+static void psppire_selector_init          (PsppireSelector      *selector);
+
+enum  {SELECTED,    /* Emitted when an item is inserted into dest */
+       DE_SELECTED, /* Emitted when an item is removed from dest */
+       n_SIGNALS};
+
+static guint signals [n_SIGNALS];
+
+
+GType
+psppire_selector_get_type (void)
+{
+  static GType psppire_selector_type = 0;
+
+  if (!psppire_selector_type)
+    {
+      static const GTypeInfo psppire_selector_info =
+      {
+       sizeof (PsppireSelectorClass),
+       (GBaseInitFunc) psppire_selector_base_init,
+        (GBaseFinalizeFunc) psppire_selector_base_finalize,
+       (GClassInitFunc)psppire_selector_class_init,
+       (GClassFinalizeFunc) NULL,
+       NULL,
+        sizeof (PsppireSelector),
+       0,
+       (GInstanceInitFunc) psppire_selector_init,
+      };
+
+      psppire_selector_type =
+       g_type_register_static (GTK_TYPE_BUTTON, "PsppireSelector",
+                               &psppire_selector_info, 0);
+    }
+
+  return psppire_selector_type;
+}
+
+
+static void
+psppire_selector_finalize (GObject *object)
+{
+}
+
+
+
+static void
+psppire_selector_class_init (PsppireSelectorClass *class)
+{
+  signals [SELECTED] =
+    g_signal_new ("selected",
+                 G_TYPE_FROM_CLASS (class),
+                 G_SIGNAL_RUN_FIRST,
+                 0,
+                 NULL, NULL,
+                 g_cclosure_marshal_VOID__VOID,
+                 G_TYPE_NONE,
+                 0);
+
+  signals [DE_SELECTED] =
+    g_signal_new ("de-selected",
+                 G_TYPE_FROM_CLASS (class),
+                 G_SIGNAL_RUN_FIRST,
+                 0,
+                 NULL, NULL,
+                 g_cclosure_marshal_VOID__VOID,
+                 G_TYPE_NONE,
+                 0);
+
+
+}
+
+
+static void
+psppire_selector_base_init (PsppireSelectorClass *class)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+  object_class->finalize = psppire_selector_finalize;
+
+  class->source_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
+}
+
+
+
+static void
+psppire_selector_base_finalize(PsppireSelectorClass *class,
+                               gpointer class_data)
+{
+  g_hash_table_destroy (class->source_hash);
+}
+
+
+static void
+psppire_selector_init (PsppireSelector *selector)
+{
+  selector->arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
+  selector->filtered_source = NULL;
+
+  gtk_container_add (GTK_CONTAINER (selector), selector->arrow);
+
+  gtk_widget_show (selector->arrow);
+
+  /* FIXME: This shouldn't be necessary, but Glade interfaces seem to
+     need it. */
+  gtk_widget_show (GTK_WIDGET (selector));
+}
+
+
+GtkWidget*
+psppire_selector_new (void)
+{
+  return GTK_WIDGET (g_object_new (psppire_selector_get_type (), NULL));
+}
+
+
+static void
+set_direction (PsppireSelector *selector, enum psppire_selector_dir d)
+{
+  selector->direction = d;
+
+  /* FIXME: Need to reverse the arrow direction if an RTL locale is in
+     effect */
+  if ( d == PSPPIRE_SELECTOR_SOURCE_TO_DEST )
+    g_object_set (selector->arrow, "arrow-type", GTK_ARROW_RIGHT, NULL);
+  else
+    g_object_set (selector->arrow, "arrow-type", GTK_ARROW_LEFT, NULL);
+}
+
+/* Callback for when the source selection changes */
+static void
+on_source_select (GtkTreeSelection *treeselection, gpointer data)
+{
+  PsppireSelector *selector = data;
+
+  set_direction (selector, PSPPIRE_SELECTOR_SOURCE_TO_DEST);
+
+  if ( GTK_IS_ENTRY (selector->dest) )
+    {
+      gtk_widget_set_sensitive (GTK_WIDGET (selector),
+                               gtk_tree_selection_count_selected_rows
+                               (treeselection) <= 1 );
+    }
+}
+
+/* Callback for when the destination treeview selection changes */
+static void
+on_dest_treeview_select (GtkTreeSelection *treeselection, gpointer data)
+{
+  PsppireSelector *selector = data;
+
+  set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
+}
+
+/* Callback for source deselection, when the dest is GtkEntry */
+static void
+de_select_selection_entry (PsppireSelector *selector)
+{
+  gtk_entry_set_text (GTK_ENTRY (selector->dest), "");
+}
+
+/* Callback for source deselection, when the dest is GtkTreeView */
+static void
+de_select_selection_tree_view (PsppireSelector *selector)
+{
+  GList *item;
+
+  GtkTreeSelection* selection =
+    gtk_tree_view_get_selection ( GTK_TREE_VIEW (selector->dest));
+
+  GtkTreeModel *model =
+    gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
+
+  GList *selected_rows =
+    gtk_tree_selection_get_selected_rows (selection, NULL);
+
+  g_return_if_fail (selector->select_items);
+
+  /* Convert paths to RowRefs */
+  for (item = g_list_first (selected_rows);
+       item != NULL;
+       item = g_list_next (item))
+    {
+      GtkTreeRowReference* rowref;
+      GtkTreePath *path  = item->data;
+
+      rowref = gtk_tree_row_reference_new (GTK_TREE_MODEL (model), path);
+
+      item->data = rowref ;
+      gtk_tree_path_free (path);
+    }
+
+  /* Remove each selected row from the dest widget */
+  for (item = g_list_first (selected_rows);
+       item != NULL;
+       item = g_list_next (item))
+    {
+      GtkTreeIter iter;
+      GtkTreeRowReference *rr = item->data;
+
+      GtkTreePath *path = gtk_tree_row_reference_get_path (rr);
+
+      gtk_tree_model_get_iter (GTK_TREE_MODEL (model), &iter, path);
+
+      gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
+
+      gtk_tree_path_free (path);
+    }
+
+  /* Delete list of RowRefs and its contents */
+  g_list_foreach (selected_rows, (GFunc) gtk_tree_row_reference_free, NULL);
+  g_list_free (selected_rows);
+}
+
+
+/* Removes something from the DEST widget */
+static void
+de_select_selection (PsppireSelector *selector)
+{
+  if ( GTK_IS_TREE_VIEW (selector->dest ) )
+    de_select_selection_tree_view (selector);
+
+  else if ( GTK_IS_ENTRY (selector->dest))
+    de_select_selection_entry (selector);
+
+  else
+    g_assert_not_reached ();
+
+  gtk_tree_model_filter_refilter (selector->filtered_source);
+
+  g_signal_emit (selector, signals [DE_SELECTED], 0);
+}
+
+
+/* Puts something into the DEST widget */
+static void
+select_selection (PsppireSelector *selector)
+{
+  GList *item ;
+  GtkTreeSelection* selection =
+    gtk_tree_view_get_selection ( GTK_TREE_VIEW (selector->source));
+
+  GList *selected_rows =
+    gtk_tree_selection_get_selected_rows (selection, NULL);
+
+  GtkTreeModel *childmodel  = gtk_tree_model_filter_get_model
+    (selector->filtered_source);
+
+  g_return_if_fail (selector->select_items);
+
+
+  for (item = g_list_first (selected_rows);
+       item != NULL;
+       item = g_list_next (item))
+    {
+      GtkTreeIter child_iter;
+      GtkTreeIter iter;
+      GtkTreePath *path  = item->data;
+
+      gtk_tree_model_get_iter (GTK_TREE_MODEL (selector->filtered_source),
+                              &iter, path);
+
+      gtk_tree_model_filter_convert_iter_to_child_iter
+       (selector->filtered_source,
+        &child_iter,
+        &iter);
+
+      selector->select_items (child_iter,
+                             selector->dest,
+                             childmodel);
+    }
+
+  g_list_foreach (selected_rows, (GFunc) gtk_tree_path_free, NULL);
+  g_list_free (selected_rows);
+
+  gtk_tree_model_filter_refilter (selector->filtered_source);
+
+  g_signal_emit (selector, signals [SELECTED], 0);
+}
+
+/* Callback fro then the source treeview is activated (double clicked) */
+static void
+on_row_activate (GtkTreeView       *tree_view,
+                GtkTreePath       *path,
+                GtkTreeViewColumn *column,
+                gpointer           data)
+{
+  PsppireSelector *selector  = data;
+
+  select_selection (selector);
+}
+
+/* Callback for when the selector button is clicked */
+static void
+on_click (PsppireSelector *selector, gpointer data)
+{
+  switch (selector->direction)
+    {
+    case PSPPIRE_SELECTOR_SOURCE_TO_DEST:
+      select_selection (selector);
+      break;
+    case PSPPIRE_SELECTOR_DEST_TO_SOURCE:
+      de_select_selection (selector);
+      break;
+    default:
+      g_assert_not_reached ();
+      break;
+    }
+}
+
+/* Default visibility filter for GtkTreeView DEST widget */
+static gboolean
+is_item_in_dest (GtkTreeModel *model, GtkTreeIter *iter,
+                PsppireSelector *selector)
+{
+  GtkTreeModel *dest_model;
+  GtkTreeIter dest_iter;
+  GtkTreeIter source_iter;
+  gint index;
+  GtkTreePath *path ;
+  GtkTreeModel *source_model;
+
+  if ( GTK_IS_TREE_MODEL_FILTER (model) )
+    {
+      source_model = gtk_tree_model_filter_get_model
+       (GTK_TREE_MODEL_FILTER (model));
+
+      gtk_tree_model_filter_convert_iter_to_child_iter
+       ( GTK_TREE_MODEL_FILTER (model),  &source_iter,  iter  );
+    }
+  else
+    {
+      source_model = model;
+      source_iter = *iter;
+    }
+
+  dest_model = gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
+
+  path = gtk_tree_model_get_path (source_model, &source_iter);
+
+  index = *gtk_tree_path_get_indices (path);
+
+  gtk_tree_path_free (path);
+
+  if ( ! gtk_tree_model_get_iter_first (dest_model, &dest_iter) )
+    return FALSE;
+
+  do
+    {
+      GValue value = {0};
+      gtk_tree_model_get_value (dest_model, &dest_iter, 0, &value);
+
+      if ( g_value_get_int (&value) == index)
+       return TRUE;
+    }
+  while (gtk_tree_model_iter_next (dest_model, &dest_iter));
+
+  return FALSE;
+}
+
+/* Visibility function for items in the SOURCE widget.
+   Returns TRUE iff *all* the selectors for which SOURCE is associated
+   are visible */
+static gboolean
+is_source_item_visible (GtkTreeModel *childmodel,
+                       GtkTreeIter *iter, gpointer data)
+{
+  PsppireSelector *selector = data;
+  PsppireSelectorClass *class = g_type_class_peek (PSPPIRE_SELECTOR_TYPE);
+
+  GList *list = NULL;
+
+  list = g_hash_table_lookup (class->source_hash, selector->source);
+
+  while (list)
+    {
+      PsppireSelector *selector = list->data;
+
+      if ( selector->filter (childmodel, iter, selector))
+         return FALSE;
+
+      list = list->next;
+    }
+
+
+  return TRUE;
+}
+
+/* set the source widget to SOURCE */
+static void
+set_tree_view_source (PsppireSelector *selector,
+                     GtkTreeView *source)
+{
+  GtkTreeSelection* selection ;
+  GList *list = NULL;
+
+  PsppireSelectorClass *class = g_type_class_peek (PSPPIRE_SELECTOR_TYPE);
+
+  if ( ! (list = g_hash_table_lookup (class->source_hash, source)))
+    {
+      selector->filtered_source =
+       GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new
+                              (gtk_tree_view_get_model (source),  NULL));
+
+      gtk_tree_view_set_model (source, NULL);
+
+      gtk_tree_view_set_model (source,
+                              GTK_TREE_MODEL (selector->filtered_source));
+
+      list = g_list_append (list, selector);
+      g_hash_table_insert (class->source_hash, source, list);
+
+
+      gtk_tree_model_filter_set_visible_func (selector->filtered_source,
+                                             is_source_item_visible,
+                                             selector,
+                                             NULL);
+    }
+  else
+    {  /* Append this selector to the list and push the <source,list>
+         pair onto the hash table */
+
+      selector->filtered_source = GTK_TREE_MODEL_FILTER (
+       gtk_tree_view_get_model (source));
+
+      list = g_list_append (list, selector);
+      g_hash_table_replace (class->source_hash, source, list);
+    }
+
+  selection = gtk_tree_view_get_selection (source);
+
+  g_signal_connect (source, "row-activated", G_CALLBACK (on_row_activate),
+                   selector);
+
+  g_signal_connect (selection, "changed", G_CALLBACK (on_source_select),
+                   selector);
+}
+
+
+/* Set the destination widget to DEST */
+static void
+set_tree_view_dest (PsppireSelector *selector,
+                   GtkTreeView *dest)
+{
+  GtkTreeSelection* selection = gtk_tree_view_get_selection (dest);
+
+  gtk_tree_selection_set_mode (selection, GTK_SELECTION_MULTIPLE);
+
+  g_signal_connect (selection, "changed", G_CALLBACK (on_dest_treeview_select),
+                   selector);
+}
+
+/* Callback for when the DEST GtkEntry is activated (Enter is pressed) */
+static void
+on_entry_activate (GtkEntry *w, gpointer data)
+{
+  PsppireSelector * selector = data;
+
+  gtk_tree_model_filter_refilter (selector->filtered_source);
+}
+
+/* Callback for when the DEST GtkEntry is selected (clicked) */
+static gboolean
+on_entry_dest_select (GtkWidget *widget, GdkEventFocus *event, gpointer data)
+{
+  PsppireSelector * selector = data;
+
+  set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
+
+  return FALSE;
+}
+
+/* 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),
+                   selector);
+
+  g_signal_connect (dest, "focus-in-event", G_CALLBACK (on_entry_dest_select),
+                   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 )
+{
+  selector->filter = filter_func ;
+
+  selector->source = source;
+  selector->dest = dest;
+
+  if ( filter_func == NULL)
+    {
+      if  (GTK_IS_TREE_VIEW (dest))
+       selector->filter = is_item_in_dest;
+    }
+
+  g_signal_connect (selector, "clicked", G_CALLBACK (on_click), NULL);
+
+  if ( GTK_IS_TREE_VIEW (source))
+    set_tree_view_source (selector, GTK_TREE_VIEW (source) );
+  else
+    g_error ("Unsupported source widget: %s", G_OBJECT_TYPE_NAME (source));
+
+  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));
+
+  else
+    g_error ("Unsupported destination widget: %s", G_OBJECT_TYPE_NAME (dest));
+
+  selector->select_items = select_func;
+}