Pileus Git - ~andy/gtk/blob - gtk/gtkcomboboxtext.c

   1 /* GTK - The GIMP Toolkit
   2  *
   3  * Copyright (C) 2010 Christian Dywan
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "config.h"
  20
  21 #include "gtkcomboboxtext.h"
  22 #include "gtkcombobox.h"
  23 #include "gtkcellrenderertext.h"
  24 #include "gtkcelllayout.h"
  25
  26 /**
  27  * SECTION:gtkcomboboxtext
  28  * @Short_description: A simple, text-only combo box
  29  * @Title: GtkComboBoxText
  30  * @See_also: #GtkComboBox
  31  *
  32  * A GtkComboBoxText is a simple variant of #GtkComboBox that hides
  33  * the model-view complexity for simple text-only use cases.
  34  *
  35  * To create a GtkComboBoxText, use gtk_combo_box_text_new() or
  36  * gtk_combo_box_text_new_with_entry().
  37  *
  38  * You can add items to a GtkComboBoxText with
  39  * gtk_combo_box_text_append_text(), gtk_combo_box_text_insert_text()
  40  * or gtk_combo_box_text_prepend_text() and remove options with
  41  * gtk_combo_box_text_remove().
  42  */
  43
  44 G_DEFINE_TYPE (GtkComboBoxText, gtk_combo_box_text, GTK_TYPE_COMBO_BOX);
  45
  46 static GObject *
  47 gtk_combo_box_text_constructor (GType                  type,
  48                                 guint                  n_construct_properties,
  49                                 GObjectConstructParam *construct_properties)
  50 {
  51   GObject            *object;
  52
  53   object = G_OBJECT_CLASS (gtk_combo_box_text_parent_class)->constructor
  54     (type, n_construct_properties, construct_properties);
  55
  56   if (!gtk_combo_box_get_has_entry (GTK_COMBO_BOX (object)))
  57     {
  58       GtkCellRenderer *cell;
  59
  60       cell = gtk_cell_renderer_text_new ();
  61       gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (object), cell, TRUE);
  62       gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (object), cell,
  63                                       "text", 0,
  64                                       NULL);
  65     }
  66
  67   return object;
  68 }
  69
  70 static void
  71 gtk_combo_box_text_init (GtkComboBoxText *combo_box)
  72 {
  73   GtkListStore *store;
  74
  75   store = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT);
  76   gtk_combo_box_set_model (GTK_COMBO_BOX (combo_box), GTK_TREE_MODEL (store));
  77   g_object_unref (store);
  78 }
  79
  80 static void
  81 gtk_combo_box_text_class_init (GtkComboBoxTextClass *klass)
  82 {
  83   GObjectClass *object_class;
  84
  85   object_class = (GObjectClass *)klass;
  86   object_class->constructor = gtk_combo_box_text_constructor;
  87 }
  88
  89
  90 /**
  91  * gtk_combo_box_text_new:
  92  *
  93  * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
  94  * strings. See gtk_combo_box_entry_new_with_text().
  95  *
  96  * Return value: A new #GtkComboBoxText
  97  *
  98  * Since: 2.24
  99  */
 100 GtkWidget *
 101 gtk_combo_box_text_new (void)
 102 {
 103   return g_object_new (GTK_TYPE_COMBO_BOX_TEXT,
 104                        "entry-text-column", 0,
 105                        "id-column", 1,
 106                        NULL);
 107 }
 108
 109 /**
 110  * gtk_combo_box_text_new_with_entry:
 111  *
 112  * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
 113  * strings. The combo box created by this function has an entry.
 114  *
 115  * Return value: a new #GtkComboBoxText
 116  *
 117  * Since: 2.24
 118  */
 119 GtkWidget *
 120 gtk_combo_box_text_new_with_entry (void)
 121 {
 122   return g_object_new (GTK_TYPE_COMBO_BOX_TEXT,
 123                        "has-entry", TRUE,
 124                        "entry-text-column", 0,
 125                        "id-column", 1,
 126                        NULL);
 127 }
 128
 129 /**
 130  * gtk_combo_box_text_append_text:
 131  * @combo_box: A #GtkComboBoxText
 132  * @text: A string
 133  *
 134  * Appends @string to the list of strings stored in @combo_box.
 135  *
 136  * Since: 2.24
 137  */
 138 void
 139 gtk_combo_box_text_append_text (GtkComboBoxText *combo_box,
 140                                 const gchar     *text)
 141 {
 142   gtk_combo_box_text_insert_text (combo_box, G_MAXINT, text);
 143 }
 144
 145 /**
 146  * gtk_combo_box_text_prepend_text:
 147  * @combo_box: A #GtkComboBox
 148  * @text: A string
 149  *
 150  * Prepends @text to the list of strings stored in @combo_box.
 151  *
 152  * Since: 2.24
 153  */
 154 void
 155 gtk_combo_box_text_prepend_text (GtkComboBoxText *combo_box,
 156                                  const gchar     *text)
 157 {
 158   gtk_combo_box_text_insert_text (combo_box, 0, text);
 159 }
 160
 161 /**
 162  * gtk_combo_box_text_insert_text:
 163  * @combo_box: A #GtkComboBoxText
 164  * @position: An index to insert @text
 165  * @text: A string
 166  *
 167  * Inserts @text at @position in the list of strings stored in @combo_box.
 168  *
 169  * Since: 2.24
 170  */
 171 void
 172 gtk_combo_box_text_insert_text (GtkComboBoxText *combo_box,
 173                                 gint             position,
 174                                 const gchar     *text)
 175 {
 176   gtk_combo_box_text_insert_text_with_id (combo_box, position, text, 0);
 177 }
 178
 179 /**
 180  * gtk_combo_box_text_insert_text_with_id:
 181  * @combo_box: A #GtkComboBoxText
 182  * @position: An index to insert @text
 183  * @text: A string
 184  * @id: a numeric ID for this value
 185  *
 186  * Inserts @string at @position in the list of strings stored in @combo_box,
 187  * and sets its numeric ID to @id. See #GtkComboBox::id-column.
 188  *
 189  * Since: 3.0
 190  */
 191 void
 192 gtk_combo_box_text_insert_text_with_id (GtkComboBoxText *combo_box,
 193                                         gint             position,
 194                                         const gchar     *text,
 195                                         gint             id)
 196 {
 197   GtkListStore *store;
 198   GtkTreeIter iter;
 199   gint text_column;
 200   gint id_column;
 201   gint column_type;
 202
 203   g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
 204   g_return_if_fail (position >= 0);
 205   g_return_if_fail (text != NULL);
 206
 207   store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)));
 208   g_return_if_fail (GTK_IS_LIST_STORE (store));
 209   text_column = gtk_combo_box_get_entry_text_column (GTK_COMBO_BOX (combo_box));
 210   column_type = gtk_tree_model_get_column_type (GTK_TREE_MODEL (store), text_column);
 211   g_return_if_fail (column_type == G_TYPE_STRING);
 212   id_column = gtk_combo_box_get_id_column (GTK_COMBO_BOX (combo_box));
 213   if (id_column != -1)
 214     {
 215       column_type = gtk_tree_model_get_column_type (GTK_TREE_MODEL (store), id_column);
 216       g_return_if_fail (column_type == G_TYPE_INT);
 217     }
 218
 219   gtk_list_store_insert (store, &iter, position);
 220   gtk_list_store_set (store, &iter, text_column, text, id_column, id, -1);
 221 }
 222
 223
 224 /**
 225  * gtk_combo_box_text_remove:
 226  * @combo_box: A #GtkComboBox
 227  * @position: Index of the item to remove
 228  *
 229  * Removes the string at @position from @combo_box.
 230  *
 231  * Since: 2.24
 232  */
 233 void
 234 gtk_combo_box_text_remove (GtkComboBoxText *combo_box,
 235                            gint             position)
 236 {
 237   GtkTreeModel *model;
 238   GtkListStore *store;
 239   GtkTreeIter iter;
 240
 241   g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
 242   g_return_if_fail (position >= 0);
 243
 244   model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));
 245   store = GTK_LIST_STORE (model);
 246   g_return_if_fail (GTK_IS_LIST_STORE (store));
 247
 248   if (gtk_tree_model_iter_nth_child (model, &iter, NULL, position))
 249     gtk_list_store_remove (store, &iter);
 250 }
 251
 252 /**
 253  * gtk_combo_box_text_remove_all:
 254  * @combo_box: A #GtkComboBoxText
 255  *
 256  * Removes all the text entries from the combo box.
 257  *
 258  * Since: 3.0
 259  */
 260 void
 261 gtk_combo_box_text_remove_all (GtkComboBoxText *combo_box)
 262 {
 263   GtkListStore *store;
 264
 265   g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
 266
 267   store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)));
 268   gtk_list_store_clear (store);
 269 }
 270
 271 /**
 272  * gtk_combo_box_text_get_active_text:
 273  * @combo_box: A #GtkComboBoxText
 274  *
 275  * Returns the currently active string in @combo_box or %NULL if none
 276  * is selected.
 277  *
 278  * Returns: a newly allocated string containing the currently active text.
 279  *     Must be freed with g_free().
 280  *
 281  * Since: 2.24
 282  */
 283 gchar *
 284 gtk_combo_box_text_get_active_text (GtkComboBoxText *combo_box)
 285 {
 286   GtkTreeIter iter;
 287   gchar *text = NULL;
 288
 289   g_return_val_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box), NULL);
 290
 291   if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (combo_box), &iter))
 292     {
 293       GtkTreeModel *model;
 294       gint text_column;
 295       gint column_type;
 296
 297       model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));
 298       g_return_val_if_fail (GTK_IS_LIST_STORE (model), NULL);
 299       text_column = gtk_combo_box_get_entry_text_column (GTK_COMBO_BOX (combo_box));
 300       column_type = gtk_tree_model_get_column_type (model, text_column);
 301       g_return_val_if_fail (column_type == G_TYPE_STRING, NULL);
 302       gtk_tree_model_get (model, &iter, text_column, &text, -1);
 303     }
 304
 305   return text;
 306 }