jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
3 * Copyright (c) 2022, the SerenityOS developers.
4 *
5 * SPDX-License-Identifier: BSD-2-Clause
6 */
7
8#pragma once
9
10#include <LibGUI/Margins.h>
11#include <LibGUI/Widget.h>
12
13namespace GUI {
14
15class TabWidget : public Widget {
16 C_OBJECT(TabWidget)
17public:
18 enum TabPosition {
19 Top,
20 Bottom,
21 Left,
22 Right,
23 };
24
25 virtual ~TabWidget() override = default;
26
27 TabPosition tab_position() const { return m_tab_position; }
28 void set_tab_position(TabPosition);
29 bool has_vertical_tabs() const { return m_tab_position == TabPosition::Left || m_tab_position == TabPosition::Right; }
30
31 Optional<size_t> active_tab_index() const;
32 size_t tab_count() { return m_tabs.size(); }
33
34 Widget* active_widget() { return m_active_widget.ptr(); }
35 Widget const* active_widget() const { return m_active_widget.ptr(); }
36 void set_active_widget(Widget*);
37 void set_tab_index(int);
38
39 int bar_height() const { return m_bar_visible ? 22 : 0; }
40
41 int get_max_tab_width() const { return m_bar_visible ? m_max_tab_width : 0; }
42 void set_max_tab_width(int width) { m_max_tab_width = width; }
43
44 int get_min_tab_width() const { return m_min_tab_width; }
45 void set_min_tab_width(int width) { m_min_tab_width = width; }
46
47 GUI::Margins const& container_margins() const { return m_container_margins; }
48 void set_container_margins(GUI::Margins const&);
49
50 Optional<UISize> calculated_min_size() const override;
51 Optional<UISize> calculated_preferred_size() const override;
52
53 ErrorOr<void> try_add_widget(Widget&);
54
55 void add_widget(Widget&);
56 void remove_widget(Widget&);
57
58 template<class T, class... Args>
59 ErrorOr<NonnullRefPtr<T>> try_add_tab(DeprecatedString title, Args&&... args)
60 {
61 auto t = TRY(T::try_create(forward<Args>(args)...));
62 t->set_title(move(title));
63 TRY(try_add_widget(*t));
64 return *t;
65 }
66
67 template<class T, class... Args>
68 T& add_tab(DeprecatedString title, Args&&... args)
69 {
70 auto t = T::construct(forward<Args>(args)...);
71 t->set_title(move(title));
72 add_widget(*t);
73 return *t;
74 }
75
76 ErrorOr<void> add_tab(NonnullRefPtr<Widget> const& tab, DeprecatedString title)
77 {
78 tab->set_title(move(title));
79 TRY(try_add_widget(*tab));
80 return {};
81 }
82
83 void remove_tab(Widget& tab) { remove_widget(tab); }
84 void remove_all_tabs_except(Widget& tab);
85
86 void set_tab_title(Widget& tab, StringView title);
87 void set_tab_icon(Widget& tab, Gfx::Bitmap const*);
88
89 bool is_tab_modified(Widget& tab);
90 void set_tab_modified(Widget& tab, bool modified);
91 bool is_any_tab_modified();
92
93 void activate_next_tab();
94 void activate_previous_tab();
95 void activate_last_tab();
96
97 void set_text_alignment(Gfx::TextAlignment alignment) { m_text_alignment = alignment; }
98 Gfx::TextAlignment text_alignment() const { return m_text_alignment; }
99
100 bool uniform_tabs() const { return m_uniform_tabs; }
101 void set_uniform_tabs(bool uniform_tabs) { m_uniform_tabs = uniform_tabs; }
102 int uniform_tab_width() const;
103
104 void set_bar_visible(bool bar_visible);
105 bool is_bar_visible() const { return m_bar_visible; };
106
107 void set_close_button_enabled(bool close_button_enabled) { m_close_button_enabled = close_button_enabled; };
108 bool close_button_enabled() const { return m_close_button_enabled; }
109
110 void set_reorder_allowed(bool reorder_allowed) { m_reorder_allowed = reorder_allowed; }
111 bool reorder_allowed() const { return m_reorder_allowed; }
112
113 Function<void(size_t)> on_tab_count_change;
114 Function<void(Widget&)> on_change;
115 Function<void(Widget&)> on_middle_click;
116 Function<void(Widget&)> on_tab_close_click;
117 Function<void(Widget&, ContextMenuEvent const&)> on_context_menu_request;
118 Function<void(Widget&)> on_double_click;
119
120protected:
121 TabWidget();
122
123 virtual void paint_event(PaintEvent&) override;
124 virtual void child_event(Core::ChildEvent&) override;
125 virtual void resize_event(ResizeEvent&) override;
126 virtual void mousedown_event(MouseEvent&) override;
127 virtual void mouseup_event(MouseEvent&) override;
128 virtual void mousemove_event(MouseEvent&) override;
129 virtual void leave_event(Core::Event&) override;
130 virtual void keydown_event(KeyEvent&) override;
131 virtual void context_menu_event(ContextMenuEvent&) override;
132 virtual void doubleclick_event(MouseEvent&) override;
133
134private:
135 Gfx::IntRect child_rect_for_size(Gfx::IntSize) const;
136 Gfx::IntRect button_rect(size_t index) const;
137 Gfx::IntRect vertical_button_rect(size_t index) const;
138 Gfx::IntRect horizontal_button_rect(size_t index) const;
139 Gfx::IntRect close_button_rect(size_t index) const;
140 Gfx::IntRect bar_rect() const;
141 Gfx::IntRect container_rect() const;
142 void update_bar();
143 void update_focus_policy();
144 int bar_margin() const { return 2; }
145
146 RefPtr<Widget> m_active_widget;
147
148 struct TabData {
149 int width(Gfx::Font const&) const;
150 DeprecatedString title;
151 RefPtr<Gfx::Bitmap const> icon;
152 Widget* widget { nullptr };
153 bool modified { false };
154 };
155 Vector<TabData> m_tabs;
156 TabPosition m_tab_position { TabPosition::Top };
157 Optional<size_t> m_hovered_tab_index;
158 Optional<size_t> m_hovered_close_button_index;
159 Optional<size_t> m_pressed_close_button_index;
160 GUI::Margins m_container_margins { 2, 2, 2, 2 };
161 Gfx::TextAlignment m_text_alignment { Gfx::TextAlignment::Center };
162 bool m_uniform_tabs { false };
163 bool m_bar_visible { true };
164 bool m_close_button_enabled { false };
165
166 int m_max_tab_width { 160 };
167 int m_min_tab_width { 24 };
168
169 bool m_reorder_allowed { false };
170 bool m_dragging_active_tab { false };
171 int m_grab_offset { 0 };
172 int m_mouse_pos { 0 };
173
174 void drag_tab(size_t index);
175 void recalculate_tab_order();
176};
177
178}