[gtk+/treeview-refactor] docs: Move documentation to inline comments: GtkLayout



commit 46627d008ffa83e1be2f332b461e4c126cf2d0eb
Author: Garrett Regier <alias301 gmail com>
Date:   Sat Nov 6 17:28:53 2010 +0100

    docs: Move documentation to inline comments: GtkLayout
    
    Signed-off-by: Javier Jardón <jjardon gnome org>

 docs/reference/gtk/tmpl/.gitignore     |    1 +
 docs/reference/gtk/tmpl/gtklayout.sgml |  177 --------------------------------
 gtk/gtklayout.c                        |   21 ++++
 3 files changed, 22 insertions(+), 177 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 28b7b35..43c596e 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -20,6 +20,7 @@ gtkiconview.sgml
 gtkimcontextsimple.sgml
 gtkimmulticontext.sgml
 gtkitemfactory.sgml
+gtklayout.sgml
 gtklinkbutton.sgml
 gtkmessagedialog.sgml
 gtknotebook.sgml
diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c
index a2589c2..2815b64 100644
--- a/gtk/gtklayout.c
+++ b/gtk/gtklayout.c
@@ -40,6 +40,27 @@
 #include "gtkscrollable.h"
 
 
+/**
+ * SECTION:gtklayout
+ * @Short_description: Infinite scrollable area containing child widgets
+ *   and/or custom drawing
+ * @Title: GtkLayout
+ * @See_also: #GtkDrawingArea, #GtkScrolledWindow
+ *
+ * #GtkLayout is similar to #GtkDrawingArea in that it's a "blank slate"
+ * and doesn't do anything but paint a blank background by default. It's
+ * different in that it supports scrolling natively (you can add it to a
+ * #GtkScrolledWindow), and it can contain child widgets, since it's a
+ * #GtkContainer. However if you're just going to draw, a #GtkDrawingArea
+ * is a better choice since it has lower overhead.
+ *
+ * When handling expose events on a #GtkLayout, you must draw to
+ * GTK_LAYOUT (layout)->bin_window, rather than to
+ * GTK_WIDGET (layout)->window, as you would for a drawing
+ * area.
+ */
+
+
 typedef struct _GtkLayoutChild   GtkLayoutChild;
 
 struct _GtkLayoutPrivate



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