Commit 52e1722f authored by Milan Bouchet-Valat's avatar Milan Bouchet-Valat Committed by Matthias Clasen

GtkComboBox(Text): Add documentation about the entry

parent 06f6f7bd
......@@ -77,9 +77,14 @@
* not restricted to a flat list, it can be a real tree, and the popup will
* reflect the tree structure.
*
* To allow the user to enter values not in the model, the 'has-entry'
* property allows the GtkComboBox to contain a #GtkEntry. This entry
* can be accessed by calling gtk_bin_get_child() on the combo box.
*
* For a simple list of textual choices, the model-view API of GtkComboBox
* can be a bit overwhelming. In this case, #GtkComboBoxText offers a
* simple alternative.
* simple alternative. Both GtkComboBox and #GtkComboBoxText can contain
* an entry.
*/
......
......@@ -39,6 +39,11 @@
* 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.
*/
G_DEFINE_TYPE (GtkComboBoxText, gtk_combo_box_text, GTK_TYPE_COMBO_BOX);
......@@ -336,8 +341,9 @@ gtk_combo_box_text_remove_all (GtkComboBoxText *combo_box)
* 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.
* 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().
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment