1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
|
/***************************************************************************
* Copyright (C) 2005-2019 by the FIFE team *
* http://www.fifengine.net *
* This file is part of FIFE. *
* *
* FIFE is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef FIFE_EVENTCHANNEL_ICOMMAND_CONTROLLER_H
#define FIFE_EVENTCHANNEL_ICOMMAND_CONTROLLER_H
// Standard C++ library includes
//
// 3rd party library includes
//
// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
//
#include "icommandlistener.h"
namespace FIFE {
class Command;
/** Controller provides a way to receive events from the system
* Using this interface, clients can subscribe themselves to receive events
* Also command sending is possible
*/
class ICommandController {
public:
/** Adds a listener to the back of the listener deque
* Listener will be notified via the corresponding events
* @param listener listener to add
*/
virtual void addCommandListener(ICommandListener* listener) = 0;
/** Adds a listener to the front of the listener deque
* Listener will be notified via the corresponding events
* @param listener listener to add
*/
virtual void addCommandListenerFront(ICommandListener* listener) = 0;
/** Removes an added listener from the controller.
* Listener will not be notified anymore via the corresponding events
* @param listener listener to remove
*/
virtual void removeCommandListener(ICommandListener* listener) = 0;
/** Use this method to send command to command listeners
* @param command command to dispatch
*/
virtual void dispatchCommand(Command& command) = 0;
virtual ~ICommandController() {}
};
} //FIFE
#endif
|