Debian Codegraph @

engine/core/gui/fifechan/console/commandline.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_FIFECHAN_ADDON_COMMANDLINE_H
23 #define FIFE_FIFECHAN_ADDON_COMMANDLINE_H
24
25 // Standard C++ library includes
26 #include <functional>
27 #include <string>
28 #include <vector>
29
30 // 3rd party library includes
31 #include <fifechan.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
39 namespace FIFE {
40
41 /** A Command line widget
42 */
43 class CommandLine : public fcn::TextField {
44 public:
45 typedef std::function<void(std::string)> type_callback;
46
47 /** Constructor
48 */
49 CommandLine();
50
51 /** Destructor
52 */
53 ~CommandLine();
54
55 void keyPressed(fcn::KeyEvent& keyEvent);
56 virtual void drawCaret(fcn::Graphics * graphics, int32_t x);
57
58 /** Set callback on pressing the ENTER key
59 */
60 void setCallback(const type_callback& cb);
61
62 /** Toggle the caret visibility
63 */
64 void toggleCaretVisible();
65
66 /** Start blinking the caret
67 */
68 void startBlinking();
69
70 /** Stop blinking the caret for a few seconds
71 */
72 void stopBlinking();
73 private:
74 type_callback m_callback;
75 std::vector<std::string> m_history;
76 size_t m_history_position;
77 std::string m_cmdline;
78 bool m_caretVisible;
79 Timer m_blinkTimer;
80 Timer m_suppressBlinkTimer;
81 };
82 }
83
84 #endif