scrollbar_view.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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 ** Artem Khomenko
28 */
29 
30 #pragma once
31 
32 #include "../View/view.h"
33 
34 namespace clan
35 {
36  class ScrollBarViewImpl;
37 
38  class ScrollBarView : public View
39  {
40  public:
41  // TODO: decide if "render_button_arrows" is this the best way of controlling rendering
42  ScrollBarView(bool render_button_arrows = true);
43 
44  std::shared_ptr<View> button_decrement() const;
45  std::shared_ptr<View> button_increment() const;
46  std::shared_ptr<View> track() const;
47  std::shared_ptr<View> thumb() const;
48  std::shared_ptr<View> thumb_grip() const;
49 
50  bool vertical() const;
51  bool horizontal() const;
52 
53  void set_vertical();
54  void set_horizontal();
55 
56  bool disabled() const;
57  void set_disabled();
58  void set_enabled();
59 
60  double line_step() const;
61  double page_step() const;
62 
63  void set_line_step(double value);
64  void set_page_step(double value);
65 
67  void set_lock_to_line(bool lock);
68 
69  double min_position() const;
70  double max_position() const;
71  double position() const;
72 
73  void set_min_position(double value);
74  void set_max_position(double value);
75  void set_range(double min_value, double max_value);
76  void set_position(double value);
77 
79 
80  void layout_children(Canvas &canvas) override;
81 
82  private:
83  std::shared_ptr<ScrollBarViewImpl> impl;
84  };
85 }
std::shared_ptr< View > track() const
double line_step() const
double page_step() const
Definition: clanapp.h:35
View for an area of the user interface.
Definition: view.h:65
Signal< void()> & sig_scroll()
double min_position() const
std::shared_ptr< View > button_increment() const
2D Graphics Canvas
Definition: canvas.h:71
bool disabled() const
double max_position() const
std::shared_ptr< View > thumb() const
void set_lock_to_line(bool lock)
When true the position can be only in integer amount of line_step.
bool vertical() const
ScrollBarView(bool render_button_arrows=true)
std::shared_ptr< View > button_decrement() const
void set_position(double value)
double position() const
void set_min_position(double value)
Definition: scrollbar_view.h:38
Canvas canvas() const
void layout_children(Canvas &canvas) override
Sets the view geometry for all children of this view.
bool horizontal() const
std::shared_ptr< View > thumb_grip() const
void set_line_step(double value)
void set_max_position(double value)
void set_range(double min_value, double max_value)
void set_page_step(double value)