Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/notifications/Notification.h @ 7384

Last change on this file since 7384 was 7164, checked in by dafrick, 14 years ago

Moving notifications to own module.

  • Property svn:eol-style set to native
File size: 3.0 KB
RevLine 
[2280]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
[2911]29/**
[3196]30    @file
[2911]31    @brief Definition of the Notification class.
32*/
33
[2280]34#ifndef _Notification_H__
35#define _Notification_H__
36
[7164]37#include "notifications/NotificationsPrereqs.h"
[2280]38
39#include <string>
40#include "core/BaseObject.h"
41
[2435]42namespace orxonox
43{
[2280]44
45    /**
46    @brief
[2911]47        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).
[2280]48    @author
49        Damian 'Mozork' Frick
50    */
[7164]51    class _NotificationsExport Notification : public BaseObject
[2280]52    {
[2911]53        public:
54            Notification(BaseObject* creator);
[7163]55            Notification(BaseObject* creator, const std::string & message);
[2911]56            virtual ~Notification();
[3034]57
[2911]58            bool send(void); //!< Sends the Notification to the Notificationmanager, with sender NotificationManager::NONE;
59            bool send(const std::string & sender); //!< Sends the Notification to the Notificationmanager.
[3034]60
[2911]61            /**
62            @brief Checks whether the Notification was sent.
63            @return Returns true if the Notification was sent already.
64            */
65            inline bool isSent(void) const
66                { return this->sent_; }
67            /**
68            @brief Returns the message of the Notification.
69            @return Returns the message of the Notification.
70            */
71            inline const std::string & getMessage(void) const
72                { return this->message_; }
[3034]73
[2911]74            inline const std::string & getSender(void) const
75                { return this->sender_; }
[3034]76
[2911]77            bool setMessage(const std::string & message); //!< Sets the message of the notification.
[3034]78
[2911]79        private:
80            std::string message_; //!< The Notification message.
81            std::string sender_; //!< The sender of the notification.
82            bool sent_; //!< Whether Notification has been sent, if so it cannot be changed.
[3034]83
[2911]84            void initialize(void);
[3034]85
[2280]86    };
[2911]87
[2280]88}
89
90#endif /* _Notification_H__ */
Note: See TracBrowser for help on using the repository browser.