summaryrefslogtreecommitdiff
path: root/gtk/gtkcellrenderercombo.c
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2011-04-11 22:39:48 +0100
committerJavier Jardón <jjardon@gnome.org>2011-04-11 23:07:41 +0100
commit3990af227f5f14b41855a019bba69873687c2172 (patch)
treec012a95dc73cd8152b995131a5e471c5c1a94c71 /gtk/gtkcellrenderercombo.c
parent1f50a4d0114e74c26a5281dedf5f5df0cf54e793 (diff)
downloadgtk+-3990af227f5f14b41855a019bba69873687c2172.tar.gz
Move documentation to inline comments: GtkCellRendererCombo
Diffstat (limited to 'gtk/gtkcellrenderercombo.c')
-rw-r--r--gtk/gtkcellrenderercombo.c21
1 files changed, 21 insertions, 0 deletions
diff --git a/gtk/gtkcellrenderercombo.c b/gtk/gtkcellrenderercombo.c
index ad154c4aac..d14908a535 100644
--- a/gtk/gtkcellrenderercombo.c
+++ b/gtk/gtkcellrenderercombo.c
@@ -30,6 +30,27 @@
#include "gtkmarshalers.h"
#include "gtkprivate.h"
+
+/**
+ * SECTION:gtkcellrenderercombo
+ * @Short_description: Renders a combobox in a cell
+ * @Title: GtkCellRendererCombo
+ *
+ * #GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from
+ * which it is derived. But while #GtkCellRendererText offers a simple entry to
+ * edit the text, #GtkCellRendererCombo offers a #GtkComboBox or #GtkComboBoxEntry
+ * widget to edit the text. The values to display in the combo box are taken from
+ * the tree model specified in the #GtkCellRendererCombo:model property.
+ *
+ * The combo cell renderer takes care of adding a text cell renderer to the combo
+ * box and sets it to display the column specified by its
+ * #GtkCellRendererCombo:text-column property. Further properties of the comnbo box
+ * can be set in a handler for the #GtkCellRenderer::editing-started signal.
+ *
+ * The #GtkCellRendererCombo cell renderer was added in GTK+ 2.6.
+ */
+
+
struct _GtkCellRendererComboPrivate
{
GtkTreeModel *model;