ladybird/UI/Qt/Menu.cpp
Andreas Kling 117cef4e92 UI/Qt: Accept all standard back/forward shortcuts
Use Qt's platform shortcut bindings for back and forward navigation
instead of only installing the primary binding. On macOS this keeps
Command-[ and Command-] while also accepting Command-Left and
Command-Right.
2026-06-22 01:13:53 +02:00

311 lines
11 KiB
C++

/*
* Copyright (c) 2025-2026, Tim Flynn <trflynn89@ladybird.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <UI/Qt/Icon.h>
#include <UI/Qt/Menu.h>
#include <UI/Qt/StringUtils.h>
#include <UI/Qt/WebContentView.h>
#include <QAction>
#include <QMenu>
#include <QPointer>
#include <QToolButton>
#include <QWidget>
namespace Ladybird {
class ActionObserver final : public WebView::Action::Observer {
public:
static NonnullOwnPtr<ActionObserver> create(WebView::Action& action, QAction& qaction, IncludeActionIcon include_action_icon)
{
return adopt_own(*new ActionObserver(action, qaction, include_action_icon));
}
virtual void on_text_changed(WebView::Action& action) override
{
if (m_action)
m_action->setText(qstring_from_ak_string(action.text()));
}
virtual void on_tooltip_changed(WebView::Action& action) override
{
if (m_action)
m_action->setToolTip(qstring_from_ak_string(action.tooltip()));
}
virtual void on_enabled_state_changed(WebView::Action& action) override
{
if (m_action)
m_action->setEnabled(action.enabled());
}
virtual void on_visible_state_changed(WebView::Action& action) override
{
if (m_action) {
m_action->setVisible(action.visible());
for (auto* object : m_action->associatedObjects()) {
if (auto* tool_button = as_if<QToolButton>(object))
tool_button->setVisible(action.visible());
}
}
}
virtual void on_engaged_state_changed(WebView::Action& action) override
{
if (m_include_action_icon == IncludeActionIcon::No)
return;
if (!m_action)
return;
switch (action.id()) {
case WebView::ActionID::ToggleVerticalTabsExpanded:
if (auto* parent = as_if<QWidget>(m_action->parent())) {
auto icon = action.engaged() ? ChromeIcon::VerticalTabBarCollapse : ChromeIcon::VerticalTabBarExpand;
m_action->setIcon(create_chrome_icon(icon, parent->palette()));
}
break;
case WebView::ActionID::ToggleBookmark:
case WebView::ActionID::ToggleBookmarkViaToolbar:
if (auto* parent = as_if<QWidget>(m_action->parent())) {
auto icon = action.engaged() ? ChromeIcon::StarFilled : ChromeIcon::Star;
m_action->setIcon(create_chrome_icon(icon, parent->palette()));
}
break;
default:
break;
}
}
virtual void on_checked_state_changed(WebView::Action& action) override
{
if (m_action)
m_action->setChecked(action.checked());
}
private:
ActionObserver(WebView::Action& action, QAction& qaction, IncludeActionIcon include_action_icon)
: m_action(&qaction)
, m_include_action_icon(include_action_icon)
{
QObject::connect(m_action, &QAction::triggered, [weak_action = action.make_weak_ptr()](bool checked) {
if (auto action = weak_action.strong_ref()) {
if (action->is_checkable())
action->set_checked(checked);
action->activate();
}
});
QObject::connect(m_action->parent(), &QObject::destroyed, [this, weak_action = action.make_weak_ptr()]() {
if (auto action = weak_action.strong_ref())
action->remove_observer(*this);
});
}
QPointer<QAction> m_action;
IncludeActionIcon m_include_action_icon { IncludeActionIcon::Yes };
};
class MenuObserver final : public WebView::Menu::Observer {
public:
static NonnullOwnPtr<MenuObserver> create(QMenu& qmenu)
{
return adopt_own(*new MenuObserver(qmenu));
}
virtual void on_visible_state_changed(WebView::Menu& menu) override
{
if (m_menu && m_menu->menuAction())
m_menu->menuAction()->setVisible(menu.visible());
}
private:
explicit MenuObserver(QMenu& qmenu)
: m_menu(&qmenu)
{
}
QPointer<QMenu> m_menu;
};
template<typename T>
static void add_properties(QObject& object, T& menu_or_action)
{
for (auto const& [key, value] : menu_or_action.properties())
object.setProperty(key.to_byte_string().characters(), qstring_from_ak_string(value));
}
static void initialize_native_control(WebView::Action& action, QAction& qaction, QPalette const& palette, IncludeActionIcon include_action_icon)
{
static constexpr int const MENU_ICON_SIZE = 16;
switch (action.id()) {
case WebView::ActionID::NavigateBack:
if (include_action_icon == IncludeActionIcon::Yes)
qaction.setIcon(create_chrome_icon(ChromeIcon::Back, palette));
qaction.setShortcuts(QKeySequence::keyBindings(QKeySequence::StandardKey::Back));
break;
case WebView::ActionID::NavigateForward:
if (include_action_icon == IncludeActionIcon::Yes)
qaction.setIcon(create_chrome_icon(ChromeIcon::Forward, palette));
qaction.setShortcuts(QKeySequence::keyBindings(QKeySequence::StandardKey::Forward));
break;
case WebView::ActionID::Reload:
if (include_action_icon == IncludeActionIcon::Yes)
qaction.setIcon(create_chrome_icon(ChromeIcon::Reload, palette));
qaction.setShortcuts({ QKeySequence(Qt::CTRL | Qt::Key_R), QKeySequence(Qt::Key_F5) });
break;
case WebView::ActionID::CopySelection:
qaction.setShortcut(QKeySequence::StandardKey::Copy);
break;
case WebView::ActionID::CutSelection:
qaction.setShortcut(QKeySequence::StandardKey::Cut);
break;
case WebView::ActionID::Paste:
qaction.setShortcut(QKeySequence::StandardKey::Paste);
break;
case WebView::ActionID::SelectAll:
qaction.setShortcut(QKeySequence::StandardKey::SelectAll);
break;
case WebView::ActionID::ToggleBookmark:
if (include_action_icon == IncludeActionIcon::Yes)
qaction.setIcon(create_chrome_icon(action.engaged() ? ChromeIcon::StarFilled : ChromeIcon::Star, palette));
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::Key_D));
break;
case WebView::ActionID::ToggleBookmarkViaToolbar:
if (include_action_icon == IncludeActionIcon::Yes)
qaction.setIcon(create_chrome_icon(action.engaged() ? ChromeIcon::StarFilled : ChromeIcon::Star, palette));
break;
case WebView::ActionID::ToggleBookmarksBar:
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_B));
break;
case WebView::ActionID::BookmarkItem:
if (auto icon = action.base64_png_icon(); icon.has_value())
qaction.setIcon(icon_from_base64_png(*icon, MENU_ICON_SIZE));
else
qaction.setIcon(create_chrome_icon(ChromeIcon::Globe, palette));
break;
case WebView::ActionID::ViewHistory:
#if defined(AK_OS_MACOS)
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::Key_Y));
#else
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::Key_H));
#endif
break;
case WebView::ActionID::OpenProcessesPage:
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_M));
break;
case WebView::ActionID::OpenSettingsPage:
#if defined(AK_OS_MACOS)
qaction.setShortcut(QKeySequence::StandardKey::Preferences);
#else
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::Key_Comma));
#endif
break;
case WebView::ActionID::ToggleDevTools:
qaction.setShortcuts({
QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_I),
QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_C),
QKeySequence(Qt::Key_F12),
});
break;
case WebView::ActionID::ViewSource:
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::Key_U));
break;
case WebView::ActionID::ZoomIn: {
auto zoom_in_shortcuts = QKeySequence::keyBindings(QKeySequence::StandardKey::ZoomIn);
auto secondary_zoom_in_shortcut = QKeySequence(Qt::CTRL | Qt::Key_Equal);
if (!zoom_in_shortcuts.contains(secondary_zoom_in_shortcut))
zoom_in_shortcuts.append(move(secondary_zoom_in_shortcut));
qaction.setShortcuts(zoom_in_shortcuts);
break;
}
case WebView::ActionID::ZoomOut:
qaction.setShortcut(QKeySequence::StandardKey::ZoomOut);
break;
case WebView::ActionID::ResetZoom:
qaction.setShortcut(QKeySequence(Qt::CTRL | Qt::Key_0));
break;
default:
break;
}
if (action.is_checkable())
qaction.setCheckable(true);
action.add_observer(ActionObserver::create(action, qaction, include_action_icon));
add_properties(qaction, action);
}
static void add_items_to_menu(QMenu& qmenu, QWidget& parent, WebView::Menu& menu)
{
menu.add_observer(MenuObserver::create(qmenu));
add_properties(qmenu, menu);
for (auto& menu_item : menu.items()) {
menu_item.visit(
[&](NonnullRefPtr<WebView::Action>& action) {
auto* qaction = create_application_action(parent, action, IncludeActionIcon::No);
qmenu.addAction(qaction);
},
[&](NonnullRefPtr<WebView::Menu> const& submenu) {
auto* qsubmenu = new QMenu(qstring_from_ak_string(submenu->title()), &qmenu);
add_items_to_menu(*qsubmenu, parent, submenu);
if (submenu->render_group_icon())
qsubmenu->setIcon(create_chrome_icon(ChromeIcon::Folder, parent.palette()));
add_properties(*qsubmenu, *submenu);
qmenu.addMenu(qsubmenu);
},
[&](WebView::Separator) {
qmenu.addSeparator();
});
}
}
QMenu* create_application_menu(QWidget& parent, WebView::Menu& menu)
{
auto* application_menu = new QMenu(qstring_from_ak_string(menu.title()), &parent);
add_items_to_menu(*application_menu, parent, menu);
return application_menu;
}
void repopulate_application_menu(QMenu& menu, QWidget& parent, WebView::Menu& source)
{
menu.clear();
add_items_to_menu(menu, parent, source);
}
QMenu* create_context_menu(QWidget& parent, WebContentView& view, WebView::Menu& menu)
{
auto* application_menu = create_application_menu(parent, menu);
menu.on_activation = [view = QPointer { &view }, application_menu = QPointer { application_menu }](Gfx::IntPoint position) {
if (view && application_menu)
application_menu->exec(view->map_point_to_global_position(position));
};
return application_menu;
}
QAction* create_application_action(QWidget& parent, WebView::Action& action, IncludeActionIcon include_action_icon)
{
auto* qaction = new QAction(&parent);
initialize_native_control(action, *qaction, parent.palette(), include_action_icon);
return qaction;
}
}