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 (1, G_TYPE_STRING);
  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                        NULL);
 106 }
 107
 108 /**
 109  * gtk_combo_box_text_new_with_entry:
 110  *
 111  * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
 112  * strings. The combo box created by this function has an entry.
 113  *
 114  * Return value: a new #GtkComboBoxText
 115  *
 116  * Since: 2.24
 117  */
 118 GtkWidget *
 119 gtk_combo_box_text_new_with_entry (void)
 120 {
 121   return g_object_new (GTK_TYPE_COMBO_BOX_TEXT,
 122                        "has-entry", TRUE,
 123                        "entry-text-column", 0,
 124                        NULL);
 125 }
 126
 127 /**
 128  * gtk_combo_box_text_append_text:
 129  * @combo_box: A #GtkComboBoxText
 130  * @text: A string
 131  *
 132  * Appends @text to the list of strings stored in @combo_box.
 133  *
 134  * Since: 2.24
 135  */
 136 void
 137 gtk_combo_box_text_append_text (GtkComboBoxText *combo_box,
 138                                 const gchar     *text)
 139 {
 140   gtk_combo_box_text_insert_text (combo_box, G_MAXINT, text);
 141 }
 142
 143 /**
 144  * gtk_combo_box_text_prepend_text:
 145  * @combo_box: A #GtkComboBox
 146  * @text: A string
 147  *
 148  * Prepends @text to the list of strings stored in @combo_box.
 149  *
 150  * Since: 2.24
 151  */
 152 void
 153 gtk_combo_box_text_prepend_text (GtkComboBoxText *combo_box,
 154                                  const gchar     *text)
 155 {
 156   gtk_combo_box_text_insert_text (combo_box, 0, text);
 157 }
 158
 159 /**
 160  * gtk_combo_box_text_insert_text:
 161  * @combo_box: A #GtkComboBoxText
 162  * @position: An index to insert @text
 163  * @text: A string
 164  *
 165  * Inserts @text at @position in the list of strings stored in @combo_box.
 166  *
 167  * Since: 2.24
 168  */
 169 void
 170 gtk_combo_box_text_insert_text (GtkComboBoxText *combo_box,
 171                                 gint             position,
 172                                 const gchar     *text)
 173 {
 174   GtkListStore *store;
 175   GtkTreeIter iter;
 176   gint text_column;
 177   gint column_type;
 178
 179   g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
 180   g_return_if_fail (position >= 0);
 181   g_return_if_fail (text != NULL);
 182
 183   store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)));
 184   g_return_if_fail (GTK_IS_LIST_STORE (store));
 185   text_column = gtk_combo_box_get_entry_text_column (GTK_COMBO_BOX (combo_box));
 186   column_type = gtk_tree_model_get_column_type (GTK_TREE_MODEL (store), text_column);
 187   g_return_if_fail (column_type == G_TYPE_STRING);
 188
 189   gtk_list_store_insert (store, &iter, position);
 190   gtk_list_store_set (store, &iter, text_column, text, -1);
 191 }
 192
 193 /**
 194  * gtk_combo_box_text_remove:
 195  * @combo_box: A #GtkComboBox
 196  * @position: Index of the item to remove
 197  *
 198  * Removes the string at @position from @combo_box.
 199  *
 200  * Since: 2.24
 201  */
 202 void
 203 gtk_combo_box_text_remove (GtkComboBoxText *combo_box,
 204                            gint             position)
 205 {
 206   GtkTreeModel *model;
 207   GtkListStore *store;
 208   GtkTreeIter iter;
 209
 210   g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
 211   g_return_if_fail (position >= 0);
 212
 213   model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));
 214   store = GTK_LIST_STORE (model);
 215   g_return_if_fail (GTK_IS_LIST_STORE (store));
 216
 217   if (gtk_tree_model_iter_nth_child (model, &iter, NULL, position))
 218     gtk_list_store_remove (store, &iter);
 219 }
 220
 221 /**
 222  * gtk_combo_box_text_remove_all:
 223  * @combo_box: A #GtkComboBoxText
 224  *
 225  * Removes all the text entries from the combo box.
 226  *
 227  * Since: 3.0
 228  */
 229 void
 230 gtk_combo_box_text_remove_all (GtkComboBoxText *combo_box)
 231 {
 232   GtkListStore *store;
 233
 234   g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
 235
 236   store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)));
 237   gtk_list_store_clear (store);
 238 }
 239
 240 /**
 241  * gtk_combo_box_text_get_active_text:
 242  * @combo_box: A #GtkComboBoxText
 243  *
 244  * Returns the currently active string in @combo_box or %NULL if none
 245  * is selected.
 246  *
 247  * Returns: a newly allocated string containing the currently active text.
 248  *     Must be freed with g_free().
 249  *
 250  * Since: 2.24
 251  */
 252 gchar *
 253 gtk_combo_box_text_get_active_text (GtkComboBoxText *combo_box)
 254 {
 255   GtkTreeIter iter;
 256   gchar *text = NULL;
 257
 258   g_return_val_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box), NULL);
 259
 260   if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (combo_box), &iter))
 261     {
 262       GtkTreeModel *model;
 263       gint text_column;
 264       gint column_type;
 265
 266       model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));
 267       g_return_val_if_fail (GTK_IS_LIST_STORE (model), NULL);
 268       text_column = gtk_combo_box_get_entry_text_column (GTK_COMBO_BOX (combo_box));
 269       column_type = gtk_tree_model_get_column_type (model, text_column);
 270       g_return_val_if_fail (column_type == G_TYPE_STRING, NULL);
 271       gtk_tree_model_get (model, &iter, text_column, &text, -1);
 272     }
 273
 274   return text;
 275 }