From 65536550c522969b38d10db57285c2dcd50cc32f Mon Sep 17 00:00:00 2001 From: Garrett Regier Date: Sat, 6 Nov 2010 17:28:53 +0100 Subject: [PATCH] docs: Move documentation to inline comments: GtkLayout MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Javier Jardón --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtklayout.sgml | 177 ------------------------- gtk/gtklayout.c | 21 +++ 3 files changed, 22 insertions(+), 177 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtklayout.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 28b7b357be..43c596e87c 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/docs/reference/gtk/tmpl/gtklayout.sgml b/docs/reference/gtk/tmpl/gtklayout.sgml deleted file mode 100644 index 1b32027d0c..0000000000 --- a/docs/reference/gtk/tmpl/gtklayout.sgml +++ /dev/null @@ -1,177 +0,0 @@ - -GtkLayout - - - -Infinite scrollable area containing child widgets and/or custom drawing - - - -#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. - - - - -#GtkDrawingArea, #GtkScrolledWindow - - - - - - - - - - - - - - - - - - - -@layout: the object which received the signal. -@arg1: -@arg2: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@hadjustment: -@vadjustment: -@Returns: - - - - - - - -@layout: -@child_widget: -@x: -@y: - - - - - - - -@layout: -@child_widget: -@x: -@y: - - - - - - - -@layout: -@width: -@height: - - - - - - - -@layout: -@width: -@height: - - - - - - - -@layout: -@Returns: - - - - - - - -@layout: -@Returns: - - - - - - - -@layout: -@adjustment: - - - - - - - -@layout: -@adjustment: - - - - - - - -@layout: -@Returns: - - diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c index a2589c27f3..2815b642b2 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