blob: 88030ef5f6804df979a4f5cf420d2dec9f7ab66d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
* Copyright (c) 2022, the SerenityOS developers.
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <LibGUI/Frame.h>
#include <LibGUI/Scrollbar.h>
namespace GUI {
class AbstractScrollableWidget : public Frame {
C_OBJECT_ABSTRACT(AbstractScrollableWidget);
public:
virtual ~AbstractScrollableWidget() override = default;
Gfx::IntSize content_size() const { return m_content_size; }
int content_width() const { return m_content_size.width(); }
int content_height() const { return m_content_size.height(); }
Gfx::IntSize min_content_size() const { return m_min_content_size; }
Gfx::IntRect visible_content_rect() const;
Gfx::IntRect widget_inner_rect() const;
Gfx::IntRect viewport_rect_in_content_coordinates() const
{
auto viewport_rect = visible_content_rect();
viewport_rect.set_size(widget_inner_rect().size());
return viewport_rect;
}
void scroll_into_view(Gfx::IntRect const&, Orientation);
void scroll_into_view(Gfx::IntRect const&, bool scroll_horizontally, bool scroll_vertically);
void set_scrollbars_enabled(bool);
bool is_scrollbars_enabled() const { return m_scrollbars_enabled; }
Gfx::IntSize available_size() const;
Gfx::IntSize excess_size() const;
Scrollbar& vertical_scrollbar() { return *m_vertical_scrollbar; }
Scrollbar const& vertical_scrollbar() const { return *m_vertical_scrollbar; }
Scrollbar& horizontal_scrollbar() { return *m_horizontal_scrollbar; }
Scrollbar const& horizontal_scrollbar() const { return *m_horizontal_scrollbar; }
Widget& corner_widget() { return *m_corner_widget; }
Widget const& corner_widget() const { return *m_corner_widget; }
void scroll_to_top();
void scroll_to_bottom();
void set_automatic_scrolling_timer(bool active);
virtual Gfx::IntPoint automatic_scroll_delta_from_position(Gfx::IntPoint const&) const;
int width_occupied_by_vertical_scrollbar() const;
int height_occupied_by_horizontal_scrollbar() const;
virtual Margins content_margins() const override;
void set_should_hide_unnecessary_scrollbars(bool);
bool should_hide_unnecessary_scrollbars() const { return m_should_hide_unnecessary_scrollbars; }
Gfx::IntPoint to_content_position(Gfx::IntPoint const& widget_position) const;
Gfx::IntPoint to_widget_position(Gfx::IntPoint const& content_position) const;
Gfx::IntRect to_content_rect(Gfx::IntRect const& widget_rect) const { return { to_content_position(widget_rect.location()), widget_rect.size() }; }
Gfx::IntRect to_widget_rect(Gfx::IntRect const& content_rect) const { return { to_widget_position(content_rect.location()), content_rect.size() }; }
protected:
AbstractScrollableWidget();
virtual void custom_layout() override;
virtual void resize_event(ResizeEvent&) override;
virtual void mousewheel_event(MouseEvent&) override;
virtual void did_scroll() { }
void set_content_size(Gfx::IntSize const&);
void set_min_content_size(Gfx::IntSize const&);
void set_size_occupied_by_fixed_elements(Gfx::IntSize const&);
virtual void on_automatic_scrolling_timer_fired() {};
int autoscroll_threshold() const { return m_autoscroll_threshold; }
void update_scrollbar_visibility();
void update_scrollbar_ranges();
private:
class AbstractScrollableWidgetScrollbar final : public Scrollbar {
C_OBJECT(AbstractScrollableWidgetScrollbar);
private:
explicit AbstractScrollableWidgetScrollbar(AbstractScrollableWidget& owner, Gfx::Orientation orientation)
: Scrollbar(orientation)
, m_owner(owner)
{
}
virtual void mousewheel_event(MouseEvent& event) override
{
m_owner.handle_wheel_event(event, *this);
}
AbstractScrollableWidget& m_owner;
};
friend class ScrollableWidgetScrollbar;
void handle_wheel_event(MouseEvent&, Widget&);
RefPtr<AbstractScrollableWidgetScrollbar> m_vertical_scrollbar;
RefPtr<AbstractScrollableWidgetScrollbar> m_horizontal_scrollbar;
RefPtr<Widget> m_corner_widget;
Gfx::IntSize m_content_size;
Gfx::IntSize m_min_content_size;
Gfx::IntSize m_size_occupied_by_fixed_elements;
bool m_scrollbars_enabled { true };
bool m_should_hide_unnecessary_scrollbars { false };
RefPtr<Core::Timer> m_automatic_scrolling_timer;
bool m_active_scrolling_enabled { false };
int m_autoscroll_threshold { 20 };
};
}
|
