Commit 356f1f59 authored by Benjamin Berg's avatar Benjamin Berg Committed by Daniel Boles

container: Document that removal from foreach is permissible

It is permissable to remove a widget using gtk_container_remove from the
gtk_container_foreach callback handler. Document this fact to make it
more discoverable.

Fixes #1461
parent 0040b256
......@@ -2456,6 +2456,8 @@ gtk_container_forall (GtkContainer *container,
* added to the container by the application with explicit add()
* calls.
*
* It is permissible to remove the child from the @callback handler.
*
* Most applications should use gtk_container_foreach(),
* rather than gtk_container_forall().
**/
......
......@@ -60,7 +60,8 @@ struct _GtkContainer
* @add: Signal emitted when a widget is added to container.
* @remove: Signal emitted when a widget is removed from container.
* @check_resize: Signal emitted when a size recalculation is needed.
* @forall: Invokes callback on each child of container.
* @forall: Invokes callback on each child of container. The callback handler
* may remove the child.
* @set_focus_child: Sets the focused child of container.
* @child_type: Returns the type of the children supported by the container.
* @composite_name: Gets a widget’s composite name. Deprecated: 3.10.
......
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