Mercurial > fife-parpg

comparison engine/core/gui/console/commandline.h @ 697:ecaa4d98f05f tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Abstracted the GUI code and refactored the GUIChan-specific code into its own module. * Most of the GUIChan code has been refactored into its own gui/guichan module. However, references to the GuiFont class still persist in the Engine and GuiManager code and these will need further refactoring. * GuiManager is now an abstract base class which specific implementations (e.g. GUIChan) should subclass. * The GUIChan GUI code is now a concrete implementation of GuiManager, most of which is in the new GuiChanGuiManager class. * The GUI code in the Console class has been refactored out of the Console and into the GUIChan module as its own GuiChanConsoleWidget class. The rest of the Console class related to executing commands was left largely unchanged. * Existing client code may need to downcast the GuiManager pointer received from FIFE::Engine::getGuiManager() to GuiChanGuiManager, since not all functionality is represented in the GuiManager abstract base class. Python client code can use the new GuiChanGuiManager.castTo static method for this purpose.
author M. George Hansen <technopolitica@gmail.com>
date Sat, 18 Jun 2011 00:28:40 -1000
parents e201abd8c807
children
comparison
equal deleted inserted replaced
696:e201abd8c807 697:ecaa4d98f05f
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
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_GUICHAN_ADDON_COMMANDLINE_H
23 #define FIFE_GUICHAN_ADDON_COMMANDLINE_H
24
25 // Standard C++ library includes
26 #include <string>
27 #include <vector>
28
29 // 3rd party library includes
30 #include <boost/function.hpp>
31 #include <guichan.hpp>
32
33 // FIFE includes
34 // These includes are split up in two parts, separated by one empty line
35 // First block: files included from the FIFE root src directory
36 // Second block: files included from the same folder
37 #include "util/time/timer.h"
38 #include "gui/widgets/utf8textfield.h"
39
40 namespace FIFE {
41
42 /** A Command line widget
43 */
44 class CommandLine : public gcn::UTF8TextField {
45 public:
46 typedef boost::function1<void,std::string> type_callback;
47
48 /** Constructor
49 */
50 CommandLine();
51
52 /** Destructor
53 */
54 ~CommandLine();
55
56 void keyPressed(gcn::KeyEvent& keyEvent);
57 virtual void drawCaret(gcn::Graphics * graphics, int x);
58
59 /** Set callback on pressing the ENTER key
60 */
61 void setCallback(const type_callback& cb);
62
63 /** Toggle the caret visibility
64 */
65 void toggleCaretVisible();
66
67 /** Start blinking the caret
68 */
69 void startBlinking();
70
71 /** Stop blinking the caret for a few seconds
72 */
73 void stopBlinking();
74 private:
75 type_callback m_callback;
76 std::vector<std::string> m_history;
77 size_t m_history_position;
78 std::string m_cmdline;
79 bool m_caretVisible;
80 Timer m_blinkTimer;
81 Timer m_suppressBlinkTimer;
82 };
83 }
84 #endif
85 /* vim: set noexpandtab: set shiftwidth=2: set tabstop=2: */