Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/toonshader/src/orxonox/overlays/notifications/Notification.h @ 10739

Last change on this file since 10739 was 2911, checked in by landauf, 16 years ago

Merged r1-2096 of questsystem5 back to trunk

I hope there weren't more "hidden merge changes" in r2909 than the one in OverlayGroup (removeElement) (and related to this the adjustments in NotificationQueue).

The corresponding media commit seems not yet to be done, but it doesn't break the build.

  • Property svn:eol-style set to native
File size: 3.0 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file Notification.h
31    @brief Definition of the Notification class.
32*/
33
34#ifndef _Notification_H__
35#define _Notification_H__
36
37#include "OrxonoxPrereqs.h"
38
39#include <string>
40
41#include "core/BaseObject.h"
42
43namespace orxonox
44{
45
46    /**
47    @brief
48        A Notification is a short message used to inform the player about something that just happened. A Notification can be sent from any part of orxonox and is then displayed in the proper NotificationQueue (depending on which senders the specific NotificationQueue accepts).
49    @author
50        Damian 'Mozork' Frick
51    */
52    class _OrxonoxExport Notification : public BaseObject
53    {
54        public:
55            Notification(BaseObject* creator);
56            Notification(const std::string & message);
57            virtual ~Notification();
58           
59            bool send(void); //!< Sends the Notification to the Notificationmanager, with sender NotificationManager::NONE;
60            bool send(const std::string & sender); //!< Sends the Notification to the Notificationmanager.
61           
62            /**
63            @brief Checks whether the Notification was sent.
64            @return Returns true if the Notification was sent already.
65            */
66            inline bool isSent(void) const
67                { return this->sent_; }
68            /**
69            @brief Returns the message of the Notification.
70            @return Returns the message of the Notification.
71            */
72            inline const std::string & getMessage(void) const
73                { return this->message_; }
74               
75            inline const std::string & getSender(void) const
76                { return this->sender_; }
77           
78            bool setMessage(const std::string & message); //!< Sets the message of the notification.
79           
80        private:
81            std::string message_; //!< The Notification message.
82            std::string sender_; //!< The sender of the notification.
83            bool sent_; //!< Whether Notification has been sent, if so it cannot be changed.
84           
85            void initialize(void);
86       
87    };
88
89}
90
91#endif /* _Notification_H__ */
Note: See TracBrowser for help on using the repository browser.