Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 8093 was 7655, checked in by rgrieder, 14 years ago

Merged lastmanstanding back to trunk.

  • Property svn:eol-style set to native
File size: 2.8 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/**
[7456]30    @file Notification.h
[2911]31    @brief Definition of the Notification class.
[7456]32    @ingroup Notifications
[2911]33*/
34
[2280]35#ifndef _Notification_H__
36#define _Notification_H__
37
[7164]38#include "notifications/NotificationsPrereqs.h"
[2280]39
40#include <string>
[7489]41#include "core/OrxonoxClass.h"
[2280]42
[2435]43namespace orxonox
44{
[2280]45
46    /**
47    @brief
[7489]48        A Notification represents a short message used to inform the player about something that just happened. With the @ref orxonox::NotificationManager "NotificationManager" a Notification can be sent from any part of orxonox and is then displayed by the proper @ref orxonox::NotificationQueue "NotificationQueue(s)" (depending on which senders the specific @ref orxonox::NotificationQueue "NotificationQueues" accepts).
49
50        A Notification is just a datastructure that is used internally by the Notifications module.
[7552]51
[2280]52    @author
53        Damian 'Mozork' Frick
[7552]54
55    @ingroup Notifications
[2280]56    */
[7474]57    class _NotificationsExport Notification : public OrxonoxClass
[2280]58    {
[2911]59        public:
[7488]60            Notification(const std::string& message, const std::string& sender);
[2911]61            virtual ~Notification();
[3034]62
[2911]63            /**
[7489]64            @brief Get the message of the Notification.
[2911]65            @return Returns the message of the Notification.
66            */
67            inline const std::string & getMessage(void) const
68                { return this->message_; }
[3034]69
[7489]70            /**
71            @brief Get the sender of the Notification.
72            @return Returns the sender of the Notification.
73            */
[2911]74            inline const std::string & getSender(void) const
75                { return this->sender_; }
[3034]76
[2911]77        private:
78            std::string message_; //!< The Notification message.
79            std::string sender_; //!< The sender of the notification.
[3034]80
[7484]81            void initialize(void); //!< Registers the object and sets some default values.
[7655]82            void registerVariables(void) {}
[3034]83
[2280]84    };
[2911]85
[2280]86}
87
88#endif /* _Notification_H__ */
Note: See TracBrowser for help on using the repository browser.