* Added new ModestSelectorPicker that will replace ModestComboBox in
[modest] / src / hildon2 / modest-selector-picker.c
1 /* Copyright (c) 2006, 2008 Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include <gtk/gtkcelllayout.h>
31 #include <gtk/gtkcellrenderertext.h>
32 #include <gtk/gtkliststore.h>
33 #include "modest-selector-picker.h"
34
35 /* 'private'/'protected' functions */
36 static void modest_selector_picker_class_init (ModestSelectorPickerClass *klass);
37 static void modest_selector_picker_init       (ModestSelectorPicker *obj);
38 static void modest_selector_picker_finalize   (GObject *obj);
39
40 enum {
41         COLUMN_ID,
42         COLUMN_DISPLAY_NAME,
43         COLUMN_NUM
44 };
45
46 typedef struct _ModestSelectorPickerPrivate ModestSelectorPickerPrivate;
47 struct _ModestSelectorPickerPrivate {
48         GEqualFunc id_equal_func;
49         
50 };
51 #define MODEST_SELECTOR_PICKER_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
52                                                                                 MODEST_TYPE_SELECTOR_PICKER, \
53                                                                                 ModestSelectorPickerPrivate))
54 /* globals */
55 static GObjectClass *parent_class = NULL;
56
57 GType
58 modest_selector_picker_get_type (void)
59 {
60         static GType my_type = 0;
61         if (!my_type) {
62                 static const GTypeInfo my_info = {
63                         sizeof(ModestSelectorPickerClass),
64                         NULL,           /* base init */
65                         NULL,           /* base finalize */
66                         (GClassInitFunc) modest_selector_picker_class_init,
67                         NULL,           /* class finalize */
68                         NULL,           /* class data */
69                         sizeof(ModestSelectorPicker),
70                         1,              /* n_preallocs */
71                         (GInstanceInitFunc) modest_selector_picker_init,
72                         NULL
73                 };
74                 my_type = g_type_register_static (HILDON_TYPE_PICKER_BUTTON,
75                                                   "ModestSelectorPicker",
76                                                   &my_info, 0);
77         }
78         return my_type;
79 }
80
81 static void
82 modest_selector_picker_class_init (ModestSelectorPickerClass *klass)
83 {
84         GObjectClass *gobject_class;
85         gobject_class = (GObjectClass*) klass;
86
87         parent_class            = g_type_class_peek_parent (klass);
88         gobject_class->finalize = modest_selector_picker_finalize;
89
90         g_type_class_add_private (gobject_class, sizeof(ModestSelectorPickerPrivate));
91
92 }
93
94 static void
95 modest_selector_picker_init (ModestSelectorPicker *obj)
96 {
97 }
98
99 static void
100 modest_selector_picker_finalize (GObject *obj)
101 {
102 /*      free/unref instance resources here */
103         G_OBJECT_CLASS(parent_class)->finalize (obj);
104 }
105
106 static gchar *
107 touch_selector_print_func (HildonTouchSelector *selector)
108 {
109         GtkTreeIter iter;
110         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
111                 GtkTreeModel *model;
112                 GValue value = {0,};
113                 
114                 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
115                 gtk_tree_model_get_value (model, &iter, COLUMN_DISPLAY_NAME, &value);
116                 return g_value_dup_string (&value);
117         }
118         return NULL;
119 }
120
121 static GtkTreeModel*
122 get_model (ModestPairList *pairs)
123 {
124         GtkTreeIter iter;
125         GtkListStore *store;
126         GSList *cursor;
127         
128         store = gtk_list_store_new (2,
129                                     G_TYPE_POINTER, /* the id */
130                                     G_TYPE_STRING); /* the display name */
131         cursor = pairs;
132         while (cursor) {
133                 ModestPair *pair = (ModestPair*)cursor->data;
134                 gtk_list_store_insert_with_values (store, &iter, G_MAXINT,
135                                                    COLUMN_ID,           pair->first,
136                                                    COLUMN_DISPLAY_NAME, pair->second,
137                                                    -1);
138                 cursor = cursor->next;
139         }
140         
141         return GTK_TREE_MODEL (store);
142 }
143
144 static GtkWidget *
145 create_touch_selector (GtkTreeModel *model)
146 {
147         GtkCellRenderer *renderer;
148         GtkWidget *selector;
149
150         renderer = gtk_cell_renderer_text_new ();
151         g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
152
153         selector = hildon_touch_selector_new ();
154         hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (model),
155                                              renderer, "text", COLUMN_DISPLAY_NAME, NULL);
156
157         hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR(selector), 0, model);
158         hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector), touch_selector_print_func);
159
160         return selector;
161 }
162
163 void
164 modest_selector_picker_set_pair_list (ModestSelectorPicker *self, ModestPairList *pairs)
165 {
166         GtkTreeModel *model;
167         GtkTreeIter iter;
168         GtkWidget *selector;
169
170         model = get_model (pairs);
171
172         selector = create_touch_selector (model);       
173         gtk_tree_model_get_iter_first (GTK_TREE_MODEL(model), &iter);
174         hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &iter, TRUE);
175         g_object_unref (model);
176
177         hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
178 }
179
180
181
182 GtkWidget*
183 modest_selector_picker_new (ModestPairList *pairs, GEqualFunc id_equal_func)
184 {
185         GtkTreeModel *model;
186         GObject *obj;
187         ModestSelectorPickerPrivate *priv;
188         GtkTreeIter iter;
189
190         obj  = G_OBJECT(g_object_new(MODEST_TYPE_SELECTOR_PICKER,
191                                      "size", HILDON_SIZE_AUTO,
192                                      "arrangement", HILDON_BUTTON_ARRANGEMENT_VERTICAL,
193                                      NULL));
194         priv = MODEST_SELECTOR_PICKER_GET_PRIVATE(obj);
195         
196         model = get_model (pairs);
197         if (model) {
198                 GtkWidget *selector;
199
200                 selector = create_touch_selector (model);
201                 gtk_tree_model_get_iter_first (GTK_TREE_MODEL (model), &iter);
202                 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &iter, TRUE);
203                 g_object_unref (model);
204
205                 hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (obj), HILDON_TOUCH_SELECTOR (selector));
206         }
207
208         if (id_equal_func)
209                 priv->id_equal_func = id_equal_func;
210         else
211                 priv->id_equal_func = g_direct_equal; /* compare the ptr values */
212         
213         return GTK_WIDGET(obj);
214 }
215
216
217
218 static void
219 get_active (ModestSelectorPicker *self, GValue *val, gint column)
220 {
221         GtkTreeIter iter;
222         GtkWidget *selector;
223         g_return_if_fail (self);
224
225         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
226
227         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
228                 GtkTreeModel *model;
229                 
230                 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
231                 gtk_tree_model_get_value (model, &iter, column, val);
232         }
233 }
234
235 gpointer
236 modest_selector_picker_get_active_id (ModestSelectorPicker *self)
237 {
238         GValue val = {0,};
239
240         g_return_val_if_fail (self, NULL);
241         
242         /* Do not unset the GValue */
243         get_active (self, &val, COLUMN_ID);
244
245         return g_value_get_pointer (&val);
246 }
247
248
249 void
250 modest_selector_picker_set_active_id (ModestSelectorPicker *self, gpointer id)
251 {
252         GtkTreeModel *model;
253         GtkTreeIter iter;
254         ModestSelectorPickerPrivate *priv;
255         gboolean found = FALSE;
256         GtkWidget *selector;
257         
258         g_return_if_fail (self);
259
260         priv = MODEST_SELECTOR_PICKER_GET_PRIVATE(self);
261         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
262         
263         model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR(selector), 0);
264         if (!gtk_tree_model_get_iter_first (model, &iter))
265                 return; /* empty list */
266
267         do {
268                 gpointer row_id;
269                 gtk_tree_model_get (model, &iter, COLUMN_ID, &row_id, -1);
270                 if ((priv->id_equal_func)(id, row_id)) {
271                         hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0,
272                                                            &iter, TRUE);
273                         
274                         hildon_button_set_value (HILDON_BUTTON (self), 
275                                                  hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
276                         found = TRUE;
277                 }
278         } while (!found && gtk_tree_model_iter_next (model, &iter));
279
280         if (!found)
281                 g_printerr ("modest: could not set the active id\n"); 
282 }
283
284
285
286 const gchar*
287 modest_selector_picker_get_active_display_name (ModestSelectorPicker *self)
288 {
289         const GValue val = {0,};
290         const gchar *retval;
291
292         g_return_val_if_fail (self, NULL);
293
294         /* Do not unset the GValue */
295         get_active (self, (GValue *)&val, COLUMN_DISPLAY_NAME);
296         retval = g_value_get_string (&val);
297
298         return retval;
299 }