FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
commandline.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_FIFECHAN_ADDON_COMMANDLINE_H
23 #define FIFE_FIFECHAN_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 <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 
43  class CommandLine : public fcn::TextField {
44  public:
45  typedef boost::function1<void,std::string> type_callback;
46 
49  CommandLine();
50 
53  ~CommandLine();
54 
55  void keyPressed(fcn::KeyEvent& keyEvent);
56  virtual void drawCaret(fcn::Graphics * graphics, int32_t x);
57 
60  void setCallback(const type_callback& cb);
61 
64  void toggleCaretVisible();
65 
68  void startBlinking();
69 
72  void stopBlinking();
73  private:
74  type_callback m_callback;
75  std::vector<std::string> m_history;
77  std::string m_cmdline;
81  };
82 }
83 
84 #endif
std::string m_cmdline
Definition: commandline.h:77
void stopBlinking()
Stop blinking the caret for a few seconds.
Definition: commandline.cpp:59
void setCallback(const type_callback &cb)
Set callback on pressing the ENTER key.
A Command line widget.
Definition: commandline.h:43
type_callback m_callback
Definition: commandline.h:74
size_t m_history_position
Definition: commandline.h:76
void keyPressed(fcn::KeyEvent &keyEvent)
Definition: commandline.cpp:70
boost::function1< void, std::string > type_callback
Definition: commandline.h:45
void toggleCaretVisible()
Toggle the caret visibility.
Definition: commandline.cpp:55
void startBlinking()
Start blinking the caret.
Definition: commandline.cpp:65
Simple Timer class.
Definition: timer.h:61
std::vector< std::string > m_history
Definition: commandline.h:75
~CommandLine()
Destructor.
Definition: commandline.cpp:52
virtual void drawCaret(fcn::Graphics *graphics, int32_t x)
CommandLine()
Constructor.
Definition: commandline.cpp:41
Timer m_suppressBlinkTimer
Definition: commandline.h:80