Fix for bug #471779 (Timezone entries in the timezone dialog combo-box are now sorted alphabetically)

svn path=/trunk/; revision=35077

3 files changed, 115 insertions, 83 deletions

diff --git a/widgets/ChangeLog b/widgets/ChangeLog
index 7a2d6a637e..edcac936e4 100644
--- a/widgets/ChangeLog
+++ b/widgets/ChangeLog
@@ -1,3 +1,16 @@
+2008-02-23  Suman Manjunath  <msuman@novell.com>
+
+	** Fix for bug #471779
+
+	* e-timezone-dialog/e-timezone-dialog.c:
+	(e_timezone_dialog_add_timezones), (e_timezone_dialog_construct),
+	(on_map_leave), (on_map_button_pressed),
+	(e_timezone_dialog_set_timezone), (on_combo_changed),
+	(timezone_combo_get_active_text), (timezone_combo_set_active_text):
+	* e-timezone-dialog/e-timezone-dialog.glade:
+	Timezone entries in the combo-box are now sorted alphabetically. 
+	Migrated deprecated widget to GtkComboBox. 
+
 2008-02-19  Milan Crha  <mcrha@redhat.com>
 
 	** Fix for bug #383438
diff --git a/widgets/e-timezone-dialog/e-timezone-dialog.c b/widgets/e-timezone-dialog/e-timezone-dialog.c
index e1a75412bb..f711155231 100644
--- a/widgets/e-timezone-dialog/e-timezone-dialog.c
+++ b/widgets/e-timezone-dialog/e-timezone-dialog.c
@@ -27,8 +27,10 @@
 #include <string.h>
 #include <glib/gi18n.h>
 #include <gtk/gtksignal.h>
-#include <gtk/gtkcombo.h>
-#include <gtk/gtkentry.h>
+#include <gtk/gtkcombobox.h>
+#include <gtk/gtkliststore.h>
+#include <gtk/gtkcellrenderertext.h>
+#include <gtk/gtkcelllayout.h>
 #include <gtk/gtklabel.h>
 #include <gnome.h>
 #include <glade/glade.h>
@@ -110,8 +112,14 @@ static icaltimezone* get_zone_from_point	(ETimezoneDialog *etd,
 						 EMapPoint	*point);
 static void	set_map_timezone		(ETimezoneDialog *etd,
 						 icaltimezone    *zone);
-static void	on_combo_changed		(GtkEditable	*entry,
+static void	on_combo_changed		(GtkComboBox	*combo,
 						 ETimezoneDialog *etd);
+
+static void timezone_combo_get_active_text 	(GtkComboBox *combo, 
+						 const char **zone_name);
+static gboolean timezone_combo_set_active_text 	(GtkComboBox *combo, 
+						 const char *zone_name);
+
 static void	map_destroy_cb			(gpointer data,
 						 GObject *where_object_was);
 
@@ -198,28 +206,22 @@ e_timezone_dialog_add_timezones (ETimezoneDialog *etd)
 {
 	ETimezoneDialogPrivate *priv;
 	icalarray *zones;
-	GtkWidget *listitem;
-	GtkCombo *combo;
+	GtkComboBox *combo;
+	GList *l, *list_items = NULL;
+	GtkListStore *list_store;
+	GtkTreeIter iter;
+	GtkCellRenderer *cell;
+	GHashTable *index;
 	int i;
 
 	priv = etd->priv;
 
-	combo = GTK_COMBO (priv->timezone_combo);
-
-	/* Clear any existing items in the combo. */
-	gtk_list_clear_items (GTK_LIST (combo->list), 0, -1);
-
-	/* Put the ""UTC" entry at the top of the combo's list. */
-	listitem = gtk_list_item_new_with_label (_("UTC"));
-	gtk_widget_show (listitem);
-	gtk_container_add (GTK_CONTAINER (combo->list), listitem);
-
 	/* Get the array of builtin timezones. */
 	zones = icaltimezone_get_builtin_timezones ();
 
 	for (i = 0; i < zones->num_elements; i++) {
 		icaltimezone *zone;
-		char *location;
+		gchar *location;
 
 		zone = icalarray_element_at (zones, i);
 
@@ -230,10 +232,42 @@ e_timezone_dialog_add_timezones (ETimezoneDialog *etd)
 				 icaltimezone_get_latitude (zone),
 				 E_TIMEZONE_DIALOG_MAP_POINT_NORMAL_RGBA);
 
-		listitem = gtk_list_item_new_with_label (location);
-		gtk_widget_show (listitem);
-		gtk_container_add (GTK_CONTAINER (combo->list), listitem);
+		list_items = g_list_prepend (list_items, location);
 	}
+
+	list_items = g_list_sort (list_items, (GCompareFunc) g_utf8_collate);
+
+	/* Put the "UTC" entry at the top of the combo's list. */
+	list_items = g_list_prepend (list_items, _("UTC"));
+
+	combo = GTK_COMBO_BOX (priv->timezone_combo);
+
+	cell = gtk_cell_renderer_text_new ();
+	gtk_cell_layout_pack_start ((GtkCellLayout *) combo, cell, TRUE);
+	gtk_cell_layout_set_attributes ((GtkCellLayout *) combo, cell, "text", 0, NULL);
+
+	list_store = gtk_list_store_new (1, G_TYPE_STRING);
+	index = g_hash_table_new (g_str_hash, g_str_equal);
+	for (l = list_items, i = 0; l != NULL; l = l->next, ++i) {
+		gtk_list_store_append (list_store, &iter);
+		gtk_list_store_set (list_store, &iter, 0, (gchar *)(l->data), -1);
+		g_hash_table_insert (index, (gchar *)(l->data), GINT_TO_POINTER (i));
+	}
+
+	g_object_set_data_full (G_OBJECT (list_store), "index", index, (GDestroyNotify) g_hash_table_destroy);
+
+	gtk_combo_box_set_model (combo, (GtkTreeModel *) list_store);
+
+	gtk_rc_parse_string (
+		"style \"e-timezone-combo-style\" {\n"
+		"  GtkComboBox::appears-as-list = 1\n"
+		"}\n"
+		"\n"
+		"widget \"*.e-timezone-dialog-combo\" style \"e-timezone-combo-style\"");
+
+	gtk_widget_set_name (priv->timezone_combo, "e-timezone-dialog-combo");
+
+	g_list_free (list_items);
 }
 
 
@@ -279,8 +313,6 @@ e_timezone_dialog_construct (ETimezoneDialog *etd)
 			       | GDK_LEAVE_NOTIFY_MASK
 			       | GDK_VISIBILITY_NOTIFY_MASK);
 
-	gtk_editable_set_editable (GTK_EDITABLE (GTK_COMBO (priv->timezone_combo)->entry), FALSE);
-
 	e_timezone_dialog_add_timezones (etd);
 
 	gtk_container_add (GTK_CONTAINER (priv->map_window), map);
@@ -294,7 +326,7 @@ e_timezone_dialog_construct (ETimezoneDialog *etd)
         g_signal_connect (map, "visibility-notify-event", G_CALLBACK (on_map_visibility_changed), etd);
 	g_signal_connect (map, "button-press-event", G_CALLBACK (on_map_button_pressed), etd);
 
-	g_signal_connect (GTK_COMBO (priv->timezone_combo)->entry, "changed", G_CALLBACK (on_combo_changed), etd);
+	g_signal_connect (GTK_COMBO_BOX (priv->timezone_combo), "changed", G_CALLBACK (on_combo_changed), etd);
 
 	return etd;
 
@@ -527,8 +559,8 @@ on_map_leave (GtkWidget *widget, GdkEventCrossing *event, gpointer data)
 	        e_map_point_set_color_rgba (priv->map, priv->point_hover,
 					    E_TIMEZONE_DIALOG_MAP_POINT_NORMAL_RGBA);
 
-	gtk_entry_set_text (GTK_ENTRY (GTK_COMBO (priv->timezone_combo)->entry),
-			    zone_display_name (priv->zone));
+	timezone_combo_set_active_text (GTK_COMBO_BOX (priv->timezone_combo),
+					zone_display_name (priv->zone));
 	gtk_label_set_text (GTK_LABEL (priv->preview_label), "");
 
 	priv->point_hover = NULL;
@@ -591,8 +623,8 @@ on_map_button_pressed (GtkWidget *w, GdkEventButton *event, gpointer data)
 		priv->point_selected = priv->point_hover;
 
 		priv->zone = get_zone_from_point (etd, priv->point_selected);
-		gtk_entry_set_text (GTK_ENTRY (GTK_COMBO (priv->timezone_combo)->entry),
-				    zone_display_name (priv->zone));
+		timezone_combo_set_active_text (GTK_COMBO_BOX (priv->timezone_combo),
+						zone_display_name (priv->zone));
 	}
 
 	return TRUE;
@@ -691,8 +723,8 @@ e_timezone_dialog_set_timezone (ETimezoneDialog *etd,
 
 	gtk_label_set_text (GTK_LABEL (priv->preview_label),
 			    zone ? display : "");
-	gtk_entry_set_text (GTK_ENTRY (GTK_COMBO (priv->timezone_combo)->entry),
-			    zone ? zone_display_name(zone) : "");
+	timezone_combo_set_active_text (GTK_COMBO_BOX (priv->timezone_combo),
+					zone ? zone_display_name(zone) : "");
 
 	set_map_timezone (etd, zone);
 	g_free (display);
@@ -741,7 +773,7 @@ set_map_timezone (ETimezoneDialog *etd, icaltimezone *zone)
 
 
 static void
-on_combo_changed (GtkEditable *entry, ETimezoneDialog *etd)
+on_combo_changed (GtkComboBox *combo_box, ETimezoneDialog *etd)
 {
 	ETimezoneDialogPrivate *priv;
 	const char *new_zone_name;
@@ -752,11 +784,11 @@ on_combo_changed (GtkEditable *entry, ETimezoneDialog *etd)
 
 	priv = etd->priv;
 
-	new_zone_name = gtk_entry_get_text (GTK_ENTRY (GTK_COMBO (priv->timezone_combo)->entry));
+	timezone_combo_get_active_text (GTK_COMBO_BOX (priv->timezone_combo), &new_zone_name);
 
 	if (!*new_zone_name)
 		priv->zone = NULL;
-	else if (!strcmp (new_zone_name, _("UTC")))
+	else if (!g_utf8_collate (new_zone_name, _("UTC")))
 		priv->zone = icaltimezone_get_utc_timezone ();
 	else {
 		priv->zone = NULL;
@@ -765,7 +797,7 @@ on_combo_changed (GtkEditable *entry, ETimezoneDialog *etd)
 		for (i = 0; i < zones->num_elements; i++) {
 			map_zone = icalarray_element_at (zones, i);
 			location = _(icaltimezone_get_location (map_zone));
-			if (!strcmp (new_zone_name, location)) {
+			if (!g_utf8_collate (new_zone_name, location)) {
 				priv->zone = map_zone;
 				break;
 			}
@@ -775,6 +807,39 @@ on_combo_changed (GtkEditable *entry, ETimezoneDialog *etd)
 	set_map_timezone (etd, map_zone);
 }
 
+static void 
+timezone_combo_get_active_text (GtkComboBox *combo, const char **zone_name)
+{
+	GtkTreeModel *list_store;
+	GtkTreeIter iter;
+
+	list_store = gtk_combo_box_get_model (combo);
+
+	/* Get the active iter in the list */
+	if (gtk_combo_box_get_active_iter (combo, &iter)) 
+		gtk_tree_model_get (list_store, &iter, 0, zone_name, -1);
+	else 
+		*zone_name = "";
+}
+
+static gboolean 
+timezone_combo_set_active_text (GtkComboBox *combo, const char *zone_name)
+{
+	GtkTreeModel *list_store;
+	GHashTable *index;
+	gpointer id = NULL;
+
+	list_store = gtk_combo_box_get_model (combo);
+	index = (GHashTable *) g_object_get_data (G_OBJECT (list_store), "index");
+
+	if (zone_name && *zone_name) 
+		id = g_hash_table_lookup (index, zone_name);
+
+	gtk_combo_box_set_active (combo, GPOINTER_TO_INT (id));
+
+	return (id != NULL);
+}
+
 /**
  * e_timezone_dialog_reparent:
  * @etd: #ETimezoneDialog.
diff --git a/widgets/e-timezone-dialog/e-timezone-dialog.glade b/widgets/e-timezone-dialog/e-timezone-dialog.glade
index 39de73f145..cdb892bc2c 100644
--- a/widgets/e-timezone-dialog/e-timezone-dialog.glade
+++ b/widgets/e-timezone-dialog/e-timezone-dialog.glade
@@ -247,7 +247,7 @@ Use the right mouse button to zoom out.</property>
 	      <property name="yalign">0.5</property>
 	      <property name="xpad">0</property>
 	      <property name="ypad">0</property>
-	      <property name="mnemonic_widget">combo-entry1</property>
+	      <property name="mnemonic_widget">timezone-combo</property>
 	    </widget>
 	    <packing>
 	      <property name="padding">0</property>
@@ -284,59 +284,13 @@ Use the right mouse button to zoom out.</property>
 	      </child>
 
 	      <child>
-		<widget class="GtkCombo" id="timezone-combo">
+		<widget class="GtkComboBox" id="timezone-combo">
 		  <property name="visible">True</property>
-		  <property name="value_in_list">False</property>
-		  <property name="allow_empty">True</property>
-		  <property name="case_sensitive">False</property>
-		  <property name="enable_arrow_keys">True</property>
-		  <property name="enable_arrows_always">False</property>
+		  <property name="add_tearoffs">False</property>
+		  <property name="focus_on_click">True</property>
 		  <accessibility>
-		    <atkproperty name="AtkObject::accessible_name" translatable="yes">TimeZone Combobox</atkproperty>
+		    <atkproperty name="AtkObject::accessible_name" translatable="yes">TimeZone ComboBox</atkproperty>
 		  </accessibility>
-
-		  <child internal-child="entry">
-		    <widget class="GtkEntry" id="combo-entry1">
-		      <property name="visible">True</property>
-		      <property name="can_focus">True</property>
-		      <property name="editable">False</property>
-		      <property name="visibility">True</property>
-		      <property name="max_length">0</property>
-		      <property name="text" translatable="yes"></property>
-		      <property name="has_frame">True</property>
-		      <property name="invisible_char">*</property>
-		      <property name="activates_default">False</property>
-		    </widget>
-		  </child>
-
-		  <child internal-child="list">
-		    <widget class="GtkList" id="convertwidget3">
-		      <property name="visible">True</property>
-		      <property name="selection_mode">GTK_SELECTION_BROWSE</property>
-
-		      <child>
-			<widget class="GtkListItem" id="convertwidget4">
-			  <property name="visible">True</property>
-
-			  <child>
-			    <widget class="GtkLabel" id="convertwidget5">
-			      <property name="visible">True</property>
-			      <property name="label" translatable="yes"></property>
-			      <property name="use_underline">False</property>
-			      <property name="use_markup">False</property>
-			      <property name="justify">GTK_JUSTIFY_LEFT</property>
-			      <property name="wrap">False</property>
-			      <property name="selectable">False</property>
-			      <property name="xalign">0</property>
-			      <property name="yalign">0.5</property>
-			      <property name="xpad">0</property>
-			      <property name="ypad">0</property>
-			    </widget>
-			  </child>
-			</widget>
-		      </child>
-		    </widget>
-		  </child>
 		</widget>
 		<packing>
 		  <property name="padding">0</property>