#ifndef __MODEST_COMBO_BOX_H__
#define __MODEST_COMBO_BOX_H__
-#include <gtk/gtk.h>
+#include <gtk/gtkcombobox.h>
#include <modest-pair.h>
G_BEGIN_DECLS
typedef struct _ModestComboBoxClass ModestComboBoxClass;
struct _ModestComboBox {
- GObject parent;
+ GtkComboBox parent;
/* insert public members, if any */
};
struct _ModestComboBoxClass {
- GObjectClass parent_class;
+ GtkComboBoxClass parent_class;
/* insert signal callback declarations, eg. */
/* void (* my_event) (ModestComboBox* obj); */
};
/**
* modest_combo_box_new
- * @hash: a ptr to a GSList; 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.
*
+ * (If you provide NULL for this parameter, the id ptr address will be compared)
+ *
* create a new modest combo box
*
* Returns: a new GtkComboBox instance, or NULL in case of failure
*/
-GtkWidget* modest_combo_box_new (const GSList *hash);
+GtkWidget* modest_combo_box_new (ModestPairList* pairs,
+ 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
*
- * get the id for the currently active lemma, or NULL if there's nothing chosen
+ * get the id for the currently active item, or NULL if there's nothing chosen
+ * (ie., the id is the first element of the pair)
*
* Returns: the id or NULL if there's nothing chosen.
*/
gpointer modest_combo_box_get_active_id (ModestComboBox *self);
+/**
+ * modest_combo_box_set_active_id
+ * @self: a valid ModestComboBox instance
+ * @id: the id to make active
+ *
+ * set the active item
+ *
+ */
+void modest_combo_box_set_active_id (ModestComboBox *self, gpointer id);
+
+/**
+ * modest_combo_box_get_active_display_name
+ * @self: a valid ModestComboBox instance
+ *
+ * get the display name for the currently active lemma, or NULL if
+ * there's nothing chosen
+ *
+ * Returns: the display name or NULL if there's nothing chosen.
+ */
+const gchar* modest_combo_box_get_active_display_name (ModestComboBox *self);
+
G_END_DECLS
#endif /* __MODEST_COMBO_BOX_H__ */