[gtk+] Add docs for GtkComboBoxText



commit 3e9bdf6fd91175907c4b74b7a242a4ee0f5dbb11
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Oct 15 16:52:25 2010 -0400

    Add docs for GtkComboBoxText

 docs/reference/gtk/gtk-docs.sgml     |    1 +
 docs/reference/gtk/gtk3-sections.txt |   24 ++++++++++++++++++++++++
 docs/reference/gtk/gtk3.types        |    1 +
 gtk/gtkcomboboxtext.c                |   18 ++++++++++++++++++
 4 files changed, 44 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 7faf512..146665e 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -153,6 +153,7 @@
     <chapter id="MenusAndCombos">
       <title>Menus, Combo Box, Toolbar</title>
       <xi:include href="xml/gtkcombobox.xml" />
+      <xi:include href="xml/gtkcomboboxtext.xml" />
       <xi:include href="xml/gtkcomboboxentry.xml" />
       <xi:include href="xml/gtkmenu.xml" />
       <xi:include href="xml/gtkmenubar.xml" />
diff --git a/docs/reference/gtk/gtk3-sections.txt b/docs/reference/gtk/gtk3-sections.txt
index 3456543..a014e7e 100644
--- a/docs/reference/gtk/gtk3-sections.txt
+++ b/docs/reference/gtk/gtk3-sections.txt
@@ -838,6 +838,30 @@ gtk_combo_box_entry_get_type
 </SECTION>
 
 <SECTION>
+<FILE>gtkcomboboxtext</FILE>
+<TITLE>GtkComboBoxText</TITLE>
+GtkComboBoxText
+gtk_combo_box_text_new
+gtk_combo_box_text_new_with_entry
+gtk_combo_box_text_append_text
+gtk_combo_box_text_insert_text
+gtk_combo_box_text_prepend_text
+gtk_combo_box_text_remove_text
+gtk_combo_box_text_get_active_text
+
+<SUBSECTION Standard>
+GTK_TYPE_COMBO_BOX_TEXT
+GTK_COMBO_BOX_TEXT
+GTK_IS_COMBO_BOX_TEXT
+GTK_COMBO_BOX_TEXT_CLASS
+GTK_IS_COMBO_BOX_TEXT_CLASS
+GTK_COMBO_BOX_TEXT_GET_CLASS
+
+<SUBSECTION Private>
+GtkComboBoxTextPrivate
+gtk_combo_box_text_get_type
+<SECTION>
+
 <FILE>gtkcontainer</FILE>
 <TITLE>GtkContainer</TITLE>
 GtkContainer
diff --git a/docs/reference/gtk/gtk3.types b/docs/reference/gtk/gtk3.types
index 85b0547..2af1aaa 100644
--- a/docs/reference/gtk/gtk3.types
+++ b/docs/reference/gtk/gtk3.types
@@ -42,6 +42,7 @@ gtk_color_selection_dialog_get_type
 gtk_color_selection_get_type
 gtk_combo_box_entry_get_type
 gtk_combo_box_get_type
+gtk_combo_box_text_get_type
 gtk_container_get_type
 gtk_dialog_get_type
 gtk_drawing_area_get_type
diff --git a/gtk/gtkcomboboxtext.c b/gtk/gtkcomboboxtext.c
index d997723..13e17d8 100644
--- a/gtk/gtkcomboboxtext.c
+++ b/gtk/gtkcomboboxtext.c
@@ -23,6 +23,24 @@
 #include "gtkcellrenderertext.h"
 #include "gtkcelllayout.h"
 
+/**
+ * SECTION:gtkcomboboxtext
+ * @Short_description: A simple, text-only combo box
+ * @Title: GtkComboBoxText
+ * @See_also: @GtkComboBox
+ *
+ * A GtkComboBoxText is a simple variant of #GtkComboBox that hides
+ * the model-view complexity for simple text-only use cases.
+ *
+ * To create a GtkComboBoxText, use gtk_combo_box_text_new() or
+ * gtk_combo_box_text_new_with_entry().
+ *
+ * You can add items to a GtkComboBoxText with
+ * gtk_combo_box_text_append_text(), gtk_combo_box_text_insert_text()
+ * or gtk_combo_box_text_prepend_text() and remove options with
+ * gtk_combo_box_text_remove_text().
+ */
+
 G_DEFINE_TYPE (GtkComboBoxText, gtk_combo_box_text, GTK_TYPE_COMBO_BOX);
 
 static void



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]