ClanLib  2.3.7
scrollbar.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 ** Kenneth Gangstoe
29 */
30 
33 
34 #pragma once
35 
36 #include "../api_gui.h"
37 #include "../gui_component.h"
38 #include "../../Core/Signals/callback_v0.h"
39 
40 class CL_ScrollBar_Impl;
41 
46 {
49 public:
50 
55 
56  virtual ~CL_ScrollBar();
57 
61 public:
63 
67  static CL_ScrollBar *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_line_step() const;
93 
97  int get_page_step() const;
98 
102  int get_position() const;
103 
107  virtual CL_Size get_preferred_size() const;
108 
110  int get_preferred_width() const;
111 
113  int get_preferred_height() const;
114 
118 public:
119 
121  void set_vertical();
122 
124  void set_horizontal();
125 
129  void set_min(int scroll_min);
130 
134  void set_max(int scroll_max);
135 
139  void set_line_step(int step);
140 
144  void set_page_step(int step);
145 
152  void set_ranges(int scroll_min, int scroll_max, int line_step, int page_step);
153 
155 
159  void calculate_ranges(int view_size, int total_size);
160 
164  void set_position(int pos);
165 
169 public:
171  CL_Callback_v0 &func_scroll();
172 
174  CL_Callback_v0 &func_scroll_min();
175 
177  CL_Callback_v0 &func_scroll_max();
178 
180  CL_Callback_v0 &func_scroll_line_decrement();
181 
183  CL_Callback_v0 &func_scroll_line_increment();
184 
186  CL_Callback_v0 &func_scroll_page_decrement();
187 
189  CL_Callback_v0 &func_scroll_page_increment();
190 
192  CL_Callback_v0 &func_scroll_thumb_release();
193 
195  CL_Callback_v0 &func_scroll_thumb_track();
196 
198  CL_Callback_v0 &func_scroll_end();
199 
203 
204 private:
205  CL_SharedPtr<CL_ScrollBar_Impl> impl;
207 };
208