1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2010 Christian Dywan
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.
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.
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/>.
21 #include "gtkcomboboxtext.h"
22 #include "gtkcombobox.h"
23 #include "gtkcellrenderertext.h"
24 #include "gtkcelllayout.h"
27 * SECTION:gtkcomboboxtext
28 * @Short_description: A simple, text-only combo box
29 * @Title: GtkComboBoxText
30 * @See_also: #GtkComboBox
32 * A GtkComboBoxText is a simple variant of #GtkComboBox that hides
33 * the model-view complexity for simple text-only use cases.
35 * To create a GtkComboBoxText, use gtk_combo_box_text_new() or
36 * gtk_combo_box_text_new_with_entry().
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().
44 G_DEFINE_TYPE (GtkComboBoxText, gtk_combo_box_text, GTK_TYPE_COMBO_BOX);
47 gtk_combo_box_text_constructor (GType type,
48 guint n_construct_properties,
49 GObjectConstructParam *construct_properties)
53 object = G_OBJECT_CLASS (gtk_combo_box_text_parent_class)->constructor
54 (type, n_construct_properties, construct_properties);
56 if (!gtk_combo_box_get_has_entry (GTK_COMBO_BOX (object)))
58 GtkCellRenderer *cell;
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,
71 gtk_combo_box_text_init (GtkComboBoxText *combo_box)
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);
81 gtk_combo_box_text_class_init (GtkComboBoxTextClass *klass)
83 GObjectClass *object_class;
85 object_class = (GObjectClass *)klass;
86 object_class->constructor = gtk_combo_box_text_constructor;
91 * gtk_combo_box_text_new:
93 * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
94 * strings. See gtk_combo_box_entry_new_with_text().
96 * Return value: A new #GtkComboBoxText
101 gtk_combo_box_text_new (void)
103 return g_object_new (GTK_TYPE_COMBO_BOX_TEXT,
104 "entry-text-column", 0,
110 * gtk_combo_box_text_new_with_entry:
112 * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
113 * strings. The combo box created by this function has an entry.
115 * Return value: a new #GtkComboBoxText
120 gtk_combo_box_text_new_with_entry (void)
122 return g_object_new (GTK_TYPE_COMBO_BOX_TEXT,
124 "entry-text-column", 0,
130 * gtk_combo_box_text_append_text:
131 * @combo_box: A #GtkComboBoxText
134 * Appends @text to the list of strings stored in @combo_box.
139 gtk_combo_box_text_append_text (GtkComboBoxText *combo_box,
142 gtk_combo_box_text_insert_text (combo_box, G_MAXINT, text);
146 * gtk_combo_box_text_prepend_text:
147 * @combo_box: A #GtkComboBox
150 * Prepends @text to the list of strings stored in @combo_box.
155 gtk_combo_box_text_prepend_text (GtkComboBoxText *combo_box,
158 gtk_combo_box_text_insert_text (combo_box, 0, text);
162 * gtk_combo_box_text_insert_text:
163 * @combo_box: A #GtkComboBoxText
164 * @position: An index to insert @text
167 * Inserts @text at @position in the list of strings stored in @combo_box.
172 gtk_combo_box_text_insert_text (GtkComboBoxText *combo_box,
176 gtk_combo_box_text_insert_text_with_id (combo_box, position, text, 0);
180 * gtk_combo_box_text_insert_text_with_id:
181 * @combo_box: A #GtkComboBoxText
182 * @position: An index to insert @text
184 * @id: a numeric ID for this value
186 * Inserts @text at @position in the list of strings stored in @combo_box,
187 * and sets its numeric ID to @id. See #GtkComboBox::id-column.
192 gtk_combo_box_text_insert_text_with_id (GtkComboBoxText *combo_box,
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);
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));
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);
219 gtk_list_store_insert (store, &iter, position);
220 gtk_list_store_set (store, &iter, text_column, text, id_column, id, -1);
225 * gtk_combo_box_text_remove:
226 * @combo_box: A #GtkComboBox
227 * @position: Index of the item to remove
229 * Removes the string at @position from @combo_box.
234 gtk_combo_box_text_remove (GtkComboBoxText *combo_box,
241 g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
242 g_return_if_fail (position >= 0);
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));
248 if (gtk_tree_model_iter_nth_child (model, &iter, NULL, position))
249 gtk_list_store_remove (store, &iter);
253 * gtk_combo_box_text_remove_all:
254 * @combo_box: A #GtkComboBoxText
256 * Removes all the text entries from the combo box.
261 gtk_combo_box_text_remove_all (GtkComboBoxText *combo_box)
265 g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box));
267 store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)));
268 gtk_list_store_clear (store);
272 * gtk_combo_box_text_get_active_text:
273 * @combo_box: A #GtkComboBoxText
275 * Returns the currently active string in @combo_box or %NULL if none
278 * Returns: a newly allocated string containing the currently active text.
279 * Must be freed with g_free().
284 gtk_combo_box_text_get_active_text (GtkComboBoxText *combo_box)
289 g_return_val_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box), NULL);
291 if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (combo_box), &iter))
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);