GtkOverlay: Update the description

State that the overlays are placed wrt to the GtkOverlay, not
with respect to the main widget. This makes a difference for
small main widgets which are not configured to fill the entire
GtkOverlay.
This commit is contained in:
Matthias Clasen 2015-08-21 18:19:26 -04:00
parent 58f363c852
commit bff28ac6b0

View File

@ -34,14 +34,14 @@
* @title: GtkOverlay
*
* GtkOverlay is a container which contains a single main child, on top
* of which it can place overlay widgets. The
* position of each overlay widget is determined by its #GtkWidget:halign
* and #GtkWidget:valign properties. E.g. a widget with both alignments
* set to %GTK_ALIGN_START will be placed at the top left corner of the
* main widget, whereas an overlay with halign set to %GTK_ALIGN_CENTER
* and valign set to %GTK_ALIGN_END will be placed a the bottom edge of
* the main widget, horizontally centered. The position can be adjusted
* by setting the margin properties of the child to non-zero values.
* of which it can place overlay widgets. The position of each overlay
* widget is determined by its #GtkWidget:halign and #GtkWidget:valign
* properties. E.g. a widget with both alignments set to %GTK_ALIGN_START
* will be placed at the top left corner of the GtkOverlay container,
* whereas an overlay with halign set to %GTK_ALIGN_CENTER and valign set
* to %GTK_ALIGN_END will be placed a the bottom edge of the GtkOverlay,
* horizontally centered. The position can be adjusted by setting the margin
* properties of the child to non-zero values.
*
* More complicated placement of overlays is possible by connecting
* to the #GtkOverlay::get-child-position signal.