brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Clarify the Actor's iterator API behaviour

Browse Source 
It should be noted in the documentation that it is not safe to operate
on the list of children of an Actor while iterating over it.
This commit is contained in:
Emmanuele Bassi 2011-12-19 17:34:22 +00:00 committed by Emmanuele Bassi
parent 4f470b9231
commit 673961f40c
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
clutter/clutter-actor.c
View File

@ -15496,7 +15496,8 @@ clutter_actor_get_background_color (ClutterActor *self,
* of children of @self's parent.
*
* The returned pointer is only valid until the scene graph changes; it
* is guaranteed to remain the same during the paint sequence.
* is not safe to modify the list of children of @self while iterating
* it.
*
* Return value: (transfer none): a pointer to a #ClutterActor, or %NULL
*
@ -15517,7 +15518,9 @@ clutter_actor_get_previous_sibling (ClutterActor *self)
* Retrieves the sibling of @self that comes after it in the list
* of children of @self's parent.
*
* The returned pointer is only valid until the scene graph changes.
* The returned pointer is only valid until the scene graph changes; it
* is not safe to modify the list of children of @self while iterating
* it.
*
* Return value: (transfer none): a pointer to a #ClutterActor, or %NULL
*
@ -15537,7 +15540,9 @@ clutter_actor_get_next_sibling (ClutterActor *self)
*
* Retrieves the first child of @self.
*
* The returned pointer is only valid until the scene graph changes.
* The returned pointer is only valid until the scene graph changes; it
* is not safe to modify the list of children of @self while iterating
* it.
*
* Return value: (transfer none): a pointer to a #ClutterActor, or %NULL
*
@ -15557,7 +15562,9 @@ clutter_actor_get_first_child (ClutterActor *self)
*
* Retrieves the last child of @self.
*
* The returned pointer is only valid until the scene graph changes.
* The returned pointer is only valid until the scene graph changes; it
* is not safe to modify the list of children of @self while iterating
* it.
*
* Return value: (transfer none): a pointer to a #ClutterActor, or %NULL
*