Modified webpage: now tinymail repository is in gitorious.
[modest] / src / widgets / modest-combo-box.h
index d27644c..ee43edb 100644 (file)
@@ -30,7 +30,7 @@
 #ifndef __MODEST_COMBO_BOX_H__
 #define __MODEST_COMBO_BOX_H__
 
 #ifndef __MODEST_COMBO_BOX_H__
 #define __MODEST_COMBO_BOX_H__
 
-#include <gtk/gtkcombobox.h>
+#include <gtk/gtk.h>
 #include <modest-pair.h>
 
 G_BEGIN_DECLS
 #include <modest-pair.h>
 
 G_BEGIN_DECLS
@@ -63,7 +63,13 @@ GType        modest_combo_box_get_type    (void) G_GNUC_CONST;
 
 /**
  * modest_combo_box_new
 
 /**
  * modest_combo_box_new
- * @pairs: a #ModestPairList; each element should be a ptr to a #ModestPair 
+ * @pairs: a #ModestPairList; each element should be a ptr to a #ModestPair,
+ * with the first item in the pair being an opaque ID, and the second item being 
+ * a gchar* string for display. 
+ * If the ID is a string or other non fundamental type, you must make sure that 
+ * the instance remains allocated for the lifetime of this combo box.
+ * The simplest way to achieve this is to ensure that the ModestPairList exists 
+ * for as long as the combo box.
  * @cmp_id_func: a GEqualFunc to compare the ids (= the first elements of the pairs)
  * For example, if the ids are strings, you can use g_str_equal.
  *
  * @cmp_id_func: a GEqualFunc to compare the ids (= the first elements of the pairs)
  * For example, if the ids are strings, you can use g_str_equal.
  *
@@ -77,6 +83,15 @@ GtkWidget*   modest_combo_box_new         (ModestPairList* pairs,
                                           GEqualFunc id_equal_func);
 
 /**
                                           GEqualFunc id_equal_func);
 
 /**
+ * modest_combo_box_set_pair_list:
+ * @combo: a #ModestComboBox
+ * @pairs: a #ModestPairList
+ *
+ * sets the model of the combobox with a new pair list.
+ */
+void         modest_combo_box_set_pair_list (ModestComboBox *combo, 
+                                            ModestPairList *pairs);
+/**
  * modest_combo_box_get_active_id
  * @self: a valid ModestComboBox instance 
  * 
  * modest_combo_box_get_active_id
  * @self: a valid ModestComboBox instance 
  *