gtkcomboboxentry.sgml 2.15 KB
Newer Older
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkComboBoxEntry

<!-- ##### SECTION Short_Description ##### -->
5
A text entry field with a dropdown list
6 7 8

<!-- ##### SECTION Long_Description ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
9 10 11 12 13
A #GtkComboBoxEntry is a widget that allows the user to choose from a
list of valid choices or enter a different value. It is very similar
to a #GtkComboBox, but it displays the selected value in an entry to
allow modifying it.
</para>
14

Matthias Clasen's avatar
Matthias Clasen committed
15 16 17
<para>
In contrast to a #GtkComboBox, the underlying model of a #GtkComboBoxEntry 
must always have a text column (see gtk_combo_box_entry_set_text_column()),
Ross Burton's avatar
Ross Burton committed
18 19
and the entry will show the content of the text column in the selected row.  To
get the text from the entry, use gtk_combo_box_get_active_text().
20
</para>
21 22 23 24 25 26 27 28 29

<para>The changed signal will be emitted while typing into a GtkComboBoxEntry, 
as well as when selecting an item from the GtkComboBoxEntry's list. Use 
gtk_combo_box_get_active() or gtk_combo_box_get_active_iter() to discover 
whether an item was actually selected from the list.
</para>

<para>Connect to the activate signal of the GtkEntry (use gtk_bin_get_child()) to 
detect when the user actually finishes entering text.</para>
30 31

<para>
Matthias Clasen's avatar
Matthias Clasen committed
32 33 34 35
The convenience API to construct simple text-only #GtkComboBox<!-- -->es can
also be used with #GtkComboBoxEntry<!-- -->s which have been constructed
with gtk_combo_box_entry_new_text().
</para>
36

Matthias Clasen's avatar
Matthias Clasen committed
37 38 39
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkComboBox
40 41
</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
42 43 44
<!-- ##### SECTION Stability_Level ##### -->


45 46 47 48 49
<!-- ##### STRUCT GtkComboBoxEntry ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
50

Soeren Sandmann's avatar
Soeren Sandmann committed
51 52 53 54 55
<!-- ##### ARG GtkComboBoxEntry:text-column ##### -->
<para>

</para>

56 57 58 59 60
<!-- ##### FUNCTION gtk_combo_box_entry_new ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
61 62 63 64 65 66 67 68 69 70 71
@Returns: 
<!-- # Unused Parameters # -->
@model: 
@text_column: 


<!-- ##### FUNCTION gtk_combo_box_entry_new_with_model ##### -->
<para>

</para>

72 73 74 75 76
@model: 
@text_column: 
@Returns: 


77 78 79 80 81 82 83 84
<!-- ##### FUNCTION gtk_combo_box_entry_new_text ##### -->
<para>

</para>

@Returns: 


Owen Taylor's avatar
Owen Taylor committed
85
<!-- ##### FUNCTION gtk_combo_box_entry_set_text_column ##### -->
86 87 88 89 90
<para>

</para>

@entry_box: 
Owen Taylor's avatar
Owen Taylor committed
91
@text_column: 
92 93


Owen Taylor's avatar
Owen Taylor committed
94
<!-- ##### FUNCTION gtk_combo_box_entry_get_text_column ##### -->
95 96 97 98
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
99 100 101 102
@entry_box: 
@Returns: