Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/notifications/dispatchers/SimpleNotification.h @ 7297

Last change on this file since 7297 was 7285, checked in by landauf, 14 years ago

added eol-style native for some files.

note: there are another 6 files in libraries/network, but I won't change them as long as there's an active network branch.

  • Property svn:eol-style set to native
File size: 2.6 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#ifndef _SimpleNotification_H__
30#define _SimpleNotification_H__
31
32#include "notifications/NotificationsPrereqs.h"
33
34#include "notifications/NotificationDispatcher.h"
35#include <string>
36
37namespace orxonox {
38
39    /**
40    @brief
41        The SimpleNotification class enables the sending of (in XML) predefined Notifications upon some kind of triggering event.
42    @author
43        Damian 'Mozork' Frick
44    */
45    class _NotificationsExport SimpleNotification : public NotificationDispatcher
46    {
47        public:
48            SimpleNotification(BaseObject* creator); //!< Default Constructor.
49            virtual ~SimpleNotification(); //!< Destructor.
50
51            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a SimpleNotification object through XML.
52
53            /**
54            @brief Get the message, that is displayed.
55            @return Returns the message, that is displayed.
56            */
57            const std::string& getMessage(void)
58                { return this->message_; }
59
60        protected:
61            /**
62            @brief Creates the notification message that should be sent upon the SimpleNotification triggering.
63            @return Returns the notification message.
64            */
65            virtual const std::string& createNotificationMessage(void)
66                { return this->message_; }
67
68        private:
69            std::string message_; //!< The message that is displayed.
70
71            /**
72            @brief Sets the message that is to be displayed.
73            @param message The message to be displayed.
74            */
75            void setMessage(const std::string& message)
76                { this->message_ = message; }
77    };
78
79}
80
81#endif // _SimpleNotification_H__
Note: See TracBrowser for help on using the repository browser.