diff options
author | Andrei Karas <akaras@inbox.ru> | 2014-02-16 12:47:15 +0300 |
---|---|---|
committer | Andrei Karas <akaras@inbox.ru> | 2014-02-16 12:47:15 +0300 |
commit | 3ae82048ca8636ce03e71bdd4c11f60594cfc698 (patch) | |
tree | 51d344c3baeaa586fdfc8fc913c7863558b99093 /src/events/event.h | |
parent | 0d73f54f842a9690c65faedf094112017fd07430 (diff) | |
download | manaplus-3ae82048ca8636ce03e71bdd4c11f60594cfc698.tar.gz manaplus-3ae82048ca8636ce03e71bdd4c11f60594cfc698.tar.bz2 manaplus-3ae82048ca8636ce03e71bdd4c11f60594cfc698.tar.xz manaplus-3ae82048ca8636ce03e71bdd4c11f60594cfc698.zip |
move event into events directory.
Diffstat (limited to 'src/events/event.h')
-rw-r--r-- | src/events/event.h | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/src/events/event.h b/src/events/event.h new file mode 100644 index 000000000..d62dd672b --- /dev/null +++ b/src/events/event.h @@ -0,0 +1,117 @@ +/* + * The ManaPlus Client + * Copyright (C) 2011-2014 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +/* _______ __ __ __ ______ __ __ _______ __ __ + * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\ + * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / / + * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / / + * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / / + * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ / + * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/ + * + * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson + * + * + * Per Larsson a.k.a finalman + * Olof Naessén a.k.a jansem/yakslem + * + * Visit: http://guichan.sourceforge.net + * + * License: (BSD) + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name of Guichan nor the names of its contributors may + * be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef EVENTS_EVENT_HPP +#define EVENTS_EVENT_HPP + +#include "localconsts.h" + +namespace gcn +{ + class Widget; +} + +/** + * Base class for all events. All events in Guichan should + * inherit from this class. + * + * @author Olof Naessén + * @since 0.6.0 + */ +class Event +{ + public: + /** + * Constructor. + * + * @param source The source widget of the event. + */ + explicit Event(gcn::Widget *const source) : + mSource(source) + { } + + A_DELETE_COPY(Event) + + /** + * Destructor. + */ + virtual ~Event() + { } + + /** + * Gets the source widget of the event. The function + * is used to tell which widget fired an event. + * + * @return The source widget of the event. + */ + gcn::Widget* getSource() const A_WARN_UNUSED + { return mSource; } + + protected: + /** + * Holds the source widget of the event. + */ + gcn::Widget* mSource; +}; + +#endif // EVENTS_EVENT_HPP |