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