FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
icommandcontroller.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_EVENTCHANNEL_ICOMMAND_CONTROLLER_H
23 #define FIFE_EVENTCHANNEL_ICOMMAND_CONTROLLER_H
24 
25 // Standard C++ library includes
26 //
27 
28 // 3rd party library includes
29 //
30 
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35 //
36 #include "icommandlistener.h"
37 
38 namespace FIFE {
39  class Command;
40 
46  public:
47 
52  virtual void addCommandListener(ICommandListener* listener) = 0;
53 
58  virtual void addCommandListenerFront(ICommandListener* listener) = 0;
59 
64  virtual void removeCommandListener(ICommandListener* listener) = 0;
65 
69  virtual void dispatchCommand(Command& command) = 0;
70 
71  virtual ~ICommandController() {}
72  };
73 
74 } //FIFE
75 
76 #endif
Controller provides a way to receive events from the system Using this interface, clients can subscri...
virtual void dispatchCommand(Command &command)=0
Use this method to send command to command listeners.
Listener of command events.
virtual void addCommandListenerFront(ICommandListener *listener)=0
Adds a listener to the front of the listener deque Listener will be notified via the corresponding ev...
virtual void addCommandListener(ICommandListener *listener)=0
Adds a listener to the back of the listener deque Listener will be notified via the corresponding eve...
Class for commands Commands are arbitrary events e.g.
Definition: command.h:44
virtual void removeCommandListener(ICommandListener *listener)=0
Removes an added listener from the controller.