/* * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org> * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include <AK/Badge.h> #include <AK/Function.h> #include <AK/HashTable.h> #include <AK/NonnullRefPtr.h> #include <AK/RefCounted.h> #include <AK/String.h> #include <AK/WeakPtr.h> #include <AK/Weakable.h> #include <LibCore/Object.h> #include <LibGUI/Forward.h> #include <LibGUI/Shortcut.h> #include <LibGfx/Forward.h> namespace GUI { namespace CommonActions { NonnullRefPtr<Action> make_about_action(const String& app_name, const Icon& app_icon, Window* parent = nullptr); NonnullRefPtr<Action> make_open_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_save_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_save_as_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_undo_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_redo_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_cut_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_copy_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_paste_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_delete_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_move_to_front_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_move_to_back_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_fullscreen_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_quit_action(Function<void(Action&)>); NonnullRefPtr<Action> make_help_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_go_back_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_go_forward_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_go_home_action(Function<void(Action&)> callback, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_close_tab_action(Function<void(Action&)> callback, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_reload_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_select_all_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_rename_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_properties_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_zoom_in_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_zoom_out_action(Function<void(Action&)>, Core::Object* parent = nullptr); NonnullRefPtr<Action> make_reset_zoom_action(Function<void(Action&)>, Core::Object* parent = nullptr); }; class Action final : public Core::Object { C_OBJECT(Action) public: enum class ShortcutScope { None, WidgetLocal, WindowLocal, ApplicationGlobal, }; static NonnullRefPtr<Action> create(String text, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create(String text, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create(String text, const Shortcut& shortcut, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create(String text, const Shortcut& shortcut, const Shortcut& alternate_shortcut, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create(String text, const Shortcut& shortcut, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create(String text, const Shortcut& shortcut, const Shortcut& alternate_shortcut, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create_checkable(String text, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create_checkable(String text, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create_checkable(String text, const Shortcut& shortcut, Function<void(Action&)> callback, Core::Object* parent = nullptr); static NonnullRefPtr<Action> create_checkable(String text, const Shortcut& shortcut, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent = nullptr); virtual ~Action() override; String text() const { return m_text; } void set_text(String); String const& status_tip() const { return m_status_tip; } void set_status_tip(String status_tip) { m_status_tip = move(status_tip); } Shortcut const& shortcut() const { return m_shortcut; } Shortcut const& alternate_shortcut() const { return m_alternate_shortcut; } const Gfx::Bitmap* icon() const { return m_icon.ptr(); } void set_icon(const Gfx::Bitmap*); const Core::Object* activator() const { return m_activator.ptr(); } Core::Object* activator() { return m_activator.ptr(); } Function<void(Action&)> on_activation; void activate(Core::Object* activator = nullptr); bool is_enabled() const { return m_enabled; } void set_enabled(bool); bool is_checkable() const { return m_checkable; } void set_checkable(bool checkable) { m_checkable = checkable; } bool is_checked() const { VERIFY(is_checkable()); return m_checked; } void set_checked(bool); bool swallow_key_event_when_disabled() const { return m_swallow_key_event_when_disabled; } void set_swallow_key_event_when_disabled(bool swallow) { m_swallow_key_event_when_disabled = swallow; } void register_button(Badge<Button>, Button&); void unregister_button(Badge<Button>, Button&); void register_menu_item(Badge<MenuItem>, MenuItem&); void unregister_menu_item(Badge<MenuItem>, MenuItem&); const ActionGroup* group() const { return m_action_group.ptr(); } void set_group(Badge<ActionGroup>, ActionGroup*); private: Action(String, Function<void(Action&)> = nullptr, Core::Object* = nullptr, bool checkable = false); Action(String, const Shortcut&, Function<void(Action&)> = nullptr, Core::Object* = nullptr, bool checkable = false); Action(String, const Shortcut&, const Shortcut&, Function<void(Action&)> = nullptr, Core::Object* = nullptr, bool checkable = false); Action(String, const Shortcut&, const Shortcut&, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> = nullptr, Core::Object* = nullptr, bool checkable = false); Action(String, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> = nullptr, Core::Object* = nullptr, bool checkable = false); template<typename Callback> void for_each_toolbar_button(Callback); template<typename Callback> void for_each_menu_item(Callback); String m_text; String m_status_tip; RefPtr<Gfx::Bitmap> m_icon; Shortcut m_shortcut; Shortcut m_alternate_shortcut; bool m_enabled { true }; bool m_checkable { false }; bool m_checked { false }; bool m_swallow_key_event_when_disabled { false }; ShortcutScope m_scope { ShortcutScope::None }; HashTable<Button*> m_buttons; HashTable<MenuItem*> m_menu_items; WeakPtr<ActionGroup> m_action_group; WeakPtr<Core::Object> m_activator; }; }