serenity/Userland/Libraries/LibGUI/TabWidget.h

/*
 * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
 * Copyright (c) 2022, the SerenityOS developers.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <LibGUI/Margins.h>
#include <LibGUI/Widget.h>

namespace GUI {

class TabWidget : public Widget {
    C_OBJECT(TabWidget)
public:
    enum TabPosition {
        Top,
        Bottom,
        Left,
        Right,
    };

    virtual ~TabWidget() override = default;

    TabPosition tab_position() const { return m_tab_position; }
    void set_tab_position(TabPosition);
    bool has_vertical_tabs() const { return m_tab_position == TabPosition::Left || m_tab_position == TabPosition::Right; }

    Optional<size_t> active_tab_index() const;
    size_t tab_count() { return m_tabs.size(); }

    Widget* active_widget() { return m_active_widget.ptr(); }
    Widget const* active_widget() const { return m_active_widget.ptr(); }
    void set_active_widget(Widget*);
    void set_tab_index(int);

    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; }

    GUI::Margins const& container_margins() const { return m_container_margins; }
    void set_container_margins(GUI::Margins const&);

    Optional<UISize> calculated_min_size() const override;
    Optional<UISize> calculated_preferred_size() const override;

    ErrorOr<void> try_add_widget(Widget&);

    void add_widget(Widget&);
    void remove_widget(Widget&);

    template<class T, class... Args>
    ErrorOr<NonnullRefPtr<T>> try_add_tab(String title, Args&&... args)
    {
        auto t = TRY(T::try_create(forward<Args>(args)...));
        t->set_title(move(title));
        TRY(try_add_widget(*t));
        return *t;
    }

    template<class T, class... Args>
    T& add_tab(String title, Args&&... args)
    {
        auto t = T::construct(forward<Args>(args)...);
        t->set_title(move(title));
        add_widget(*t);
        return *t;
    }

    ErrorOr<void> add_tab(NonnullRefPtr<Widget> const& tab, String title)
    {
        tab->set_title(move(title));
        TRY(try_add_widget(*tab));
        return {};
    }

    void remove_tab(Widget& tab) { remove_widget(tab); }
    void remove_all_tabs_except(Widget& tab);

    void set_tab_title(Widget& tab, String title);
    void set_tab_icon(Widget& tab, Gfx::Bitmap const*);

    bool is_tab_modified(Widget& tab);
    void set_tab_modified(Widget& tab, bool modified);
    bool is_any_tab_modified();

    void activate_next_tab();
    void activate_previous_tab();
    void activate_last_tab();

    void set_text_alignment(Gfx::TextAlignment alignment) { m_text_alignment = alignment; }
    Gfx::TextAlignment text_alignment() const { return m_text_alignment; }

    bool uniform_tabs() const { return m_uniform_tabs; }
    void set_uniform_tabs(bool uniform_tabs) { m_uniform_tabs = uniform_tabs; }
    int uniform_tab_width() const;

    void set_bar_visible(bool bar_visible);
    bool is_bar_visible() const { return m_bar_visible; };

    void set_close_button_enabled(bool close_button_enabled) { m_close_button_enabled = close_button_enabled; };
    bool close_button_enabled() const { return m_close_button_enabled; }

    void set_reorder_allowed(bool reorder_allowed) { m_reorder_allowed = reorder_allowed; }
    bool reorder_allowed() const { return m_reorder_allowed; }

    Function<void(size_t)> on_tab_count_change;
    Function<void(Widget&)> on_change;
    Function<void(Widget&)> on_middle_click;
    Function<void(Widget&)> on_tab_close_click;
    Function<void(Widget&, ContextMenuEvent const&)> on_context_menu_request;
    Function<void(Widget&)> on_double_click;

protected:
    TabWidget();

    virtual void paint_event(PaintEvent&) override;
    virtual void child_event(Core::ChildEvent&) override;
    virtual void resize_event(ResizeEvent&) override;
    virtual void mousedown_event(MouseEvent&) override;
    virtual void mouseup_event(MouseEvent&) override;
    virtual void mousemove_event(MouseEvent&) override;
    virtual void leave_event(Core::Event&) override;
    virtual void keydown_event(KeyEvent&) override;
    virtual void context_menu_event(ContextMenuEvent&) override;
    virtual void doubleclick_event(MouseEvent&) override;

private:
    Gfx::IntRect child_rect_for_size(Gfx::IntSize) const;
    Gfx::IntRect button_rect(size_t index) const;
    Gfx::IntRect vertical_button_rect(size_t index) const;
    Gfx::IntRect horizontal_button_rect(size_t index) const;
    Gfx::IntRect close_button_rect(size_t index) const;
    Gfx::IntRect bar_rect() const;
    Gfx::IntRect container_rect() const;
    void update_bar();
    void update_focus_policy();
    int bar_margin() const { return 2; }

    RefPtr<Widget> m_active_widget;

    struct TabData {
        int width(Gfx::Font const&) const;
        String title;
        RefPtr<Gfx::Bitmap const> icon;
        Widget* widget { nullptr };
        bool modified { false };
    };
    Vector<TabData> m_tabs;
    TabPosition m_tab_position { TabPosition::Top };
    Optional<size_t> m_hovered_tab_index;
    Optional<size_t> m_hovered_close_button_index;
    Optional<size_t> m_pressed_close_button_index;
    GUI::Margins m_container_margins { 2, 2, 2, 2 };
    Gfx::TextAlignment m_text_alignment { Gfx::TextAlignment::Center };
    bool m_uniform_tabs { false };
    bool m_bar_visible { true };
    bool m_close_button_enabled { false };

    int m_max_tab_width { 160 };
    int m_min_tab_width { 24 };

    bool m_reorder_allowed { false };
    bool m_dragging_active_tab { false };
    int m_grab_offset { 0 };
    int m_mouse_pos { 0 };

    void drag_tab(size_t index);
    void recalculate_tab_order();
};

}