| /* GTK - The GIMP Toolkit |
| * |
| * Copyright (C) 2010 Christian Dywan |
| * |
| * This library is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU Lesser General Public |
| * License as published by the Free Software Foundation; either |
| * version 2 of the License, or (at your option) any later version. |
| * |
| * This library is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * Lesser General Public License for more details. |
| * |
| * You should have received a copy of the GNU Lesser General Public |
| * License along with this library. If not, see <http://www.gnu.org/licenses/>. |
| */ |
| |
| #include "config.h" |
| |
| #include "gtkcomboboxtext.h" |
| #include "gtkcombobox.h" |
| #include "gtkcellrenderertext.h" |
| #include "gtkcelllayout.h" |
| #include "gtkbuildable.h" |
| #include "gtkbuilderprivate.h" |
| |
| #include <string.h> |
| |
| /** |
| * SECTION:gtkcomboboxtext |
| * @Short_description: A simple, text-only combo box |
| * @Title: GtkComboBoxText |
| * @See_also: #GtkComboBox |
| * |
| * A GtkComboBoxText is a simple variant of #GtkComboBox that hides |
| * the model-view complexity for simple text-only use cases. |
| * |
| * To create a GtkComboBoxText, use gtk_combo_box_text_new() or |
| * gtk_combo_box_text_new_with_entry(). |
| * |
| * You can add items to a GtkComboBoxText with |
| * gtk_combo_box_text_append_text(), gtk_combo_box_text_insert_text() |
| * or gtk_combo_box_text_prepend_text() and remove options with |
| * gtk_combo_box_text_remove(). |
| * |
| * If the GtkComboBoxText contains an entry (via the 'has-entry' property), |
| * its contents can be retrieved using gtk_combo_box_text_get_active_text(). |
| * The entry itself can be accessed by calling gtk_bin_get_child() on the |
| * combo box. |
| * |
| * You should not call gtk_combo_box_set_model() or attempt to pack more cells |
| * into this combo box via its GtkCellLayout interface. |
| * |
| * <refsect2 id="GtkComboBoxText-BUILDER-UI"> |
| * <title>GtkComboBoxText as GtkBuildable</title> |
| * <para> |
| * The GtkComboBoxText implementation of the GtkBuildable interface |
| * supports adding items directly using the <items> element |
| * and specifying <item> elements for each item. Each <item> |
| * element supports the regular translation attributes "translatable", |
| * "context" and "comments". |
| * |
| * <example> |
| * <title>A UI definition fragment specifying GtkComboBoxText items</title> |
| * <programlisting><![CDATA[ |
| * <object class="GtkComboBoxText"> |
| * <items> |
| * <item translatable="yes">Factory</item> |
| * <item translatable="yes">Home</item> |
| * <item translatable="yes">Subway</item> |
| * </items> |
| * </object> |
| * ]]></programlisting> |
| * </example> |
| * </para> |
| * </refsect2> |
| */ |
| |
| static void gtk_combo_box_text_buildable_interface_init (GtkBuildableIface *iface); |
| static gboolean gtk_combo_box_text_buildable_custom_tag_start (GtkBuildable *buildable, |
| GtkBuilder *builder, |
| GObject *child, |
| const gchar *tagname, |
| GMarkupParser *parser, |
| gpointer *data); |
| |
| static void gtk_combo_box_text_buildable_custom_finished (GtkBuildable *buildable, |
| GtkBuilder *builder, |
| GObject *child, |
| const gchar *tagname, |
| gpointer user_data); |
| |
| static GtkBuildableIface *buildable_parent_iface = NULL; |
| |
| G_DEFINE_TYPE_WITH_CODE (GtkComboBoxText, gtk_combo_box_text, GTK_TYPE_COMBO_BOX, |
| G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE, |
| gtk_combo_box_text_buildable_interface_init)); |
| |
| static GObject * |
| gtk_combo_box_text_constructor (GType type, |
| guint n_construct_properties, |
| GObjectConstructParam *construct_properties) |
| { |
| GObject *object; |
| const gint text_column = 0; |
| |
| object = G_OBJECT_CLASS (gtk_combo_box_text_parent_class)->constructor |
| (type, n_construct_properties, construct_properties); |
| |
| gtk_combo_box_set_entry_text_column (GTK_COMBO_BOX (object), text_column); |
| gtk_combo_box_set_id_column (GTK_COMBO_BOX (object), 1); |
| |
| if (!gtk_combo_box_get_has_entry (GTK_COMBO_BOX (object))) |
| { |
| GtkCellRenderer *cell; |
| |
| cell = gtk_cell_renderer_text_new (); |
| gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (object), cell, TRUE); |
| gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (object), cell, |
| "text", text_column, |
| NULL); |
| } |
| |
| return object; |
| } |
| |
| static void |
| gtk_combo_box_text_init (GtkComboBoxText *combo_box) |
| { |
| GtkListStore *store; |
| |
| store = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_STRING); |
| gtk_combo_box_set_model (GTK_COMBO_BOX (combo_box), GTK_TREE_MODEL (store)); |
| g_object_unref (store); |
| } |
| |
| static void |
| gtk_combo_box_text_class_init (GtkComboBoxTextClass *klass) |
| { |
| GObjectClass *object_class; |
| |
| object_class = (GObjectClass *)klass; |
| object_class->constructor = gtk_combo_box_text_constructor; |
| } |
| |
| static void |
| gtk_combo_box_text_buildable_interface_init (GtkBuildableIface *iface) |
| { |
| buildable_parent_iface = g_type_interface_peek_parent (iface); |
| |
| iface->custom_tag_start = gtk_combo_box_text_buildable_custom_tag_start; |
| iface->custom_finished = gtk_combo_box_text_buildable_custom_finished; |
| } |
| |
| typedef struct { |
| GtkBuilder *builder; |
| GObject *object; |
| const gchar *domain; |
| gchar *id; |
| |
| GString *string; |
| |
| gchar *context; |
| guint translatable : 1; |
| |
| guint is_text : 1; |
| } ItemParserData; |
| |
| static void |
| item_start_element (GMarkupParseContext *context, |
| const gchar *element_name, |
| const gchar **names, |
| const gchar **values, |
| gpointer user_data, |
| GError **error) |
| { |
| ItemParserData *data = (ItemParserData*)user_data; |
| guint i; |
| |
| if (strcmp (element_name, "item") == 0) |
| { |
| data->is_text = TRUE; |
| |
| for (i = 0; names[i]; i++) |
| { |
| if (strcmp (names[i], "translatable") == 0) |
| { |
| gboolean bval; |
| |
| if (!_gtk_builder_boolean_from_string (values[i], &bval, |
| error)) |
| return; |
| |
| data->translatable = bval; |
| } |
| else if (strcmp (names[i], "comments") == 0) |
| { |
| /* do nothing, comments are for translators */ |
| } |
| else if (strcmp (names[i], "context") == 0) |
| data->context = g_strdup (values[i]); |
| else if (strcmp (names[i], "id") == 0) |
| data->id = g_strdup (values[i]); |
| else |
| g_warning ("Unknown custom combo box item attribute: %s", names[i]); |
| } |
| } |
| } |
| |
| static void |
| item_text (GMarkupParseContext *context, |
| const gchar *text, |
| gsize text_len, |
| gpointer user_data, |
| GError **error) |
| { |
| ItemParserData *data = (ItemParserData*)user_data; |
| |
| if (data->is_text) |
| g_string_append_len (data->string, text, text_len); |
| } |
| |
| static void |
| item_end_element (GMarkupParseContext *context, |
| const gchar *element_name, |
| gpointer user_data, |
| GError **error) |
| { |
| ItemParserData *data = (ItemParserData*)user_data; |
| |
| /* Append the translated strings */ |
| if (data->string->len) |
| { |
| if (data->translatable) |
| { |
| gchar *translated; |
| |
| /* FIXME: This will not use the domain set in the .ui file, |
| * since the parser is not telling the builder about the domain. |
| * However, it will work for gtk_builder_set_translation_domain() calls. |
| */ |
| translated = _gtk_builder_parser_translate (data->domain, |
| data->context, |
| data->string->str); |
| g_string_set_size (data->string, 0); |
| g_string_append (data->string, translated); |
| } |
| |
| gtk_combo_box_text_append (GTK_COMBO_BOX_TEXT (data->object), data->id, data->string->str); |
| } |
| |
| data->translatable = FALSE; |
| g_string_set_size (data->string, 0); |
| g_free (data->context); |
| data->context = NULL; |
| g_free (data->id); |
| data->id = NULL; |
| data->is_text = FALSE; |
| } |
| |
| static const GMarkupParser item_parser = |
| { |
| item_start_element, |
| item_end_element, |
| item_text |
| }; |
| |
| static gboolean |
| gtk_combo_box_text_buildable_custom_tag_start (GtkBuildable *buildable, |
| GtkBuilder *builder, |
| GObject *child, |
| const gchar *tagname, |
| GMarkupParser *parser, |
| gpointer *data) |
| { |
| if (buildable_parent_iface->custom_tag_start (buildable, builder, child, |
| tagname, parser, data)) |
| return TRUE; |
| |
| if (strcmp (tagname, "items") == 0) |
| { |
| ItemParserData *parser_data; |
| |
| parser_data = g_slice_new0 (ItemParserData); |
| parser_data->builder = g_object_ref (builder); |
| parser_data->object = g_object_ref (buildable); |
| parser_data->domain = gtk_builder_get_translation_domain (builder); |
| parser_data->string = g_string_new (""); |
| *parser = item_parser; |
| *data = parser_data; |
| return TRUE; |
| } |
| return FALSE; |
| } |
| |
| static void |
| gtk_combo_box_text_buildable_custom_finished (GtkBuildable *buildable, |
| GtkBuilder *builder, |
| GObject *child, |
| const gchar *tagname, |
| gpointer user_data) |
| { |
| ItemParserData *data; |
| |
| buildable_parent_iface->custom_finished (buildable, builder, child, |
| tagname, user_data); |
| |
| if (strcmp (tagname, "items") == 0) |
| { |
| data = (ItemParserData*)user_data; |
| |
| g_object_unref (data->object); |
| g_object_unref (data->builder); |
| g_string_free (data->string, TRUE); |
| g_slice_free (ItemParserData, data); |
| } |
| } |
| |
| /** |
| * gtk_combo_box_text_new: |
| * |
| * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying |
| * strings. |
| * |
| * Return value: A new #GtkComboBoxText |
| * |
| * Since: 2.24 |
| */ |
| GtkWidget * |
| gtk_combo_box_text_new (void) |
| { |
| return g_object_new (GTK_TYPE_COMBO_BOX_TEXT, |
| NULL); |
| } |
| |
| /** |
| * gtk_combo_box_text_new_with_entry: |
| * |
| * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying |
| * strings. The combo box created by this function has an entry. |
| * |
| * Return value: a new #GtkComboBoxText |
| * |
| * Since: 2.24 |
| */ |
| GtkWidget * |
| gtk_combo_box_text_new_with_entry (void) |
| { |
| return g_object_new (GTK_TYPE_COMBO_BOX_TEXT, |
| "has-entry", TRUE, |
| NULL); |
| } |
| |
| /** |
| * gtk_combo_box_text_append_text: |
| * @combo_box: A #GtkComboBoxText |
| * @text: A string |
| * |
| * Appends @text to the list of strings stored in @combo_box. |
| * |
| * This is the same as calling gtk_combo_box_text_insert_text() with a |
| * position of -1. |
| * |
| * Since: 2.24 |
| */ |
| void |
| gtk_combo_box_text_append_text (GtkComboBoxText *combo_box, |
| const gchar *text) |
| { |
| gtk_combo_box_text_insert (combo_box, -1, NULL, text); |
| } |
| |
| /** |
| * gtk_combo_box_text_prepend_text: |
| * @combo_box: A #GtkComboBox |
| * @text: A string |
| * |
| * Prepends @text to the list of strings stored in @combo_box. |
| * |
| * This is the same as calling gtk_combo_box_text_insert_text() with a |
| * position of 0. |
| * |
| * Since: 2.24 |
| */ |
| void |
| gtk_combo_box_text_prepend_text (GtkComboBoxText *combo_box, |
| const gchar *text) |
| { |
| gtk_combo_box_text_insert (combo_box, 0, NULL, text); |
| } |
| |
| /** |
| * gtk_combo_box_text_insert_text: |
| * @combo_box: A #GtkComboBoxText |
| * @position: An index to insert @text |
| * @text: A string |
| * |
| * Inserts @text at @position in the list of strings stored in @combo_box. |
| * |
| * If @position is negative then @text is appended. |
| * |
| * This is the same as calling gtk_combo_box_text_insert() with a %NULL |
| * ID string. |
| * |
| * Since: 2.24 |
| */ |
| void |
| gtk_combo_box_text_insert_text (GtkComboBoxText *combo_box, |
| gint position, |
| const gchar *text) |
| { |
| gtk_combo_box_text_insert (combo_box, position, NULL, text); |
| } |
| |
| /** |
| * gtk_combo_box_text_append: |
| * @combo_box: A #GtkComboBoxText |
| * @id: (allow-none): a string ID for this value, or %NULL |
| * @text: A string |
| * |
| * Appends @text to the list of strings stored in @combo_box. |
| * If @id is non-%NULL then it is used as the ID of the row. |
| * |
| * This is the same as calling gtk_combo_box_text_insert() with a |
| * position of -1. |
| * |
| * Since: 2.24 |
| */ |
| void |
| gtk_combo_box_text_append (GtkComboBoxText *combo_box, |
| const gchar *id, |
| const gchar *text) |
| { |
| gtk_combo_box_text_insert (combo_box, -1, id, text); |
| } |
| |
| /** |
| * gtk_combo_box_text_prepend: |
| * @combo_box: A #GtkComboBox |
| * @id: (allow-none): a string ID for this value, or %NULL |
| * @text: a string |
| * |
| * Prepends @text to the list of strings stored in @combo_box. |
| * If @id is non-%NULL then it is used as the ID of the row. |
| * |
| * This is the same as calling gtk_combo_box_text_insert() with a |
| * position of 0. |
| * |
| * Since: 2.24 |
| */ |
| void |
| gtk_combo_box_text_prepend (GtkComboBoxText *combo_box, |
| const gchar *id, |
| const gchar *text) |
| { |
| gtk_combo_box_text_insert (combo_box, 0, id, text); |
| } |
| |
| |
| /** |
| * gtk_combo_box_text_insert: |
| * @combo_box: A #GtkComboBoxText |
| * @position: An index to insert @text |
| * @id: (allow-none): a string ID for this value, or %NULL |
| * @text: A string to display |
| * |
| * Inserts @text at @position in the list of strings stored in @combo_box. |
| * If @id is non-%NULL then it is used as the ID of the row. See |
| * #GtkComboBox:id-column. |
| * |
| * If @position is negative then @text is appended. |
| * |
| * Since: 3.0 |
| */ |
| void |
| gtk_combo_box_text_insert (GtkComboBoxText *combo_box, |
| gint position, |
| const gchar *id, |
| const gchar *text) |
| { |
| GtkListStore *store; |
| GtkTreeIter iter; |
| gint text_column; |
| gint column_type; |
| |
| g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box)); |
| g_return_if_fail (text != NULL); |
| |
| store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box))); |
| g_return_if_fail (GTK_IS_LIST_STORE (store)); |
| |
| text_column = gtk_combo_box_get_entry_text_column (GTK_COMBO_BOX (combo_box)); |
| |
| if (gtk_combo_box_get_has_entry (GTK_COMBO_BOX (combo_box))) |
| g_return_if_fail (text_column >= 0); |
| else if (text_column < 0) |
| text_column = 0; |
| |
| column_type = gtk_tree_model_get_column_type (GTK_TREE_MODEL (store), text_column); |
| g_return_if_fail (column_type == G_TYPE_STRING); |
| |
| if (position < 0) |
| gtk_list_store_append (store, &iter); |
| else |
| gtk_list_store_insert (store, &iter, position); |
| |
| gtk_list_store_set (store, &iter, text_column, text, -1); |
| |
| if (id != NULL) |
| { |
| gint id_column; |
| |
| id_column = gtk_combo_box_get_id_column (GTK_COMBO_BOX (combo_box)); |
| g_return_if_fail (id_column >= 0); |
| column_type = gtk_tree_model_get_column_type (GTK_TREE_MODEL (store), id_column); |
| g_return_if_fail (column_type == G_TYPE_STRING); |
| |
| gtk_list_store_set (store, &iter, id_column, id, -1); |
| } |
| } |
| |
| /** |
| * gtk_combo_box_text_remove: |
| * @combo_box: A #GtkComboBox |
| * @position: Index of the item to remove |
| * |
| * Removes the string at @position from @combo_box. |
| * |
| * Since: 2.24 |
| */ |
| void |
| gtk_combo_box_text_remove (GtkComboBoxText *combo_box, |
| gint position) |
| { |
| GtkTreeModel *model; |
| GtkListStore *store; |
| GtkTreeIter iter; |
| |
| g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box)); |
| g_return_if_fail (position >= 0); |
| |
| model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)); |
| store = GTK_LIST_STORE (model); |
| g_return_if_fail (GTK_IS_LIST_STORE (store)); |
| |
| if (gtk_tree_model_iter_nth_child (model, &iter, NULL, position)) |
| gtk_list_store_remove (store, &iter); |
| } |
| |
| /** |
| * gtk_combo_box_text_remove_all: |
| * @combo_box: A #GtkComboBoxText |
| * |
| * Removes all the text entries from the combo box. |
| * |
| * Since: 3.0 |
| */ |
| void |
| gtk_combo_box_text_remove_all (GtkComboBoxText *combo_box) |
| { |
| GtkListStore *store; |
| |
| g_return_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box)); |
| |
| store = GTK_LIST_STORE (gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box))); |
| gtk_list_store_clear (store); |
| } |
| |
| /** |
| * gtk_combo_box_text_get_active_text: |
| * @combo_box: A #GtkComboBoxText |
| * |
| * Returns the currently active string in @combo_box, or %NULL |
| * if none is selected. If @combo_box contains an entry, this |
| * function will return its contents (which will not necessarily |
| * be an item from the list). |
| * |
| * Returns: a newly allocated string containing the currently |
| * active text. Must be freed with g_free(). |
| * |
| * Since: 2.24 |
| */ |
| gchar * |
| gtk_combo_box_text_get_active_text (GtkComboBoxText *combo_box) |
| { |
| GtkTreeIter iter; |
| gchar *text = NULL; |
| |
| g_return_val_if_fail (GTK_IS_COMBO_BOX_TEXT (combo_box), NULL); |
| |
| if (gtk_combo_box_get_has_entry (GTK_COMBO_BOX (combo_box))) |
| { |
| GtkWidget *entry; |
| |
| entry = gtk_bin_get_child (GTK_BIN (combo_box)); |
| text = g_strdup (gtk_entry_get_text (GTK_ENTRY (entry))); |
| } |
| else if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (combo_box), &iter)) |
| { |
| GtkTreeModel *model; |
| gint text_column; |
| gint column_type; |
| |
| model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box)); |
| g_return_val_if_fail (GTK_IS_LIST_STORE (model), NULL); |
| text_column = gtk_combo_box_get_entry_text_column (GTK_COMBO_BOX (combo_box)); |
| g_return_val_if_fail (text_column >= 0, NULL); |
| column_type = gtk_tree_model_get_column_type (model, text_column); |
| g_return_val_if_fail (column_type == G_TYPE_STRING, NULL); |
| gtk_tree_model_get (model, &iter, text_column, &text, -1); |
| } |
| |
| return text; |
| } |