[gtk+] docs: Move documentation to inline comments: GtkComboBox
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] docs: Move documentation to inline comments: GtkComboBox
- Date: Mon, 4 Oct 2010 00:46:34 +0000 (UTC)
commit 5a30dad53108fe3ffa269a4ad7597980adee4580
Author: Javier Jardón <jjardon gnome org>
Date: Mon Oct 4 02:05:45 2010 +0200
docs: Move documentation to inline comments: GtkComboBox
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtkcombobox.sgml | 461 ------------------------------
gtk/gtkcombobox.c | 31 ++
gtk/gtknotebook.c | 5 +-
4 files changed, 34 insertions(+), 464 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index e218018..24fa3ad 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -7,6 +7,7 @@ gtkbuilder.sgml
gtkbutton.sgml
gtkcalendar.sgml
gtkcelleditable.sgml
+gtkcombobox.sgml
gtkcomboboxentry.sgml
gtkeditable.sgml
gtkentrybuffer.sgml
diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c
index 6076c6c..aeb5e91 100644
--- a/gtk/gtkcombobox.c
+++ b/gtk/gtkcombobox.c
@@ -52,6 +52,37 @@
#include "gtktreeprivate.h"
+
+/**
+ * SECTION:gtkcombobox
+ * @Short_description: A widget used to choose from a list of items
+ * @Title: GtkComboBox
+ * @See_also: #GtkComboBoxEntry, #GtkTreeModel, #GtkCellRenderer
+ *
+ * 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 Windows-style combo box.
+ *
+ * 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.
+ *
+ * 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().
+ */
+
+
/* WELCOME, to THE house of evil code */
typedef struct _ComboCellInfo ComboCellInfo;
diff --git a/gtk/gtknotebook.c b/gtk/gtknotebook.c
index 95e1325..beb19d8 100644
--- a/gtk/gtknotebook.c
+++ b/gtk/gtknotebook.c
@@ -72,12 +72,11 @@
* of the tab must be created before the tab can be filled.
* A tab child can be specified without specifying a <child>
* type attribute.
- * </para>
- * <para>
+ *
* To add a child widget in the notebooks action area, specify
* "action-start" or "action-end" as the "type" attribute of the <child>
* element.
- * <para>
+ * </para>
* <example>
* <title>A UI definition fragment with GtkNotebook</title>
* <programlisting><![CDATA[
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]