Changeset 7342 for code/branches/notifications/src/modules/notifications/NotificationQueue.h

Timestamp:

Sep 3, 2010, 9:17:51 PM (14 years ago)

Author:

dafrick

Message:

Some documenting, cleaning up. Also: Now the NotificationQueue has a height corresponding to its input size.

File:

• code/branches/notifications/src/modules/notifications/NotificationQueue.h (modified) (6 diffs)

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

@@ -76 +76 @@
 
         public:
-            NotificationQueue(const std::string& name, const std::string& senders = NotificationManager::ALL, unsigned int size = NotificationQueue::DEFAULT_SIZE, const Vector2& position = NotificationQueue::DEFAULT_POSITION, unsigned int length = NotificationQueue::DEFAULT_LENGTH, unsigned int displayTime = NotificationQueue::DEFAULT_DISPLAY_TIME);
+            NotificationQueue(const std::string& name, const std::string& senders = NotificationManager::ALL, unsigned int size = NotificationQueue::DEFAULT_SIZE, const Vector2& position = NotificationQueue::DEFAULT_POSITION, unsigned int displayTime = NotificationQueue::DEFAULT_DISPLAY_TIME);
             virtual ~NotificationQueue();
 
@@ -104 +104 @@
                 { return this->size_; }
             /**
-            @brief Returns the maximum length in characters a Notification message is allowed to have.
-            @return Returns the maximum Notification length.
-            */
-            inline unsigned int getNotificationLength() const
-                { return this->notificationLength_; }
-            /**
             @brief Returns the time interval the Notification is displayed.
             @return Returns the display time.
@@ -121 +115 @@
             inline const Vector2 & getPosition() const
                 { return this->position_; }
-            /**
-            @brief Returns the font size used to display the Notifications.
-            @return  Returns the font size.
-            */
-            inline float getFontSize() const
-                { return this->fontSize_; }
-            /**
-            @brief Returns the font used to display the Notifications.
-            @return Returns the font.
-            */
-            inline const std::string & getFont() const
-                { return this->font_; }
 
             /**
@@ -151 +133 @@
         private:
             static const unsigned int DEFAULT_SIZE = 5; //!< The default maximum number of Notifications displayed.
-            static const unsigned int DEFAULT_LENGTH = 64; //!< The default maximum number of characters displayed.
             static const unsigned int DEFAULT_DISPLAY_TIME = 30; //!< The default display time.
-            static const float DEFAULT_FONT_SIZE; //!< The default font size.
 
-            static const std::string DEFAULT_FONT; //!< The default font.
             static const Vector2 DEFAULT_POSITION; //!< the default position.
 
@@ -167 +146 @@
 
             std::set<std::string> targets_; //!< The targets the Queue displays Notifications of.
-
-            float fontSize_; //!< The font size.
-            std::string font_; //!< The font.
 
             std::multiset<NotificationContainer*, NotificationContainerCompare> ordering_; //!< Multiset, because the ordering is based on, not necessarily unique, timestamps. //TODO: Would set work as well?
@@ -185 +161 @@
 
             void setMaxSize(unsigned int size); //!< Sets the maximum number of displayed Notifications.
-            void setNotificationLength(unsigned int length); //!< Sets the maximum number of characters a Notification message displayed by this queue is allowed to have.
             void setDisplayTime(unsigned int time); //!< Sets the maximum number of seconds a Notification is displayed.
 
             bool setTargets(const std::string & targets); //!< Set the targets of this queue.
-
-            bool setFontSize(float size); //!< Set the font size.
-            bool setFont(const std::string & font); //!< Set the font.
 
             void positionChanged(void); //!< Aligns all the Notifications to the position of the NotificationQueue.