Changeset 7343 for code/branches/notifications/src/modules/notifications/NotificationQueue.cc

Timestamp:

Sep 3, 2010, 11:30:24 PM (14 years ago)

Author:

dafrick

Message:

Some documenting and adjustment.

File:

• code/branches/notifications/src/modules/notifications/NotificationQueue.cc (modified) (8 diffs)

code/branches/notifications/src/modules/notifications/NotificationQueue.cc

@@ -176 +176 @@
     /**
     @brief
-        Adds a Notification, to the queue.
+        Adds a Notification to the NotificationQueue.
         It inserts it into the storage containers, creates a corresponding container and pushes the Notification message to the GUI.
     @param notification
@@ -234 +234 @@
     /**
     @brief
-        Clears the queue by removing all containers.
+        Clears the queue by removing all Notifications.
     */
     void NotificationQueue::clear(void)
@@ -240 +240 @@
         this->ordering_.clear();
         for(std::vector<NotificationContainer*>::iterator it = this->notifications_.begin(); it != this->notifications_.end(); it++)
-        {
             delete *it;
-        }
+
         this->notifications_.clear();
         this->size_ = 0;
@@ -250 +249 @@
     /**
     @brief
+        Adjusts the NotificationQueue, when the position has changed.
+    */
+    void NotificationQueue::positionChanged(void)
+    {
+        GUIManager::getInstance().getLuaState()->doString("NotificationLayer.changePosition(\"" + this->getName() + "\", " + multi_cast<std::string>(this->getPosition().x) + ", " + multi_cast<std::string>(this->getPosition().y) + ")");
+    }
+
+    /**
+    @brief
         Sets the name of the NotificationQueue.
     @param name
@@ -274 +282 @@
     {
         this->maxSize_ = size;
+        this->sizeChanged();
+    }
+
+    /**
+    @brief
+        Adjusts the NotificationQueue, when the maximum size has changed.
+    */
+    void NotificationQueue::sizeChanged(void)
+    {
+        GUIManager::getInstance().getLuaState()->doString("NotificationLayer.changeSize(\"" + this->getName() + "\", " + multi_cast<std::string>(this->getSize()) + ")");
         this->update();
     }
@@ -308 +326 @@
         string->clear();
         bool first = true;
-        for(std::set<std::string>::const_iterator it = this->targets_.begin(); it != this->targets_.end(); it++) //!< Iterate through the set of targets.
+        for(std::set<std::string>::const_iterator it = this->targets_.begin(); it != this->targets_.end(); it++) // Iterate through the set of targets.
         {
             if(!first)
-            {
                 *string += ',';
-            }
             else
-            {
                 first = false;
-            }
             *string += *it;
         }
@@ -339 +353 @@
         std::string* pTemp;
         unsigned int index = 0;
-        while( index < targets.size() ) //!< Go through the string, character by character until the end is reached.
+        while(index < targets.size()) // Go through the string, character by character until the end is reached.
         {
             pTemp = new std::string();
@@ -354 +368 @@
     }
 
-    /**
-    @brief
-        Aligns all the Notifications to the position of the NotificationQueue.
-    */
-    void NotificationQueue::positionChanged(void)
-    {
-        GUIManager::getInstance().getLuaState()->doString("NotificationLayer.changePosition(\"" + this->getName() + "\", " + multi_cast<std::string>(this->getPosition().x) + ", " + multi_cast<std::string>(this->getPosition().y) + ")");
-    }
-
 }