mirror of
https://github.com/RGBCube/serenity
synced 2025-10-31 13:02:45 +00:00
101 lines
3.9 KiB
C++
101 lines
3.9 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <LibGUI/Frame.h>
|
|
|
|
namespace GUI {
|
|
|
|
class ScrollableWidget : public Frame {
|
|
C_OBJECT(ScrollableWidget)
|
|
public:
|
|
virtual ~ScrollableWidget() override;
|
|
|
|
Gfx::Size 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::Rect visible_content_rect() const;
|
|
|
|
Gfx::Rect widget_inner_rect() const;
|
|
|
|
Gfx::Rect 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(const Gfx::Rect&, Orientation);
|
|
void scroll_into_view(const Gfx::Rect&, bool scroll_horizontally, bool scroll_vertically);
|
|
|
|
void set_scrollbars_enabled(bool);
|
|
bool is_scrollbars_enabled() const { return m_scrollbars_enabled; }
|
|
|
|
Gfx::Size available_size() const;
|
|
|
|
ScrollBar& vertical_scrollbar() { return *m_vertical_scrollbar; }
|
|
const ScrollBar& vertical_scrollbar() const { return *m_vertical_scrollbar; }
|
|
ScrollBar& horizontal_scrollbar() { return *m_horizontal_scrollbar; }
|
|
const ScrollBar& horizontal_scrollbar() const { return *m_horizontal_scrollbar; }
|
|
Widget& corner_widget() { return *m_corner_widget; }
|
|
const Widget& corner_widget() const { return *m_corner_widget; }
|
|
|
|
void scroll_to_top();
|
|
void scroll_to_bottom();
|
|
|
|
int width_occupied_by_vertical_scrollbar() const;
|
|
int height_occupied_by_horizontal_scrollbar() const;
|
|
|
|
void set_should_hide_unnecessary_scrollbars(bool b) { m_should_hide_unnecessary_scrollbars = b; }
|
|
bool should_hide_unnecessary_scrollbars() const { return m_should_hide_unnecessary_scrollbars; }
|
|
|
|
Gfx::Point to_content_position(const Gfx::Point& widget_position) const;
|
|
Gfx::Point to_widget_position(const Gfx::Point& content_position) const;
|
|
|
|
protected:
|
|
ScrollableWidget();
|
|
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(const Gfx::Size&);
|
|
void set_size_occupied_by_fixed_elements(const Gfx::Size&);
|
|
|
|
private:
|
|
void update_scrollbar_ranges();
|
|
|
|
RefPtr<ScrollBar> m_vertical_scrollbar;
|
|
RefPtr<ScrollBar> m_horizontal_scrollbar;
|
|
RefPtr<Widget> m_corner_widget;
|
|
Gfx::Size m_content_size;
|
|
Gfx::Size m_size_occupied_by_fixed_elements;
|
|
bool m_scrollbars_enabled { true };
|
|
bool m_should_hide_unnecessary_scrollbars { false };
|
|
};
|
|
|
|
}
|