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();
53 void set_horizontal();
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 }
clan::ScrollBarView::track
std::shared_ptr< View > track() const
clan::ScrollBarView::line_step
double line_step() const
clan::ScrollBarView::page_step
double page_step() const
clan
Definition: clanapp.h:35
clan::View
View for an area of the user interface.
Definition: view.h:61
clan::ScrollBarView::sig_scroll
Signal< void()> & sig_scroll()
clan::ScrollBarView::min_position
double min_position() const
clan::ScrollBarView::button_increment
std::shared_ptr< View > button_increment() const
clan::Canvas
2D Graphics Canvas
Definition: canvas.h:72
clan::ScrollBarView::disabled
bool disabled() const
clan::ScrollBarView::set_vertical
void set_vertical()
clan::ScrollBarView::max_position
double max_position() const
clan::ScrollBarView::thumb
std::shared_ptr< View > thumb() const
clan::ScrollBarView::vertical
bool vertical() const
clan::ScrollBarView::set_disabled
void set_disabled()
clan::ScrollBarView::set_enabled
void set_enabled()
clan::ScrollBarView::ScrollBarView
ScrollBarView(bool render_button_arrows=true)
clan::ScrollBarView::button_decrement
std::shared_ptr< View > button_decrement() const
clan::ScrollBarView::set_position
void set_position(double value)
clan::ScrollBarView::position
double position() const
clan::ScrollBarView::set_min_position
void set_min_position(double value)
clan::ScrollBarView::layout_subviews
void layout_subviews(Canvas &canvas) override
Sets the view geometry for all subviews of this view.
clan::Signal< void()>
clan::ScrollBarView
Definition: scrollbar_view.h:37
clan::ScrollBarView::horizontal
bool horizontal() const
clan::ScrollBarView::set_horizontal
void set_horizontal()
clan::ScrollBarView::thumb_grip
std::shared_ptr< View > thumb_grip() const
clan::ScrollBarView::set_line_step
void set_line_step(double value)
clan::ScrollBarView::set_max_position
void set_max_position(double value)
clan::ScrollBarView::set_range
void set_range(double min_value, double max_value)
clan::ScrollBarView::set_page_step
void set_page_step(double value)