diff --git a/ChangeLog b/ChangeLog index a927117fa..a7911905b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2007-10-10 Emmanuele Bassi + + * clutter/clutter-actor.c: Beautify the ClutterActor documentation. + 2007-10-10 Emmanuele Bassi * clutter/clutter-actor.c: Remove the ::event-after signal: diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c index 1373bb634..32483e6d3 100644 --- a/clutter/clutter-actor.c +++ b/clutter/clutter-actor.c @@ -34,14 +34,22 @@ * * Ordering of tranformations. FIXME. * - * Notes on clutter actor events: FIXME. - * - * - Actors emit pointer events if set reactive (#clutter_actor_set_reactive) - * - Keyboard events are emitted if actor has focus (#clutter_stage_set_focus) - * - Motion events (motion, enter, leave) are only emitted per actor if - * #clutter_enable_motion_events called with TRUE. If set to FALSE (default) - * then only the stage emits events. - * - One emitted an event emission has two phases - capture and bubble. + * Notes on clutter actor events: + * + * Actors emit pointer events if set reactive, see + * clutter_actor_set_reactive() + * Event handlers must return %TRUE if they handled + * the event and wish to block the event emission chain; and %FALSE + * if the emission chain must continue + * Keyboard events are emitted if actor has focus, see + * clutter_stage_set_focus() + * Motion events (motion, enter, leave) are only emitted + * per actor if clutter_enable_motion_events() was called with %TRUE. If + * set to %FALSE (the default) then only the stage emits motion + * events + * Once emitted, an event has two phases: capture + * and bubble + * */ #include "config.h" @@ -2983,7 +2991,9 @@ clutter_actor_lower_bottom (ClutterActor *self) * You should rarely need to use this function, except for * synthetising events. * - * Return value: the return value from the signal emission + * Return value: the return value from the signal emission: %TRUE + * if the actor handled the event, or %FALSE if the event was + * not handled * * Since: 0.6 */