Changeset 5882 for code/branches/core5/src/libraries/core

Timestamp:

Oct 5, 2009, 9:57:05 PM (15 years ago)

Author:

landauf

Message:

Again some changes in the event-system:

• Added "mainstate" event-state to BaseObject. It leads to the state which was defined with the mainstate attribute in XML.
• Support event-forwarding to the mainstate of event-listeners.
• The "targets" subsection of the EventDispatcher now supports all kinds of objects (not just EventTargets).
• EventTarget now works in all places of the XML-file, not just in the "targets" section of EventDispatcher.

Added a sample XML-file which explains several aspects of the event-system.

Location:

code/branches/core5/src/libraries/core

Files:

• BaseObject.cc (modified) (4 diffs)
• BaseObject.h (modified) (2 diffs)

code/branches/core5/src/libraries/core/BaseObject.cc

@@ -118 +118 @@
 
         XMLPortObjectTemplate(BaseObject, Template, "templates", addTemplate, getTemplate, xmlelement, mode, Template*);
+        XMLPortObject(BaseObject, BaseObject, "eventlisteners", addEventListener, getEventListener, xmlelement, mode);
         
         Element* events = 0;
@@ -123 +124 @@
             events = xmlelement.FirstChildElement("events", false);
         else if (mode == XMLPort::SaveObject)
-            ;
+            {}
         if (events)
             this->XMLEventPort(*events, mode);
@@ -137 +138 @@
         XMLPortEventState(BaseObject, BaseObject, "activity", setActive, xmlelement, mode);
         XMLPortEventState(BaseObject, BaseObject, "visibility", setVisible, xmlelement, mode);
+        XMLPortEventState(BaseObject, BaseObject, "mainstate", setMainState, xmlelement, mode);
         
         this->bRegisteredEventStates_ = true;
@@ -242 +244 @@
     }
 
+    /**
+        @brief Adds an object which listens to the events of this object.
+    */
+    void BaseObject::addEventListener(BaseObject* listener)
+    {
+        this->eventListenersXML_.insert(listener);
+        listener->addEventSource(this, "mainstate");
+    }
+    
+    /**
+        @brief Returns an event listener with a given index.
+    */
+    BaseObject* BaseObject::getEventListener(unsigned int index) const
+    {
+        unsigned int i = 0;
+        for (std::set<BaseObject*>::const_iterator it = this->eventListenersXML_.begin(); it != this->eventListenersXML_.end(); ++it)
+        {
+            if (i == index)
+                return *it;
+            ++i;
+        }
+        return 0;
+    }
+
     void BaseObject::addEventState(const std::string& name, EventState* state)
     {

code/branches/core5/src/libraries/core/BaseObject.h

@@ -157 +157 @@
             void removeEventSource(BaseObject* source);
             BaseObject* getEventSource(unsigned int index, const std::string& state) const;
+            
+            void addEventListener(BaseObject* listener);
+            BaseObject* getEventListener(unsigned int index) const;
 
             void fireEvent();
@@ -208 +211 @@
             std::map<BaseObject*, std::string>  eventSources_;           //!< List of objects which send events to this object, mapped to the state which they affect
             std::set<BaseObject*>               eventListeners_;         //!< List of objects which listen to the events of this object
+            std::set<BaseObject*>               eventListenersXML_;      //!< List of objects which listen to the events of this object through the "eventlisteners" subsection in XML
             std::map<std::string, EventState*>  eventStates_;            //!< Maps the name of the event states to their helper objects
             bool                                bRegisteredEventStates_; //!< Becomes true after the object registered its event states (with XMLEventPort)