Debian Codegraph @

engine/core/gui/hybrid/hybridguimanager.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 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_GUI_HYBRIDGUIMANAGER_H
23 #define FIFE_GUI_HYBRIDGUIMANAGER_H
24
25 // Standard C++ library includes
26 #include <vector>
27
28 // 3rd party library includes
29
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34 #include "util/base/singleton.h"
35 #include "gui/guimanager.h"
36
37 namespace FIFE {
38
39 class HybridGuiManager :
40 public IGUIManager,
41 public DynamicSingleton<HybridGuiManager> {
42
43 public:
44
45 /** Constructor.
46 */
47 HybridGuiManager();
48
49 /** Destructor.
50 */
51 ~HybridGuiManager();
52
53 /** Adds a gui manager to this hybrid manager.
54 *
55 * WARNING This object gains ownership of the added gui manager.
56 */
57 void addGuiManager(IGUIManager* guiManager);
58
59 /** Removes a gui manager from this hybrid manager.
60 *
61 * WARNING This object loses owenership of the removed gui manager.
62 */
63 void removeGuiManager(IGUIManager* guiManager);
64
65 /** Calls turn for each gui manager in the hybrid manager's queue.
66 */
67 virtual void turn();
68
69 /** Calls onSdlEvent for each gui manager in the hybrid manager's queue.
70 *
71 * @param event: The event to be processed by each gui manager.
72 * @return A boolean value indicating if the event was consumed by one of the
73 * gui managers in the queue.
74 */
75 virtual bool onSdlEvent(SDL_Event& event);
76
77 /** Calls resize top container for each of the gui managers in the queue.
78 */
79 virtual void resizeTopContainer(uint32_t x, uint32_t y, uint32_t width, uint32_t height);
80
81 private:
82
83 /** All gui managers composing this hybrid gui manager.
84 */
85 std::vector<IGUIManager*> m_guiManagers;
86 };
87
88 }
89
90 #endif // FIFE_GUI_HYBRIDGUIMANAGER_H