CLI  2.9
ui_float.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2006-2018, Alexis Royer, http://alexis.royer.free.fr/CLI
3 
4  All rights reserved.
5 
6  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
7 
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
9  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
10  and/or other materials provided with the distribution.
11  * Neither the name of the CLI library project nor the names of its contributors may be used to endorse or promote products derived from this software
12  without specific prior written permission.
13 
14  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
23  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26 
27 
31 
32 #ifndef _CLI_UI_FLOAT_H_
33 #define _CLI_UI_FLOAT_H_
34 
35 #include "cli/ui_line.h"
36 
37 
39 
40  CLI_NS_BEGIN(ui)
41 
42 
43  class Float : public Line
44  {
45  public:
47  explicit Float(
48  const double D_DefaultValue,
49  const double D_MinValue,
50  const double D_MaxValue
51  );
52 
54  explicit Float(
55  ExecutionContext& CLI_ParentContext,
56  const double D_DefaultValue,
57  const double D_MinValue,
58  const double D_MaxValue
59  );
60 
62  virtual ~Float(void);
63 
64  private:
66  explicit Float(void);
68  Float(const Float&);
70  Float& operator=(const Float&);
71 
72  public:
75  const double GetFloat(void) const;
76 
77  protected:
78  // cli::ui::UI interface implementation.
79  virtual void ResetToDefault(void);
80  public:
81  // Inherit doxygen comments from cli::ExecutionContext interface documentation.
82  virtual void OnKey(const KEY E_KeyCode);
83 
84  private:
85  const double m_dDefaultValue;
86  const double m_dMinValue;
87  const double m_dMaxValue;
88  };
89 
90  CLI_NS_END(ui)
91 
93 
94 #endif // _CLI_UI_FLOAT_H_
Main namespace of the CLI library.
Simple line user interface object.
Definition: ui_line.h:47
#define CLI_NS_END(__ns)
End a namespace definition.
Definition: namespace.h:45
Execution context.
Definition: exec_context.h:149
enum _KEY KEY
Input keys.
#define CLI_NS_BEGIN(__ns)
Begin a namespace definition.
Definition: namespace.h:38
Line class definition.
Float user interface class.
Definition: ui_float.h:43