2020-01-18 11:38:21 +03:00
|
|
|
/*
|
2021-05-03 21:31:58 +03:00
|
|
|
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
|
2022-02-26 20:50:04 +03:00
|
|
|
* Copyright (c) 2022, the SerenityOS developers.
|
2020-01-18 11:38:21 +03:00
|
|
|
*
|
2021-04-22 11:24:48 +03:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 11:38:21 +03:00
|
|
|
*/
|
|
|
|
|
2019-03-16 18:03:31 +03:00
|
|
|
#pragma once
|
|
|
|
|
2020-02-06 22:33:02 +03:00
|
|
|
#include <LibGUI/Frame.h>
|
2021-04-13 17:18:20 +03:00
|
|
|
#include <LibGUI/Scrollbar.h>
|
2019-03-16 18:03:31 +03:00
|
|
|
|
2020-02-02 17:07:41 +03:00
|
|
|
namespace GUI {
|
2019-03-16 18:03:31 +03:00
|
|
|
|
2021-05-03 21:31:58 +03:00
|
|
|
class AbstractScrollableWidget : public Frame {
|
|
|
|
C_OBJECT_ABSTRACT(AbstractScrollableWidget);
|
|
|
|
|
2019-03-16 18:03:31 +03:00
|
|
|
public:
|
2022-02-26 20:50:04 +03:00
|
|
|
virtual ~AbstractScrollableWidget() override = default;
|
2019-03-16 18:03:31 +03:00
|
|
|
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntSize content_size() const { return m_content_size; }
|
2019-03-16 18:54:51 +03:00
|
|
|
int content_width() const { return m_content_size.width(); }
|
|
|
|
int content_height() const { return m_content_size.height(); }
|
2022-06-28 20:30:42 +03:00
|
|
|
Gfx::IntSize min_content_size() const { return m_min_content_size; }
|
2019-03-16 18:54:51 +03:00
|
|
|
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntRect visible_content_rect() const;
|
2019-03-16 18:03:31 +03:00
|
|
|
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntRect widget_inner_rect() const;
|
2019-03-28 18:14:26 +03:00
|
|
|
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntRect viewport_rect_in_content_coordinates() const
|
2020-05-04 23:33:20 +03:00
|
|
|
{
|
|
|
|
auto viewport_rect = visible_content_rect();
|
|
|
|
viewport_rect.set_size(widget_inner_rect().size());
|
|
|
|
return viewport_rect;
|
|
|
|
}
|
|
|
|
|
2022-04-01 20:58:27 +03:00
|
|
|
void scroll_into_view(Gfx::IntRect const&, Orientation);
|
|
|
|
void scroll_into_view(Gfx::IntRect const&, bool scroll_horizontally, bool scroll_vertically);
|
2019-03-16 18:03:31 +03:00
|
|
|
|
2019-03-17 01:16:37 +03:00
|
|
|
void set_scrollbars_enabled(bool);
|
|
|
|
bool is_scrollbars_enabled() const { return m_scrollbars_enabled; }
|
|
|
|
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntSize available_size() const;
|
2021-02-17 20:15:52 +03:00
|
|
|
Gfx::IntSize excess_size() const;
|
2019-03-23 05:53:51 +03:00
|
|
|
|
2021-04-13 17:18:20 +03:00
|
|
|
Scrollbar& vertical_scrollbar() { return *m_vertical_scrollbar; }
|
2022-04-01 20:58:27 +03:00
|
|
|
Scrollbar const& vertical_scrollbar() const { return *m_vertical_scrollbar; }
|
2021-04-13 17:18:20 +03:00
|
|
|
Scrollbar& horizontal_scrollbar() { return *m_horizontal_scrollbar; }
|
2022-04-01 20:58:27 +03:00
|
|
|
Scrollbar const& horizontal_scrollbar() const { return *m_horizontal_scrollbar; }
|
2020-02-02 17:07:41 +03:00
|
|
|
Widget& corner_widget() { return *m_corner_widget; }
|
2022-04-01 20:58:27 +03:00
|
|
|
Widget const& corner_widget() const { return *m_corner_widget; }
|
2019-03-16 18:54:51 +03:00
|
|
|
|
2022-11-29 01:49:10 +03:00
|
|
|
void set_banner_widget(Widget*);
|
|
|
|
Widget* banner_widget() { return m_banner_widget; }
|
|
|
|
Widget const* banner_widget() const { return m_banner_widget; }
|
|
|
|
|
2019-03-19 05:09:21 +03:00
|
|
|
void scroll_to_top();
|
|
|
|
void scroll_to_bottom();
|
2022-12-28 01:02:31 +03:00
|
|
|
void scroll_to_right();
|
2022-11-29 01:58:17 +03:00
|
|
|
void update_scrollbar_ranges();
|
2019-03-19 05:09:21 +03:00
|
|
|
|
2022-12-25 23:41:33 +03:00
|
|
|
void set_automatic_scrolling_timer_active(bool);
|
2022-12-06 23:27:44 +03:00
|
|
|
virtual Gfx::IntPoint automatic_scroll_delta_from_position(Gfx::IntPoint) const;
|
2021-09-16 20:00:09 +03:00
|
|
|
|
2019-06-22 11:39:42 +03:00
|
|
|
int width_occupied_by_vertical_scrollbar() const;
|
|
|
|
int height_occupied_by_horizontal_scrollbar() const;
|
2022-11-29 01:49:10 +03:00
|
|
|
int height_occupied_by_banner_widget() const;
|
2019-06-22 11:39:42 +03:00
|
|
|
|
2021-09-19 01:45:42 +03:00
|
|
|
virtual Margins content_margins() const override;
|
|
|
|
|
2022-06-28 20:30:42 +03:00
|
|
|
void set_should_hide_unnecessary_scrollbars(bool);
|
2019-09-05 22:37:15 +03:00
|
|
|
bool should_hide_unnecessary_scrollbars() const { return m_should_hide_unnecessary_scrollbars; }
|
|
|
|
|
2022-12-06 23:27:44 +03:00
|
|
|
Gfx::IntPoint to_content_position(Gfx::IntPoint widget_position) const;
|
|
|
|
Gfx::IntPoint to_widget_position(Gfx::IntPoint content_position) const;
|
2019-10-03 10:15:57 +03:00
|
|
|
|
2022-04-01 20:58:27 +03:00
|
|
|
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() }; }
|
2020-12-16 21:31:33 +03:00
|
|
|
|
2022-09-22 18:15:25 +03:00
|
|
|
virtual Optional<UISize> calculated_min_size() const override;
|
|
|
|
|
2019-03-16 18:03:31 +03:00
|
|
|
protected:
|
2021-05-03 21:31:58 +03:00
|
|
|
AbstractScrollableWidget();
|
2019-09-01 21:51:20 +03:00
|
|
|
virtual void custom_layout() override;
|
2020-02-02 17:07:41 +03:00
|
|
|
virtual void resize_event(ResizeEvent&) override;
|
|
|
|
virtual void mousewheel_event(MouseEvent&) override;
|
2020-09-18 10:49:51 +03:00
|
|
|
virtual void did_scroll() { }
|
2022-12-25 23:41:33 +03:00
|
|
|
virtual void automatic_scrolling_timer_did_fire() {};
|
2022-12-07 00:35:32 +03:00
|
|
|
void set_content_size(Gfx::IntSize);
|
|
|
|
void set_min_content_size(Gfx::IntSize);
|
|
|
|
void set_size_occupied_by_fixed_elements(Gfx::IntSize);
|
2021-09-19 22:31:19 +03:00
|
|
|
int autoscroll_threshold() const { return m_autoscroll_threshold; }
|
2022-06-28 20:30:42 +03:00
|
|
|
void update_scrollbar_visibility();
|
2019-03-16 18:54:51 +03:00
|
|
|
|
2019-03-16 18:03:31 +03:00
|
|
|
private:
|
2021-05-03 21:31:58 +03:00
|
|
|
class AbstractScrollableWidgetScrollbar final : public Scrollbar {
|
|
|
|
C_OBJECT(AbstractScrollableWidgetScrollbar);
|
2021-02-21 02:19:52 +03:00
|
|
|
|
2021-11-01 01:38:04 +03:00
|
|
|
private:
|
2021-05-03 21:31:58 +03:00
|
|
|
explicit AbstractScrollableWidgetScrollbar(AbstractScrollableWidget& owner, Gfx::Orientation orientation)
|
2021-04-13 17:18:20 +03:00
|
|
|
: Scrollbar(orientation)
|
2021-02-21 02:19:52 +03:00
|
|
|
, m_owner(owner)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
virtual void mousewheel_event(MouseEvent& event) override
|
|
|
|
{
|
|
|
|
m_owner.handle_wheel_event(event, *this);
|
|
|
|
}
|
|
|
|
|
2021-05-03 21:31:58 +03:00
|
|
|
AbstractScrollableWidget& m_owner;
|
2021-02-21 02:19:52 +03:00
|
|
|
};
|
2021-04-13 17:18:20 +03:00
|
|
|
friend class ScrollableWidgetScrollbar;
|
2021-02-21 02:19:52 +03:00
|
|
|
|
|
|
|
void handle_wheel_event(MouseEvent&, Widget&);
|
2019-03-16 18:03:31 +03:00
|
|
|
|
2021-05-03 21:31:58 +03:00
|
|
|
RefPtr<AbstractScrollableWidgetScrollbar> m_vertical_scrollbar;
|
|
|
|
RefPtr<AbstractScrollableWidgetScrollbar> m_horizontal_scrollbar;
|
2020-02-02 17:07:41 +03:00
|
|
|
RefPtr<Widget> m_corner_widget;
|
2022-11-29 01:49:10 +03:00
|
|
|
WeakPtr<Widget> m_banner_widget;
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntSize m_content_size;
|
2022-06-28 20:30:42 +03:00
|
|
|
Gfx::IntSize m_min_content_size;
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntSize m_size_occupied_by_fixed_elements;
|
2019-03-16 18:54:51 +03:00
|
|
|
bool m_scrollbars_enabled { true };
|
2019-09-05 22:37:15 +03:00
|
|
|
bool m_should_hide_unnecessary_scrollbars { false };
|
2021-09-16 20:00:09 +03:00
|
|
|
|
|
|
|
RefPtr<Core::Timer> m_automatic_scrolling_timer;
|
|
|
|
bool m_active_scrolling_enabled { false };
|
|
|
|
int m_autoscroll_threshold { 20 };
|
2019-03-16 18:03:31 +03:00
|
|
|
};
|
2020-02-02 17:07:41 +03:00
|
|
|
|
|
|
|
}
|