spin.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 ** Kenneth Gangstoe
29 */
30 
31 
32 #pragma once
33 
34 #include "../api_gui.h"
35 #include "../gui_component.h"
36 
37 namespace clan
38 {
41 
42 class Spin_Impl;
43 
45 class CL_API_GUI Spin : public GUIComponent
46 {
49 public:
50 
54  Spin(GUIComponent *parent);
55 
56  virtual ~Spin();
57 
61 public:
62 
63 
65 
69  static Spin *get_named_item(GUIComponent *reference_component, const std::string &id);
70 
74  int get_value() const;
75 
79  float get_value_float() const;
80 
84  int get_min() const;
85 
89  int get_max() const;
90 
94  float get_min_float() const;
95 
99  float get_max_float() const;
100 
104  bool get_floating_point_mode() const;
105 
109 public:
110 
114  void set_value(int value);
115 
119  void set_value_float(float value);
120 
125  void set_ranges(int min, int max);
126 
131  void set_ranges_float(float min, float max);
132 
136  void set_step_size(int step_size);
137 
141  void set_step_size_float(float step_size);
142 
146  void set_number_of_decimal_places(int decimal_places);
147 
151  void set_floating_point_mode(bool use_floating_point);
152 
156 public:
157 
161  Callback_v0 &func_value_changed();
162 
166 private:
167  std::shared_ptr<Spin_Impl> impl;
169 };
170 
171 }
172 
A min(A a, B b)
Definition: cl_math.h:51
GUI base component class.
Definition: gui_component.h:80
GUIComponent * get_named_item(const std::string &id)
Find child component with the specified component ID name.
A max(A a, B b)
Definition: cl_math.h:52
Spin component.
Definition: spin.h:45
Callback_v0.
Definition: callback_v0.h:152