Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-06 16:20:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibGUI/Scrollbar.h

80 lines
2.3 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
*/
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
#pragma once
#include <AK/Function.h>
LibGUI: Make GUI::ScrollBar inherit from AbstractSlider
2020-12-30 15:20:02 +01:00
#include <LibGUI/AbstractSlider.h>
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
namespace GUI {
Everywhere: It's now "Foobar", not "FooBar", and not "foo bar" I hereby declare these to be full nouns that we don't split, neither by space, nor by underscore: - Breadcrumbbar - Coolbar - Menubar - Progressbar - Scrollbar - Statusbar - Taskbar - Toolbar This patch makes everything consistent by replacing every other variant of these with the proper one. :^)
2021-04-13 16:18:20 +02:00
class Scrollbar : public AbstractSlider {
C_OBJECT(Scrollbar);
LibGUI: Make GUI::ScrollBar inherit from AbstractSlider
2020-12-30 15:20:02 +01:00
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
public:
Everywhere: It's now "Foobar", not "FooBar", and not "foo bar" I hereby declare these to be full nouns that we don't split, neither by space, nor by underscore: - Breadcrumbbar - Coolbar - Menubar - Progressbar - Scrollbar - Statusbar - Taskbar - Toolbar This patch makes everything consistent by replacing every other variant of these with the proper one. :^)
2021-04-13 16:18:20 +02:00
virtual ~Scrollbar() override;
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
GScrollBar: Allow scrolling the scrollbar by mouse-wheeling over it
2019-08-20 20:10:02 +02:00
bool is_scrollable() const { return max() != min(); }
LibGUI: Share code for widget rendering styles in a GStyle class. Since GScrollBar wants its internal buttons to look like GButtons, let's share the painting code between them.
2019-02-10 07:11:01 +01:00
bool has_scrubber() const;
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
Meta: Tweak .clang-format to not wrap braces after enums.
2019-06-07 17:13:23 +02:00
enum Component {
LibGUI: Make ScrollBar track the currently pressed component And remove the now-redundant members m_scrubbing, m_scrubber_in_use, and m_automatic_scrolling_kind. This also made it clear that we weren't canceling the autoscroll timer if the scrollbar got disabled while it was scrolling, so this fixes that too.
2020-08-25 12:54:40 -04:00
None,
GScrollBar: Add the same hover highlight effect as GButton.
2019-04-06 13:55:56 +02:00
DecrementButton,
IncrementButton,
Gutter,
Scrubber,
};
LibGUI: Let ScrollableWidget handle the wheel events of its ScrollBars Route the ScrollBar's wheel event to the ScrollableWidget so it can handle it itself. This allows it to handle it consistently (e.g. speed) when the cursor is hovering the scroll bars rather than the widget's contents. Fixes #5419
2021-02-20 16:19:52 -07:00
protected:
Everywhere: It's now "Foobar", not "FooBar", and not "foo bar" I hereby declare these to be full nouns that we don't split, neither by space, nor by underscore: - Breadcrumbbar - Coolbar - Menubar - Progressbar - Scrollbar - Statusbar - Taskbar - Toolbar This patch makes everything consistent by replacing every other variant of these with the proper one. :^)
2021-04-13 16:18:20 +02:00
explicit Scrollbar(Gfx::Orientation = Gfx::Orientation::Vertical);
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
virtual void paint_event(PaintEvent&) override;
virtual void mousedown_event(MouseEvent&) override;
virtual void mouseup_event(MouseEvent&) override;
virtual void mousemove_event(MouseEvent&) override;
virtual void mousewheel_event(MouseEvent&) override;
LibCore: Put all classes in the Core namespace and remove the leading C I've been wanting to do this for a long time. It's time we start being consistent about how this stuff works. The new convention is: - "LibFoo" is a userspace library that provides the "Foo" namespace. That's it :^) This was pretty tedious to convert and I didn't even start on LibGUI yet. But it's coming up next.
2020-02-02 12:34:39 +01:00
virtual void leave_event(Core::Event&) override;
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
virtual void change_event(Event&) override;
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
LibGUI: Let ScrollableWidget handle the wheel events of its ScrollBars Route the ScrollBar's wheel event to the ScrollableWidget so it can handle it itself. This allows it to handle it consistently (e.g. speed) when the cursor is hovering the scroll bars rather than the widget's contents. Fixes #5419
2021-02-20 16:19:52 -07:00
private:
LibGUI: Add visual clue to Scrollbar gutter This adds a visual clue to scrolling by clicking on the Scrollbar gutter. This gives the user a hint that scrolling will continue in the direction of the darkened gutter, until the mouse is released. It is inspired by very similar behavior on old windows.
2021-11-02 12:01:18 +01:00
enum class GutterClickState {
NotPressed,
BeforeScrubber,
AfterScrubber,
} gutter_click_state
= GutterClickState::NotPressed;
LibGUI: GScrollbar compression when very small (#255) Fixes #124.
2019-07-01 02:46:36 -05:00
int default_button_size() const { return 16; }
int button_size() const { return length(orientation()) <= (default_button_size() * 2) ? length(orientation()) / 2 : default_button_size(); }
GScrollBar: Improve appearance for curiously-shaped scrollbars.
2019-04-11 13:16:43 +02:00
int button_width() const { return orientation() == Orientation::Vertical ? width() : button_size(); }
int button_height() const { return orientation() == Orientation::Horizontal ? height() : button_size(); }
LibGfx: Rename Rect,Point,Size => IntRect,IntPoint,IntSize This fits nicer with FloatRect,FloatPoint,FloatSize and gives a much better visual clue about what type of metric is being used.
2020-06-10 10:57:59 +02:00
Gfx::IntRect decrement_button_rect() const;
Gfx::IntRect increment_button_rect() const;
Gfx::IntRect scrubber_rect() const;
LibGUI: Calculate unclamped_scrubber_size() as float Large enough content ranges produced unclamped scrubbers sized zero, effectively clamped by their integer type. This led to zero sized page_increments and scrubbers which didn't budge on gutter events. This fixes broken gutters in FontEditor and TextEditor for large files.
2021-09-21 17:51:56 -04:00
float unclamped_scrubber_size() const;
GUI: Rename ScrollBar::scrubber_size() to ScrollBar::visibile_scrubber_size()
2020-08-11 21:32:40 -04:00
int visible_scrubber_size() const;
LibGUI: Support dragging the GScrollBar scrubber. This was pleasantly easy to implement with the global mouse tracking. :^)
2019-02-10 06:51:01 +01:00
int scrubbable_range_in_pixels() const;
GScrollBar: Keep scrolling while pushing down increment/decrement button.
2019-06-07 10:43:10 +02:00
void on_automatic_scrolling_timer_fired();
LibGUI: Make ScrollBar track the currently pressed component And remove the now-redundant members m_scrubbing, m_scrubber_in_use, and m_automatic_scrolling_kind. This also made it clear that we weren't canceling the autoscroll timer if the scrollbar got disabled while it was scrolling, so this fixes that too.
2020-08-25 12:54:40 -04:00
void set_automatic_scrolling_active(bool, Component);
LibGUI: Start working on a GScrollBar. This widget is far from finished, but it's off to a good start. Also added a GResizeEvent and GWidget::resize_event() so that widgets can react to being resized.
2019-02-09 11:19:38 +01:00
GUI: Extract a ScrollBar::scroll_to_position method
2020-08-11 20:56:52 -04:00
void scroll_to_position(const Gfx::IntPoint&);
ScrollBar: Let clicking the gutter scroll by one page Shift-clicking has the old behavior of jumping to the click position. This matches scrollbar behavior in macOS and Windows, and in many Linux apps.
2020-08-11 21:35:15 -04:00
void scroll_by_page(const Gfx::IntPoint&);
GUI: Extract a ScrollBar::scroll_to_position method
2020-08-11 20:56:52 -04:00
LibGUI: Extract ScrollBar::component_at_position() method ...and use it in mousedown_event(), which allows putting in stricter asserts.
2020-08-25 10:31:20 -04:00
Component component_at_position(const Gfx::IntPoint&);
LibGUI: Support dragging the GScrollBar scrubber. This was pleasantly easy to implement with the global mouse tracking. :^)
2019-02-10 06:51:01 +01:00
int m_scrub_start_value { 0 };
LibGfx: Rename Rect,Point,Size => IntRect,IntPoint,IntSize This fits nicer with FloatRect,FloatPoint,FloatSize and gives a much better visual clue about what type of metric is being used.
2020-06-10 10:57:59 +02:00
Gfx::IntPoint m_scrub_origin;
LibGUI: Improve GScrollBar button look a bit. The arrows look better when they're sharp. :^)
2019-02-10 11:57:19 +01:00
LibGUI: Make ScrollBar track the currently pressed component And remove the now-redundant members m_scrubbing, m_scrubber_in_use, and m_automatic_scrolling_kind. This also made it clear that we weren't canceling the autoscroll timer if the scrollbar got disabled while it was scrolling, so this fixes that too.
2020-08-25 12:54:40 -04:00
Component m_hovered_component { Component::None };
Component m_pressed_component { Component::None };
LibGUI: Keep scrollbar timer active while mouse is down Rather than disable and re-enable the timer, always keep it active and make it do collision checks to decide if it should have an effect. This is because set_automatic_scrolling_active(true) calls the timeout callback immediately before starting the timer, and when clicking the gutter this callback could disable the timer again (if the first page scroll put the scrubber under the cursor). Intead of making set_automatic_scrolling_active() work when it's called reentrantly (which is easy: just swap the order of on_automatic_scrolling_timer_fired() and timer->start() so that on_automatic_scrolling_timer_fired() can immediately stop the timer again, but it's confusing), make the timer check if it should do anything. This is keyed off m_last_mouse_position instead of m_hovered_component because m_hovered_component is a visual state and we arguably shouldn't modify it while the left mouse button is down (as it indicated what part is activated on click).
2020-08-25 11:04:53 -04:00
Gfx::IntPoint m_last_mouse_position;
GScrollBar: Keep scrolling while pushing down increment/decrement button.
2019-06-07 10:43:10 +02:00
LibCore: Put all classes in the Core namespace and remove the leading C I've been wanting to do this for a long time. It's time we start being consistent about how this stuff works. The new convention is: - "LibFoo" is a userspace library that provides the "Foo" namespace. That's it :^) This was pretty tedious to convert and I didn't even start on LibGUI yet. But it's coming up next.
2020-02-02 12:34:39 +01:00
RefPtr<Core::Timer> m_automatic_scrolling_timer;
LibGUI: Support dragging the GScrollBar scrubber. This was pleasantly easy to implement with the global mouse tracking. :^)
2019-02-10 06:51:01 +01:00
};
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
}
Reference in a new issue Copy permalink