summaryrefslogtreecommitdiff
path: root/gtk/gtkcomboboxentry.c
diff options
context:
space:
mode:
authorKristian Rietveld <kris@gtk.org>2003-10-02 21:30:11 +0000
committerKristian Rietveld <kristian@src.gnome.org>2003-10-02 21:30:11 +0000
commit316109ea096e64b11aec6c47982b47ffd78e40c0 (patch)
tree3a5014344de48f5f492e8ff1d288ea82cb6d6e0c /gtk/gtkcomboboxentry.c
parent186f883d5cbc13a36a67202bcc09d4e06a977b91 (diff)
downloadgtk+-316109ea096e64b11aec6c47982b47ffd78e40c0.tar.gz
Added API doc comments.
Thu Oct 2 23:28:02 2003 Kristian Rietveld <kris@gtk.org> * gtk/gtkcombobox.c: Added API doc comments. * gtk/gtkcomboboxentry.c: Ditto.
Diffstat (limited to 'gtk/gtkcomboboxentry.c')
-rw-r--r--gtk/gtkcomboboxentry.c27
1 files changed, 27 insertions, 0 deletions
diff --git a/gtk/gtkcomboboxentry.c b/gtk/gtkcomboboxentry.c
index d2e907e6fa..1e08b1aaee 100644
--- a/gtk/gtkcomboboxentry.c
+++ b/gtk/gtkcomboboxentry.c
@@ -135,6 +135,22 @@ gtk_combo_box_entry_contents_changed (GtkEntry *entry,
}
/* public API */
+
+/**
+ * gtk_combo_box_entry_new:
+ * @model: A #GtkTreeModel.
+ * @text_column: A column in @model to get the strings from.
+ *
+ * Creates a new #GtkComboBoxEntry which has a #GtkEntry as child and a list
+ * of strings as popup. You can get the #GtkEntry from a #GtkComboBoxEntry
+ * using GTK_ENTRY (GTK_BIN (combo_box_entry)->child). To add and remove
+ * strings from the list, just modify @model using it's data manipulation
+ * API.
+ *
+ * Return value: A new #GtkComboBoxEntry.
+ *
+ * Since: 2.4
+ */
GtkWidget *
gtk_combo_box_entry_new (GtkTreeModel *model,
gint text_column)
@@ -170,6 +186,17 @@ gtk_combo_box_entry_new (GtkTreeModel *model,
return ret;
}
+/**
+ * gtk_combo_box_entry_get_text_column:
+ * @entry_box: A #GtkComboBoxEntry.
+ *
+ * Returns the column which @entry_box is using to get the strings from.
+ * This is the same column which got passed during construction.
+ *
+ * Return value: A column in the data source model of @entry_box.
+ *
+ * Since: 2.4
+ */
gint
gtk_combo_box_entry_get_text_column (GtkComboBoxEntry *entry_box)
{