source: flair-dev/trunk/include/FlairCore/SpinBox.h @ 76

Last change on this file since 76 was 13, checked in by Bayard Gildas, 5 years ago

formatting script + include reformatted

File size: 1.9 KB
Line 
1// %flair:license{
2// This file is part of the Flair framework distributed under the
3// CECILL-C License, Version 1.0.
4// %flair:license}
5/*!
6 * \file SpinBox.h
7 * \brief Class displaying a QSpinBox on the ground station
8 * \author Guillaume Sanahuja, Copyright Heudiasyc UMR UTC/CNRS 7253
9 * \date 2011/10/07
10 * \version 4.0
11 */
12
13#ifndef SPINBOX_H
14#define SPINBOX_H
15
16#include <Box.h>
17
18namespace flair {
19namespace gui {
20
21class LayoutPosition;
22
23/*! \class SpinBox
24*
25* \brief Class displaying a QSpinBox on the ground station
26*
27*/
28class SpinBox : public Box {
29public:
30  /*!
31  * \brief Constructor
32  *
33  * Construct a QSpinBox at given position. \n
34  * The QSpinBox is saturated to min and max values.
35  *
36  * \param position position to display the QSpinBox
37  * \param name name
38  * \param min minimum value
39  * \param max maximum value
40  * \param step step
41  * \param default_value default value if not in the xml config file
42  */
43  SpinBox(const LayoutPosition *position, std::string name, int min, int max,
44          int step, int default_value = 0); /*!
45
46* \brief Constructor
47*
48* Construct a QSpinBox at given position. \n
49* The QSpinBox is saturated to min and max values.
50*
51* \param position position to display the QSpinBox
52* \param name name
53* \param suffix suffix for the value (eg unit)
54* \param min minimum value
55* \param max maximum value
56* \param step step
57* \param default_value default value if not in the xml config file
58*/
59  SpinBox(const LayoutPosition *position, std::string name, std::string suffix,
60          int min, int max, int step, int default_value = 0);
61
62  /*!
63  * \brief Destructor
64  *
65  */
66  ~SpinBox();
67
68  /*!
69   * \brief Value
70   *
71   * \return value
72   */
73  int Value(void) const;
74
75private:
76  /*!
77  * \brief XmlEvent from ground station
78  *
79  * Reimplemented from Widget.
80  *
81  */
82  void XmlEvent(void);
83
84  int box_value;
85};
86
87} // end namespace gui
88} // end namespace flair
89
90#endif // SPINBOX_H
Note: See TracBrowser for help on using the repository browser.