2020-01-18 11:38:21 +03:00
|
|
|
/*
|
2023-02-20 21:03:44 +03:00
|
|
|
* Copyright (c) 2018-2023, 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-05-05 02:31:02 +03:00
|
|
|
#pragma once
|
|
|
|
|
2021-06-15 15:28:39 +03:00
|
|
|
#include <LibGUI/Margins.h>
|
2020-02-06 22:33:02 +03:00
|
|
|
#include <LibGUI/Widget.h>
|
2023-10-27 23:24:15 +03:00
|
|
|
#include <LibGfx/TabPosition.h>
|
2019-05-05 02:31:02 +03:00
|
|
|
|
2020-02-02 17:07:41 +03:00
|
|
|
namespace GUI {
|
|
|
|
|
|
|
|
class TabWidget : public Widget {
|
|
|
|
C_OBJECT(TabWidget)
|
2019-05-05 02:31:02 +03:00
|
|
|
public:
|
2022-02-26 20:50:04 +03:00
|
|
|
virtual ~TabWidget() override = default;
|
2019-05-05 02:31:02 +03:00
|
|
|
|
2019-07-28 18:39:04 +03:00
|
|
|
TabPosition tab_position() const { return m_tab_position; }
|
|
|
|
void set_tab_position(TabPosition);
|
2022-05-17 13:47:35 +03:00
|
|
|
bool has_vertical_tabs() const { return m_tab_position == TabPosition::Left || m_tab_position == TabPosition::Right; }
|
2019-09-07 17:57:26 +03:00
|
|
|
|
2021-07-28 03:11:41 +03:00
|
|
|
Optional<size_t> active_tab_index() const;
|
2022-06-05 14:08:09 +03:00
|
|
|
size_t tab_count() { return m_tabs.size(); }
|
2019-07-28 18:39:04 +03:00
|
|
|
|
2020-02-02 17:07:41 +03:00
|
|
|
Widget* active_widget() { return m_active_widget.ptr(); }
|
2022-04-01 20:58:27 +03:00
|
|
|
Widget const* active_widget() const { return m_active_widget.ptr(); }
|
2020-02-02 17:07:41 +03:00
|
|
|
void set_active_widget(Widget*);
|
2021-01-08 03:01:23 +03:00
|
|
|
void set_tab_index(int);
|
2019-05-05 02:31:02 +03:00
|
|
|
|
2022-05-17 13:47:35 +03:00
|
|
|
int bar_height() const { return m_bar_visible ? 22 : 0; }
|
|
|
|
|
|
|
|
int get_max_tab_width() const { return m_bar_visible ? m_max_tab_width : 0; }
|
|
|
|
void set_max_tab_width(int width) { m_max_tab_width = width; }
|
|
|
|
|
|
|
|
int get_min_tab_width() const { return m_min_tab_width; }
|
|
|
|
void set_min_tab_width(int width) { m_min_tab_width = width; }
|
2020-04-24 21:30:32 +03:00
|
|
|
|
2021-06-15 15:28:39 +03:00
|
|
|
GUI::Margins const& container_margins() const { return m_container_margins; }
|
|
|
|
void set_container_margins(GUI::Margins const&);
|
2019-05-05 02:31:02 +03:00
|
|
|
|
2022-07-04 06:39:24 +03:00
|
|
|
Optional<UISize> calculated_min_size() const override;
|
|
|
|
Optional<UISize> calculated_preferred_size() const override;
|
|
|
|
|
2022-03-19 00:57:05 +03:00
|
|
|
ErrorOr<void> try_add_widget(Widget&);
|
2021-11-24 15:13:30 +03:00
|
|
|
|
2022-03-19 00:57:05 +03:00
|
|
|
void add_widget(Widget&);
|
2020-04-06 01:02:24 +03:00
|
|
|
void remove_widget(Widget&);
|
2020-02-23 14:23:48 +03:00
|
|
|
|
|
|
|
template<class T, class... Args>
|
2023-03-10 20:55:52 +03:00
|
|
|
T& add_tab(String title, Args&&... args)
|
2020-02-23 14:23:48 +03:00
|
|
|
{
|
|
|
|
auto t = T::construct(forward<Args>(args)...);
|
2023-03-10 20:55:52 +03:00
|
|
|
t->set_title(move(title));
|
2022-03-19 00:57:05 +03:00
|
|
|
add_widget(*t);
|
2020-04-04 12:10:07 +03:00
|
|
|
return *t;
|
2020-02-23 14:23:48 +03:00
|
|
|
}
|
2019-05-05 02:31:02 +03:00
|
|
|
|
2023-09-14 10:29:47 +03:00
|
|
|
void add_tab(NonnullRefPtr<Widget> const& tab, String title)
|
2022-12-16 03:49:54 +03:00
|
|
|
{
|
2023-03-10 20:55:52 +03:00
|
|
|
tab->set_title(move(title));
|
2023-09-14 10:29:47 +03:00
|
|
|
add_widget(*tab);
|
2022-12-16 03:49:54 +03:00
|
|
|
}
|
|
|
|
|
2020-04-06 01:02:24 +03:00
|
|
|
void remove_tab(Widget& tab) { remove_widget(tab); }
|
2021-08-06 05:01:32 +03:00
|
|
|
void remove_all_tabs_except(Widget& tab);
|
2020-04-06 01:02:24 +03:00
|
|
|
|
2023-03-10 22:25:41 +03:00
|
|
|
void set_tab_title(Widget& tab, String title);
|
2022-04-01 20:58:27 +03:00
|
|
|
void set_tab_icon(Widget& tab, Gfx::Bitmap const*);
|
2024-03-28 19:17:07 +03:00
|
|
|
void set_tab_action_icon(Widget& tab, Gfx::Bitmap const*);
|
2020-04-23 22:13:47 +03:00
|
|
|
|
2022-11-04 11:48:47 +03:00
|
|
|
bool is_tab_modified(Widget& tab);
|
|
|
|
void set_tab_modified(Widget& tab, bool modified);
|
|
|
|
bool is_any_tab_modified();
|
|
|
|
|
2020-04-23 22:43:08 +03:00
|
|
|
void activate_next_tab();
|
|
|
|
void activate_previous_tab();
|
2022-03-16 22:06:27 +03:00
|
|
|
void activate_last_tab();
|
2020-04-23 22:43:08 +03:00
|
|
|
|
2020-04-24 23:27:46 +03:00
|
|
|
void set_text_alignment(Gfx::TextAlignment alignment) { m_text_alignment = alignment; }
|
|
|
|
Gfx::TextAlignment text_alignment() const { return m_text_alignment; }
|
|
|
|
|
2020-09-15 22:33:37 +03:00
|
|
|
bool uniform_tabs() const { return m_uniform_tabs; }
|
2020-04-24 23:36:25 +03:00
|
|
|
void set_uniform_tabs(bool uniform_tabs) { m_uniform_tabs = uniform_tabs; }
|
|
|
|
int uniform_tab_width() const;
|
|
|
|
|
2020-05-19 00:44:08 +03:00
|
|
|
void set_bar_visible(bool bar_visible);
|
2023-07-08 05:48:11 +03:00
|
|
|
bool is_bar_visible() const { return m_bar_visible; }
|
2020-05-19 00:44:08 +03:00
|
|
|
|
2023-07-08 05:48:11 +03:00
|
|
|
void set_close_button_enabled(bool close_button_enabled) { m_close_button_enabled = close_button_enabled; }
|
2022-05-05 16:08:33 +03:00
|
|
|
bool close_button_enabled() const { return m_close_button_enabled; }
|
2021-06-19 13:10:43 +03:00
|
|
|
|
2021-10-07 10:52:04 +03:00
|
|
|
void set_reorder_allowed(bool reorder_allowed) { m_reorder_allowed = reorder_allowed; }
|
|
|
|
bool reorder_allowed() const { return m_reorder_allowed; }
|
|
|
|
|
2021-04-09 23:23:14 +03:00
|
|
|
Function<void(size_t)> on_tab_count_change;
|
2020-04-23 22:13:47 +03:00
|
|
|
Function<void(Widget&)> on_change;
|
2020-05-07 06:03:03 +03:00
|
|
|
Function<void(Widget&)> on_middle_click;
|
2021-06-19 13:10:43 +03:00
|
|
|
Function<void(Widget&)> on_tab_close_click;
|
2022-04-01 20:58:27 +03:00
|
|
|
Function<void(Widget&, ContextMenuEvent const&)> on_context_menu_request;
|
2021-11-30 19:42:13 +03:00
|
|
|
Function<void(Widget&)> on_double_click;
|
2020-04-06 01:02:24 +03:00
|
|
|
|
2019-05-05 02:31:02 +03:00
|
|
|
protected:
|
2020-02-23 14:07:13 +03:00
|
|
|
TabWidget();
|
|
|
|
|
2020-02-02 17:07:41 +03:00
|
|
|
virtual void paint_event(PaintEvent&) override;
|
2020-02-02 14:34:39 +03:00
|
|
|
virtual void child_event(Core::ChildEvent&) override;
|
2020-02-02 17:07:41 +03:00
|
|
|
virtual void resize_event(ResizeEvent&) override;
|
|
|
|
virtual void mousedown_event(MouseEvent&) override;
|
2021-06-19 13:10:43 +03:00
|
|
|
virtual void mouseup_event(MouseEvent&) override;
|
2020-02-02 17:07:41 +03:00
|
|
|
virtual void mousemove_event(MouseEvent&) override;
|
2020-02-02 14:34:39 +03:00
|
|
|
virtual void leave_event(Core::Event&) override;
|
2020-04-30 10:04:03 +03:00
|
|
|
virtual void keydown_event(KeyEvent&) override;
|
2020-05-19 01:36:02 +03:00
|
|
|
virtual void context_menu_event(ContextMenuEvent&) override;
|
2021-11-30 19:42:13 +03:00
|
|
|
virtual void doubleclick_event(MouseEvent&) override;
|
2019-05-05 02:31:02 +03:00
|
|
|
|
|
|
|
private:
|
2022-12-07 00:35:32 +03:00
|
|
|
Gfx::IntRect child_rect_for_size(Gfx::IntSize) const;
|
2021-07-28 03:11:41 +03:00
|
|
|
Gfx::IntRect button_rect(size_t index) const;
|
2022-05-17 13:47:35 +03:00
|
|
|
Gfx::IntRect vertical_button_rect(size_t index) const;
|
|
|
|
Gfx::IntRect horizontal_button_rect(size_t index) const;
|
2021-07-28 03:11:41 +03:00
|
|
|
Gfx::IntRect close_button_rect(size_t index) const;
|
2020-06-10 11:57:59 +03:00
|
|
|
Gfx::IntRect bar_rect() const;
|
|
|
|
Gfx::IntRect container_rect() const;
|
2019-05-07 15:01:20 +03:00
|
|
|
void update_bar();
|
2020-10-30 18:30:33 +03:00
|
|
|
void update_focus_policy();
|
2021-04-09 23:30:41 +03:00
|
|
|
int bar_margin() const { return 2; }
|
2019-05-05 02:31:02 +03:00
|
|
|
|
2020-02-02 17:07:41 +03:00
|
|
|
RefPtr<Widget> m_active_widget;
|
2019-05-05 02:31:02 +03:00
|
|
|
|
|
|
|
struct TabData {
|
2022-04-01 20:58:27 +03:00
|
|
|
int width(Gfx::Font const&) const;
|
2023-03-10 22:34:00 +03:00
|
|
|
String title;
|
2024-03-28 19:17:07 +03:00
|
|
|
RefPtr<Gfx::Bitmap const> action_icon;
|
2023-02-20 21:03:44 +03:00
|
|
|
RefPtr<Gfx::Bitmap const> icon;
|
2020-02-02 17:07:41 +03:00
|
|
|
Widget* widget { nullptr };
|
2022-11-04 11:48:47 +03:00
|
|
|
bool modified { false };
|
2019-05-05 02:31:02 +03:00
|
|
|
};
|
|
|
|
Vector<TabData> m_tabs;
|
2019-07-28 18:39:04 +03:00
|
|
|
TabPosition m_tab_position { TabPosition::Top };
|
2021-07-28 03:11:41 +03:00
|
|
|
Optional<size_t> m_hovered_tab_index;
|
|
|
|
Optional<size_t> m_hovered_close_button_index;
|
|
|
|
Optional<size_t> m_pressed_close_button_index;
|
2021-06-15 15:28:39 +03:00
|
|
|
GUI::Margins m_container_margins { 2, 2, 2, 2 };
|
2020-04-24 23:27:46 +03:00
|
|
|
Gfx::TextAlignment m_text_alignment { Gfx::TextAlignment::Center };
|
2020-04-24 23:36:25 +03:00
|
|
|
bool m_uniform_tabs { false };
|
2020-05-19 00:44:08 +03:00
|
|
|
bool m_bar_visible { true };
|
2021-06-19 13:10:43 +03:00
|
|
|
bool m_close_button_enabled { false };
|
2021-10-07 10:52:04 +03:00
|
|
|
|
2022-05-17 13:47:35 +03:00
|
|
|
int m_max_tab_width { 160 };
|
|
|
|
int m_min_tab_width { 24 };
|
|
|
|
|
2021-10-07 10:52:04 +03:00
|
|
|
bool m_reorder_allowed { false };
|
|
|
|
bool m_dragging_active_tab { false };
|
|
|
|
int m_grab_offset { 0 };
|
2022-05-17 13:47:35 +03:00
|
|
|
int m_mouse_pos { 0 };
|
2021-10-07 10:52:04 +03:00
|
|
|
|
|
|
|
void drag_tab(size_t index);
|
|
|
|
void recalculate_tab_order();
|
2019-05-05 02:31:02 +03:00
|
|
|
};
|
2020-02-02 17:07:41 +03:00
|
|
|
|
|
|
|
}
|