1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 15:17:36 +00:00

LibGUI: Allow GActions to be scoped either globally or widget-locally.

This makes it possible for e.g GTextEditor to create a bunch of actions
with popular shortcuts like Ctrl+C, etc, without polluting the global
shortcut namespace. Widget-local actions will only activate while their
corresponding widget has focus. :^)
This commit is contained in:
Andreas Kling 2019-04-20 21:56:56 +02:00
parent a56e1afb64
commit 5c5ce4f885
8 changed files with 102 additions and 41 deletions

View file

@ -5,6 +5,7 @@
#include <AK/Retainable.h>
#include <AK/Retained.h>
#include <AK/Weakable.h>
#include <AK/WeakPtr.h>
#include <AK/Badge.h>
#include <AK/HashTable.h>
#include <SharedGraphics/GraphicsBitmap.h>
@ -12,31 +13,40 @@
class GButton;
class GMenuItem;
class GWidget;
class GAction : public Retainable<GAction>, public Weakable<GAction> {
public:
static Retained<GAction> create(const String& text, Function<void(const GAction&)> callback)
enum class ShortcutScope {
None,
ApplicationGlobal,
WidgetLocal,
};
static Retained<GAction> create(const String& text, Function<void(const GAction&)> callback, GWidget* widget = nullptr)
{
return adopt(*new GAction(text, move(callback)));
return adopt(*new GAction(text, move(callback), widget));
}
static Retained<GAction> create(const String& text, const String& custom_data, Function<void(const GAction&)> callback)
static Retained<GAction> create(const String& text, const String& custom_data, Function<void(const GAction&)> callback, GWidget* widget = nullptr)
{
return adopt(*new GAction(text, custom_data, move(callback)));
return adopt(*new GAction(text, custom_data, move(callback), widget));
}
static Retained<GAction> create(const String& text, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> callback)
static Retained<GAction> create(const String& text, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> callback, GWidget* widget = nullptr)
{
return adopt(*new GAction(text, move(icon), move(callback)));
return adopt(*new GAction(text, move(icon), move(callback), widget));
}
static Retained<GAction> create(const String& text, const GShortcut& shortcut, Function<void(const GAction&)> callback)
static Retained<GAction> create(const String& text, const GShortcut& shortcut, Function<void(const GAction&)> callback, GWidget* widget = nullptr)
{
return adopt(*new GAction(text, shortcut, move(callback)));
return adopt(*new GAction(text, shortcut, move(callback), widget));
}
static Retained<GAction> create(const String& text, const GShortcut& shortcut, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> callback)
static Retained<GAction> create(const String& text, const GShortcut& shortcut, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> callback, GWidget* widget = nullptr)
{
return adopt(*new GAction(text, shortcut, move(icon), move(callback)));
return adopt(*new GAction(text, shortcut, move(icon), move(callback), widget));
}
~GAction();
GWidget* widget() { return m_widget.ptr(); }
const GWidget* widget() const { return m_widget.ptr(); }
String text() const { return m_text; }
GShortcut shortcut() const { return m_shortcut; }
String custom_data() const { return m_custom_data; }
@ -55,11 +65,11 @@ public:
void unregister_menu_item(Badge<GMenuItem>, GMenuItem&);
private:
GAction(const String& text, Function<void(const GAction&)> = nullptr);
GAction(const String& text, const GShortcut&, Function<void(const GAction&)> = nullptr);
GAction(const String& text, const GShortcut&, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> = nullptr);
GAction(const String& text, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> = nullptr);
GAction(const String& text, const String& custom_data = String(), Function<void(const GAction&)> = nullptr);
GAction(const String& text, Function<void(const GAction&)> = nullptr, GWidget* = nullptr);
GAction(const String& text, const GShortcut&, Function<void(const GAction&)> = nullptr, GWidget* = nullptr);
GAction(const String& text, const GShortcut&, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> = nullptr, GWidget* = nullptr);
GAction(const String& text, RetainPtr<GraphicsBitmap>&& icon, Function<void(const GAction&)> = nullptr, GWidget* = nullptr);
GAction(const String& text, const String& custom_data = String(), Function<void(const GAction&)> = nullptr, GWidget* = nullptr);
template<typename Callback> void for_each_toolbar_button(Callback);
template<typename Callback> void for_each_menu_item(Callback);
@ -69,8 +79,9 @@ private:
RetainPtr<GraphicsBitmap> m_icon;
GShortcut m_shortcut;
bool m_enabled { true };
ShortcutScope m_scope { ShortcutScope::None };
HashTable<GButton*> m_buttons;
HashTable<GMenuItem*> m_menu_items;
WeakPtr<GWidget> m_widget;
};