[gtk+] Move documentation to inline comments: GtkCellRendererPixbuf



commit 4a7400db99cf5e3cb3b25b79f0d30e79329cf906
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Apr 11 22:47:18 2011 +0100

    Move documentation to inline comments: GtkCellRendererPixbuf

 docs/reference/gtk/tmpl/.gitignore                 |    1 +
 docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml |   98 --------------------
 gtk/gtkcellrendererpixbuf.c                        |   20 ++++
 3 files changed, 21 insertions(+), 98 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 7bfa2cc..acc4ada 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -13,6 +13,7 @@ gtkcelllayout.sgml
 gtkcellrenderer.sgml
 gtkcellrendereraccel.sgml
 gtkcellrenderercombo.sgml
+gtkcellrendererpixbuf.sgml
 gtkcellrendererprogress.sgml
 gtkcellrendererspin.sgml
 gtkcellrenderertext.sgml
diff --git a/gtk/gtkcellrendererpixbuf.c b/gtk/gtkcellrendererpixbuf.c
index 95d0315..f50b3ae 100644
--- a/gtk/gtkcellrendererpixbuf.c
+++ b/gtk/gtkcellrendererpixbuf.c
@@ -26,6 +26,26 @@
 #include "gtkprivate.h"
 
 
+/**
+ * SECTION:gtkcellrendererpixbuf
+ * @Short_description: Renders a pixbuf in a cell
+ * @Title: GtkCellRendererPixbuf
+ *
+ * A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows
+ * to render either a given #GdkPixbuf (set via the
+ * #GtkCellRendererPixbuf:pixbuf property) or a stock icon (set via the
+ * #GtkCellRendererPixbuf:stock-id property).
+ *
+ * To support the tree view, #GtkCellRendererPixbuf also supports rendering two
+ * alternative pixbufs, when the #GtkCellRenderer:is-expander property is %TRUE.
+ * If the #GtkCellRenderer:is-expanded property is %TRUE and the
+ * #GtkCellRendererPixbuf:pixbuf-expander-open property is set to a pixbuf, it
+ * renders that pixbuf, if the #GtkCellRenderer:is-expanded property is %FALSE
+ * and the #GtkCellRendererPixbuf:pixbuf-expander-closed property is set to a
+ * pixbuf, it renders that one.
+ */
+
+
 static void gtk_cell_renderer_pixbuf_get_property  (GObject                    *object,
 						    guint                       param_id,
 						    GValue                     *value,



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