[gtk+] [docs] Move documentation to inline comments: GtkViewport
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] [docs] Move documentation to inline comments: GtkViewport
- Date: Sun, 18 Apr 2010 01:46:34 +0000 (UTC)
commit 7693026e4471bfb18d3347e9e4a7fa741723e75f
Author: Steven Harms <sharms ubuntu com>
Date: Thu Mar 4 13:13:45 2010 -0500
[docs] Move documentation to inline comments: GtkViewport
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611829x
Signed-off-by: Javier Jardón <jjardon gnome org>
docs/reference/gtk/tmpl/gtkviewport.sgml | 134 ------------------------------
gtk/gtkviewport.c | 19 ++++
2 files changed, 19 insertions(+), 134 deletions(-)
---
diff --git a/gtk/gtkviewport.c b/gtk/gtkviewport.c
index bfda9f2..7571a5d 100644
--- a/gtk/gtkviewport.c
+++ b/gtk/gtkviewport.c
@@ -31,6 +31,25 @@
#include "gtkprivate.h"
#include "gtkalias.h"
+/**
+ * SECTION:gtkviewport
+ * @Short_description: An adapter which makes widgets scrollable
+ * @Title: GtkViewport
+ * @See_also:#GtkScrolledWindow, #GtkAdjustment
+ *
+ * The #GtkViewport widget acts as an adaptor class, implementing
+ * scrollability for child widgets that lack their own scrolling
+ * capabilities. Use #GtkViewport to scroll child widgets such as
+ * #GtkTable, #GtkBox, and so on.
+ *
+ * If a widget has native scrolling abilities, such as #GtkTextView,
+ * #GtkTreeView or #GtkIconview, it can be added to a #GtkScrolledWindow
+ * with gtk_container_add(). If a widget does not, you must first add the
+ * widget to a #GtkViewport, then add the viewport to the scrolled window.
+ * The convenience function gtk_scrolled_window_add_with_viewport() does
+ * exactly this, so you can ignore the presence of the viewport.
+ */
+
enum {
PROP_0,
PROP_HADJUSTMENT,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]