summaryrefslogtreecommitdiff
path: root/gtk/gtkoverlay.c
diff options
context:
space:
mode:
authorDaniel Boles <dboles.src@gmail.com>2019-06-13 18:22:33 +0100
committerDaniel Boles <dboles.src@gmail.com>2019-06-20 21:41:59 +0100
commita7a0a34da101bab9f08dcb68968d65fbae6d362d (patch)
tree3c1012295b7f22da6bf7316fc092e1f6399122a6 /gtk/gtkoverlay.c
parent299bd5fa93931d3c80a325f0333cc1968c632618 (diff)
downloadgtk+-a7a0a34da101bab9f08dcb68968d65fbae6d362d.tar.gz
Overlay: Document overlay children aren't measured
Some users expect that the Overlay will automatically request enough size for its overlay children as well as its main child. It doesn't, because it's just a GtkBin. Add a short paragraph pointing that out. Close https://gitlab.gnome.org/GNOME/gtk/issues/1939
Diffstat (limited to 'gtk/gtkoverlay.c')
-rw-r--r--gtk/gtkoverlay.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/gtk/gtkoverlay.c b/gtk/gtkoverlay.c
index 7001aa59ba..f23982221e 100644
--- a/gtk/gtkoverlay.c
+++ b/gtk/gtkoverlay.c
@@ -50,6 +50,9 @@
* More complicated placement of overlays is possible by connecting
* to the #GtkOverlay::get-child-position signal.
*
+ * An overlay’s minimum and natural sizes are those of its main child. The sizes
+ * of overlay children are not considered when measuring these preferred sizes.
+ *
* # GtkOverlay as GtkBuildable
*
* The GtkOverlay implementation of the GtkBuildable interface