callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

container: Clarify the forall/foreach documentation

Browse Source 
Try to make the difference between these two functions
clearer.
This commit is contained in:
Matthias Clasen 2016-01-23 01:51:48 -05:00
parent 695860958a
commit 8ba996a6db
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
gtk/gtkcontainer.c
View File

@ -2387,12 +2387,14 @@ gtk_container_class_handle_border_width (GtkContainerClass *klass)
* @callback: (scope call) (closure callback_data): a callback * @callback: (scope call) (closure callback_data): a callback
* @callback_data: callback user data * @callback_data: callback user data
* *
* Invokes @callback on each child of @container, including children * Invokes @callback on each direct child of @container, including
* that are considered “internal” (implementation details of the * children that are considered “internal” (implementation details
* container). “Internal” children generally weren’t added by the user * of the container). “Internal” children generally weren’t added
* of the container, but were added by the container implementation * by the user of the container, but were added by the container
* itself. Most applications should use gtk_container_foreach(), * implementation itself.
* rather than gtk_container_forall(). *
* Most applications should use gtk_container_foreach(), rather
* than gtk_container_forall().
**/ **/
void void
gtk_container_forall (GtkContainer *container, gtk_container_forall (GtkContainer *container,
@ -2416,10 +2418,15 @@ gtk_container_forall (GtkContainer *container,
* @callback: (scope call): a callback * @callback: (scope call): a callback
* @callback_data: callback user data * @callback_data: callback user data
* *
* Invokes @callback on each non-internal child of @container. See * Invokes @callback on each non-internal child of @container.
* gtk_container_forall() for details on what constitutes an * See gtk_container_forall() for details on what constitutes
* “internal” child. Most applications should use * an “internal” child. For all practical purposes, this function
* gtk_container_foreach(), rather than gtk_container_forall(). * should iterate over precisely those child widgets that were
* added to the container by the application with explicit add()
* calls.
*
* Most applications should use gtk_container_foreach(),
* rather than gtk_container_forall().
**/ **/
void void
gtk_container_foreach (GtkContainer *container, gtk_container_foreach (GtkContainer *container,