[Gnash-commit] gnash ChangeLog server/character.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  07/03/08 11:35:51

Modified files:
        .              : ChangeLog 
        server         : character.h 

Log message:
                * server/character.h: document set_event_hanlder,
                  get_event_handler (as we're getting it wrong).

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.2577&r2=1.2578
http://cvs.savannah.gnu.org/viewcvs/gnash/server/character.h?cvsroot=gnash&r1=1.53&r2=1.54

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.2577
retrieving revision 1.2578
diff -u -b -r1.2577 -r1.2578
--- ChangeLog   8 Mar 2007 10:58:15 -0000       1.2577
+++ ChangeLog   8 Mar 2007 11:35:50 -0000       1.2578
@@ -1,5 +1,7 @@
 2007-03-07 Sandro Santilli <address@hidden>
 
+       * server/character.h: document set_event_hanlder,
+         get_event_handler (as we're getting it wrong).
        * testsuite/actionscript.all/MovieClip.as:
          Test that the onLoad member of a MovieClip
          can be set to any value.

Index: server/character.h
===================================================================
RCS file: /sources/gnash/gnash/server/character.h,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -b -r1.53 -r1.54
--- server/character.h  5 Mar 2007 21:53:48 -0000       1.53
+++ server/character.h  8 Mar 2007 11:35:51 -0000       1.54
@@ -18,7 +18,7 @@
 //
 //
 
-/* $Id: character.h,v 1.53 2007/03/05 21:53:48 strk Exp $ */
+/* $Id: character.h,v 1.54 2007/03/08 11:35:51 strk Exp $ */
 
 #ifndef GNASH_CHARACTER_H
 #define GNASH_CHARACTER_H
@@ -294,7 +294,14 @@
        /// Maps from our local space into normal color space.
        virtual cxform  get_world_cxform() const;
 
-    // Event handler accessors.
+       /// Get a built-in function handler for the given event
+       //
+       /// NOTE: this function is only for getting statically-defined
+       ///       event handlers, which are the ones attached to a character
+       ///       with a PlaceObject2. It's the character's responsibility
+       ///       to properly fetch any user-defined event handler, which 
+       ///       are the ones attached to a character with ActionScript code.
+       ///
        bool get_event_handler(const event_id& id, as_value* result) const
        {
                std::map<event_id, as_value>::const_iterator it = \
@@ -304,11 +311,21 @@
                return true;
        }
 
-       /// Set a function handler for the given event
+       /// Set a built-in function handler for the given event
        //
        /// Mark the character as having mouse or keypress event
        /// handlers if this is the case.
        ///
+       /// NOTE: this function is only for registering statically-defined
+       ///       event handlers, which are the ones attached to a character
+       ///       with a PlaceObject2. It's the character's responsibility
+       ///       to properly invoke any user-defined event handler, which 
+       ///       are the ones attached to a character with ActionScript code.
+       ///
+       /// @param id
+       ///
+       /// @param method
+       ///
        void set_event_handler(const event_id& id, const as_value& method);
 
        /// \brief