AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Move documentation to inline comments: GtkComboBoxEntry

Browse Source 
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=617308

Signed-off-by: Javier Jardón <jjardon@gnome.org>
This commit is contained in:
Garrett Regier 2010-10-02 21:17:48 +02:00 committed by Javier Jardón
parent 5fbd77526a
commit 5fcf06bb91
3 changed files with 43 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/gtk/tmpl/.gitignore vendored
View File

@ -7,6 +7,7 @@ gtkbuilder.sgml
gtkbutton.sgml
gtkcalendar.sgml
gtkcelleditable.sgml
gtkcomboboxentry.sgml
gtkeditable.sgml
gtkhbox.sgml
gtkiconview.sgml

123
docs/reference/gtk/tmpl/gtkcomboboxentry.sgml
View File

@ -1,123 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkComboBoxEntry
<!-- ##### SECTION Short_Description ##### -->
A text entry field with a dropdown list
<!-- ##### SECTION Long_Description ##### -->
<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.
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
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>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkComboBox
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkComboBoxEntry ##### -->
<para>
</para>
<!-- ##### ARG GtkComboBoxEntry:text-column ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_combo_box_entry_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_combo_box_entry_new_with_model ##### -->
<para>
</para>
@model:
@text_column:
@Returns:
<!-- ##### FUNCTION gtk_combo_box_entry_new_text ##### -->
<para>
</para>
@void:
@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:

42
gtk/gtkcomboboxentry.c
View File

@ -30,6 +30,48 @@
#include "gtkbuildable.h"
/**
* SECTION:gtkcomboboxentry
* @Short_description: A text entry field with a dropdown list
* @Title: GtkComboBoxEntry
* @See_also:#GtkComboBox
*
* 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.
*
* 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().
*
* 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.
*
* Connect to the activate signal of the GtkEntry (use gtk_bin_get_child())
* to detect when the user actually finishes entering text.
*
* 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().
*
* 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().
*
* <refsect2 id="GtkComboBoxEntry-BUILDER-UI">
* <title>GtkComboBoxEntry as GtkBuildable</title>
* 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".
* </refsect2>
*/
struct _GtkComboBoxEntryPrivate
{
GtkCellRenderer *text_renderer;