git.maemo.org Git - modest/blob - src/widgets/modest-combo-box.c

   1 /* Copyright (c) 2006, 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-combo-box.h"
  34
  35 /* 'private'/'protected' functions */
  36 static void modest_combo_box_class_init (ModestComboBoxClass *klass);
  37 static void modest_combo_box_init       (ModestComboBox *obj);
  38 static void modest_combo_box_finalize   (GObject *obj);
  39 /* list my signals  */
  40 enum {
  41         /* MY_SIGNAL_1, */
  42         /* MY_SIGNAL_2, */
  43         LAST_SIGNAL
  44 };
  45
  46
  47 enum {
  48         COLUMN_ID,
  49         COLUMN_DISPLAY_NAME,
  50         COLUMN_NUM
  51 };
  52
  53 typedef struct _ModestComboBoxPrivate ModestComboBoxPrivate;
  54 struct _ModestComboBoxPrivate {
  55         GEqualFunc id_equal_func;
  56
  57 };
  58 #define MODEST_COMBO_BOX_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  59                                               MODEST_TYPE_COMBO_BOX, \
  60                                               ModestComboBoxPrivate))
  61 /* globals */
  62 static GObjectClass *parent_class = NULL;
  63
  64 /* uncomment the following if you have defined any signals */
  65 /* static guint signals[LAST_SIGNAL] = {0}; */
  66
  67 GType
  68 modest_combo_box_get_type (void)
  69 {
  70         static GType my_type = 0;
  71         if (!my_type) {
  72                 static const GTypeInfo my_info = {
  73                         sizeof(ModestComboBoxClass),
  74                         NULL,           /* base init */
  75                         NULL,           /* base finalize */
  76                         (GClassInitFunc) modest_combo_box_class_init,
  77                         NULL,           /* class finalize */
  78                         NULL,           /* class data */
  79                         sizeof(ModestComboBox),
  80                         1,              /* n_preallocs */
  81                         (GInstanceInitFunc) modest_combo_box_init,
  82                         NULL
  83                 };
  84                 my_type = g_type_register_static (GTK_TYPE_COMBO_BOX,
  85                                                   "ModestComboBox",
  86                                                   &my_info, 0);
  87         }
  88         return my_type;
  89 }
  90
  91 static void
  92 modest_combo_box_class_init (ModestComboBoxClass *klass)
  93 {
  94         GObjectClass *gobject_class;
  95         gobject_class = (GObjectClass*) klass;
  96
  97         parent_class            = g_type_class_peek_parent (klass);
  98         gobject_class->finalize = modest_combo_box_finalize;
  99
 100         g_type_class_add_private (gobject_class, sizeof(ModestComboBoxPrivate));
 101
 102         /* signal definitions go here, e.g.: */
 103 /*      signals[MY_SIGNAL_1] = */
 104 /*              g_signal_new ("my_signal_1",....); */
 105 /*      signals[MY_SIGNAL_2] = */
 106 /*              g_signal_new ("my_signal_2",....); */
 107 /*      etc. */
 108 }
 109
 110 static void
 111 modest_combo_box_init (ModestComboBox *obj)
 112 {
 113 /* uncomment the following if you init any of the private data */
 114 /*      ModestComboBoxPrivate *priv = MODEST_COMBO_BOX_GET_PRIVATE(obj); */
 115
 116 /*      initialize this object, eg.: */
 117 /*      priv->frobnicate_mode = FALSE; */
 118 }
 119
 120 static void
 121 modest_combo_box_finalize (GObject *obj)
 122 {
 123 /*      free/unref instance resources here */
 124         G_OBJECT_CLASS(parent_class)->finalize (obj);
 125 }
 126
 127 static GtkTreeModel*
 128 get_model (const ModestPairList *pairs)
 129 {
 130         GtkTreeIter iter;
 131         GtkListStore *store;
 132         const GSList *cursor;
 133
 134         store = gtk_list_store_new (2,
 135                                     G_TYPE_POINTER, /* the id */
 136                                     G_TYPE_STRING); /* the display name */
 137         cursor = pairs;
 138         while (cursor) {
 139                 ModestPair *pair = (ModestPair*)cursor->data;
 140                 gtk_list_store_insert_with_values (store, &iter, G_MAXINT,
 141                                                    COLUMN_ID,           pair->first,
 142                                                    COLUMN_DISPLAY_NAME, pair->second,
 143                                                    -1);
 144                 cursor = cursor->next;
 145         }
 146
 147         return GTK_TREE_MODEL (store);
 148 }
 149
 150
 151 GtkWidget*
 152 modest_combo_box_new (const ModestPairList *pairs, GEqualFunc id_equal_func)
 153 {
 154         GtkTreeModel *model;
 155         GtkCellRenderer *renderer;
 156         GObject *obj;
 157         ModestComboBoxPrivate *priv;
 158
 159         g_return_val_if_fail (pairs,         NULL);
 160
 161         obj  = G_OBJECT(g_object_new(MODEST_TYPE_COMBO_BOX, NULL));
 162         priv = MODEST_COMBO_BOX_GET_PRIVATE(obj);
 163
 164         model = get_model (pairs);
 165         if (model) {
 166                 gtk_combo_box_set_model (GTK_COMBO_BOX(obj), model);
 167                 g_object_unref (model);
 168                 gtk_cell_layout_clear (GTK_CELL_LAYOUT(obj));
 169
 170                 renderer = gtk_cell_renderer_text_new ();
 171                 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT(obj),
 172                                             renderer, FALSE);
 173                 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT(obj),
 174                                                 renderer, "text",
 175                                                 COLUMN_DISPLAY_NAME, NULL);
 176         }
 177
 178         gtk_combo_box_set_active (GTK_COMBO_BOX(obj), 0);
 179
 180         if (id_equal_func)
 181                 priv->id_equal_func = id_equal_func;
 182         else
 183                 priv->id_equal_func = g_direct_equal; /* compare the ptr values */
 184
 185         return GTK_WIDGET(obj);
 186 }
 187
 188
 189
 190 static void
 191 get_active (ModestComboBox *self, GValue *val, gint column)
 192 {
 193         GtkTreeIter iter;
 194         g_return_if_fail (self);
 195
 196         if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX(self), &iter)) {
 197                 GtkTreeModel *model;
 198
 199                 model = gtk_combo_box_get_model (GTK_COMBO_BOX(self));
 200                 gtk_tree_model_get_value (model, &iter, column, val);
 201         }
 202 }
 203
 204 gpointer
 205 modest_combo_box_get_active_id (ModestComboBox *self)
 206 {
 207         GValue val = {0,};
 208         gpointer retval;
 209
 210         g_return_val_if_fail (self, NULL);
 211
 212         /* Do not unset the GValue */
 213         get_active (self, &val, COLUMN_ID);
 214         retval = g_value_peek_pointer (&val);
 215
 216         return retval;
 217 }
 218
 219
 220 void
 221 modest_combo_box_set_active_id (ModestComboBox *self, gpointer id)
 222 {
 223         GtkTreeModel *model;
 224         GtkTreeIter iter;
 225         ModestComboBoxPrivate *priv;
 226         gboolean found = FALSE;
 227
 228         g_return_if_fail (self);
 229
 230         priv = MODEST_COMBO_BOX_GET_PRIVATE(self);
 231
 232         model = gtk_combo_box_get_model (GTK_COMBO_BOX(self));
 233         if (!gtk_tree_model_get_iter_first (model, &iter))
 234                 return; /* empty list */
 235
 236         do {
 237                 gpointer row_id;
 238                 gtk_tree_model_get (model, &iter, COLUMN_ID, &row_id, -1);
 239                 if ((priv->id_equal_func)(id, row_id) == 0) {
 240                         gtk_combo_box_set_active_iter (GTK_COMBO_BOX(self), &iter);
 241                         found = TRUE;
 242                 }
 243         } while (!found && gtk_tree_model_iter_next (model, &iter));
 244
 245         if (!found)
 246                 g_printerr ("modest: could not set the active id\n");
 247 }
 248
 249
 250
 251 const gchar*
 252 modest_combo_box_get_active_display_name (ModestComboBox *self)
 253 {
 254         GValue val = {0,};
 255         gpointer retval;
 256
 257         g_return_val_if_fail (self, NULL);
 258
 259         /* Do not unset the GValue */
 260         get_active (self, &val, COLUMN_DISPLAY_NAME);
 261         retval = g_value_peek_pointer (&val);
 262
 263         return (gchar*) retval;
 264 }