ClanLib  2.3.7
slider.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 */
29 
32 
33 #pragma once
34 
35 #include "../api_gui.h"
36 #include "../gui_component.h"
37 
38 class CL_Slider_Impl;
39 
44 {
47 
48 public:
49 
53  CL_Slider(CL_GUIComponent *parent);
54 
55  virtual ~CL_Slider();
56 
60 
61 public:
63 
67  static CL_Slider *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
68 
72  bool is_vertical() const;
73 
77  bool is_horizontal() const;
78 
82  int get_min() const;
83 
87  int get_max() const;
88 
92  int get_tick_count() const;
93 
97  int get_page_step() const;
98 
102  int get_position() const;
103 
107  bool get_lock_to_ticks() const;
108 
112  CL_Size get_preferred_size() const;
113 
117 
118 public:
119 
123  void set_vertical(bool enable);
124 
128  void set_horizontal(bool enable);
129 
133  void set_min(int slider_min);
134 
138  void set_max(int slider_max);
139 
143  void set_tick_count(int tick_count);
144 
148  void set_page_step(int steps);
149 
153  void set_lock_to_ticks(bool lock);
154 
161  void set_ranges(int slider_min, int slider_max, unsigned int tick_count, int page_step);
162 
166  void set_position(int pos);
167 
171 
172 public:
174  CL_Callback_v0 &func_value_changed();
175 
177 
178  CL_Callback_v0 &func_value_decremented();
179 
181 
182  CL_Callback_v0 &func_value_incremented();
183 
185  CL_Callback_v0 &func_slider_moved();
186 
190 
191 private:
192  CL_SharedPtr<CL_Slider_Impl> impl;
194 };
195