gtk2/docs/reference/gtk/tmpl/gtkcomboboxentry.sgml

119 lines
2.7 KiB
Plaintext
Raw Normal View History

<!-- ##### SECTION Title ##### -->
GtkComboBoxEntry
<!-- ##### SECTION Short_Description ##### -->
A text entry field with a dropdown list
<!-- ##### SECTION Long_Description ##### -->
<para>
2004-12-02 21:51:48 +00:00
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>
2004-12-02 21:51:48 +00:00
<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()),
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().
</para>
<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>
<para>
The convenience API to construct simple text-only #GtkComboBox<!-- -->es
can also be used with #GtkComboBoxEntry<!-- -->s which have been constructed
2004-12-02 21:51:48 +00:00
with gtk_combo_box_entry_new_text().
</para>
<para>
If you have special needs that go beyond a simple entry (e.g. input validation),
it is possible to replace the child entry by a different widget using
gtk_container_remove() and gtk_container_add().
</para>
<refsect2 id="GtkComboBoxEntry-BUILDER-UI">
<title>GtkComboBoxEntry as GtkBuildable</title>
<para>
Beyond the &lt;attributes&gt; support that is shared by all
<link linkend="GtkCellLayout-BUILDER-UI">GtkCellLayout</link> implementation,
GtkComboBoxEntry makes the entry available in UI definitions as an internal
child with name "entry".
</para>
</refsect2>
2004-12-02 21:51:48 +00:00
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkComboBox
</para>
2005-06-20 22:06:27 +00:00
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkComboBoxEntry ##### -->
<para>
</para>
<!-- ##### ARG GtkComboBoxEntry:text-column ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_combo_box_entry_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_combo_box_entry_new_with_model ##### -->
<para>
</para>
@model:
@text_column:
@Returns:
<!-- ##### FUNCTION gtk_combo_box_entry_new_text ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_combo_box_entry_set_text_column ##### -->
<para>
</para>
@entry_box:
@text_column:
<!-- ##### FUNCTION gtk_combo_box_entry_get_text_column ##### -->
<para>
</para>
@entry_box:
@Returns: