luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-23 07:39:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

gobject: Document notify signal deduplication with freeze/thaw

Browse Source 
Expand the documentation for g_object_[freeze|thaw]_notify() to explain that
it deduplicates “notify” signals emitted by frozen objects, so that at most
one signal is emitted per property.

https://bugzilla.gnome.org/show_bug.cgi?id=676937
This commit is contained in:
Philip Withnall 2012-05-27 22:40:44 +01:00
parent 1637f08ed1
commit f642209ef4
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gobject/gobject.c
View File

@ -1070,7 +1070,9 @@ g_object_run_dispose (GObject *object)
* Increases the freeze count on @object. If the freeze count is * Increases the freeze count on @object. If the freeze count is
* non-zero, the emission of "notify" signals on @object is * non-zero, the emission of "notify" signals on @object is
* stopped. The signals are queued until the freeze count is decreased * stopped. The signals are queued until the freeze count is decreased
* to zero. * to zero. Duplicate notifications are squashed so that at most one
* #GObject::notify signal is emitted for each property modified while the
* object is frozen.
* *
* This is necessary for accessors that modify multiple properties to prevent * This is necessary for accessors that modify multiple properties to prevent
* premature notification while the object is still being modified. * premature notification while the object is still being modified.
@ -1241,7 +1243,10 @@ g_object_notify_by_pspec (GObject *object,
* *
* Reverts the effect of a previous call to * Reverts the effect of a previous call to
* g_object_freeze_notify(). The freeze count is decreased on @object * g_object_freeze_notify(). The freeze count is decreased on @object
* and when it reaches zero, all queued "notify" signals are emitted. * and when it reaches zero, queued "notify" signals are emitted.
*
* Duplicate notifications for each property are squashed so that at most one
* #GObject::notify signal is emitted for each property.
* *
* It is an error to call this function when the freeze count is zero. * It is an error to call this function when the freeze count is zero.
*/ */