Commit 7693026e authored by Steven Harms's avatar Steven Harms Committed by Javier Jardón

[docs] Move documentation to inline comments: GtkViewport

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611829xSigned-off-by: default avatarJavier Jardón <jjardon@gnome.org>
parent 75ffa798
<!-- ##### SECTION Title ##### -->
GtkViewport
<!-- ##### SECTION Short_Description ##### -->
An adapter which makes widgets scrollable
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkScrolledWindow, #GtkAdjustment
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkViewport ##### -->
<para>
</para>
<!-- ##### SIGNAL GtkViewport::set-scroll-adjustments ##### -->
<para>
</para>
@viewport: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GtkViewport:hadjustment ##### -->
<para>
</para>
<!-- ##### ARG GtkViewport:shadow-type ##### -->
<para>
</para>
<!-- ##### ARG GtkViewport:vadjustment ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_viewport_new ##### -->
<para>
</para>
@hadjustment:
@vadjustment:
@Returns:
<!-- ##### FUNCTION gtk_viewport_get_hadjustment ##### -->
<para>
</para>
@viewport:
@Returns:
<!-- ##### FUNCTION gtk_viewport_get_vadjustment ##### -->
<para>
</para>
@viewport:
@Returns:
<!-- ##### FUNCTION gtk_viewport_set_hadjustment ##### -->
<para>
</para>
@viewport:
@adjustment:
<!-- ##### FUNCTION gtk_viewport_set_vadjustment ##### -->
<para>
</para>
@viewport:
@adjustment:
<!-- ##### FUNCTION gtk_viewport_set_shadow_type ##### -->
<para>
</para>
@viewport:
@type:
<!-- ##### FUNCTION gtk_viewport_get_shadow_type ##### -->
<para>
</para>
@viewport:
@Returns:
<!-- ##### FUNCTION gtk_viewport_get_bin_window ##### -->
<para>
</para>
@viewport:
@Returns:
......@@ -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,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment