forked from AuroraMiddleware/gtk
Add long descriptions.
This commit is contained in:
parent
bc63304b92
commit
f9d9bae64e
@ -1,3 +1,8 @@
|
|||||||
|
2004-12-02 Matthias Clasen <mclasen@redhat.com>
|
||||||
|
|
||||||
|
* gtk/tmpl/gtkcombobox.sgml:
|
||||||
|
* gtk/tmpl/gtkcomboboxentry.sgml: Add long descriptions.
|
||||||
|
|
||||||
2004-12-01 Matthias Clasen <mclasen@redhat.com>
|
2004-12-01 Matthias Clasen <mclasen@redhat.com>
|
||||||
|
|
||||||
* gdk/tmpl/windows.sgml: Document all window types. (#160149,
|
* gdk/tmpl/windows.sgml: Document all window types. (#160149,
|
||||||
|
@ -6,12 +6,37 @@ A widget used to choose from a list of items
|
|||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
A #GtkComboBox is a widget that allows the user to choose from a
|
||||||
|
list of valid choices. The #GtkComboBox displays the selected
|
||||||
|
choice. When activated, the #GtkComboBox displays a popup
|
||||||
|
which allows the user to make a new choice. The style in which
|
||||||
|
the selected value is displayed, and the style of the popup is
|
||||||
|
determined by the current theme. It may be similar to a #GtkOptionMenu,
|
||||||
|
or similar to a Windows-style combo box.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Unlike its predecessors #GtkCombo and #GtkOptionMenu, the #GtkComboBox
|
||||||
|
uses the model-view pattern; the list of valid choices is specified in the
|
||||||
|
form of a tree model, and the display of the choices can be adapted to
|
||||||
|
the data in the model by using cell renderers, as you would in a tree view.
|
||||||
|
This is possible since #GtkComboBox implements the #GtkCellLayout interface.
|
||||||
|
The tree model holding the valid choices is not restricted to a flat list,
|
||||||
|
it can be a real tree, and the popup will reflect the tree structure.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
In addition to the model-view API, #GtkComboBox offers a simple API which
|
||||||
|
is suitable for text-only combo boxes, and hides the complexity of managing
|
||||||
|
the data in a model. It consists of the functions gtk_combo_box_new_text(),
|
||||||
|
gtk_combo_box_append_text(), gtk_combo_box_insert_text(),
|
||||||
|
gtk_combo_box_prepend_text(), gtk_combo_box_remove_text() and
|
||||||
|
gtk_combo_box_get_active_text().
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### SECTION See_Also ##### -->
|
<!-- ##### SECTION See_Also ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
#GtkComboBoxEntry, #GtkTreeModel, #GtkCellRenderer
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### STRUCT GtkComboBox ##### -->
|
<!-- ##### STRUCT GtkComboBox ##### -->
|
||||||
|
@ -6,12 +6,27 @@ A text entry field with a dropdown list
|
|||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
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>
|
||||||
|
|
||||||
|
<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.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
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>
|
</para>
|
||||||
|
|
||||||
<!-- ##### SECTION See_Also ##### -->
|
<!-- ##### SECTION See_Also ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
#GtkComboBox
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### STRUCT GtkComboBoxEntry ##### -->
|
<!-- ##### STRUCT GtkComboBoxEntry ##### -->
|
||||||
|
Loading…
Reference in New Issue
Block a user