cef/libcef/browser/views/window_impl.h
Marshall Greenblatt dca0435d2f chrome: Add support for Alloy style browsers and windows (see #3681)
Split the Alloy runtime into bootstrap and style components. Support
creation of Alloy style browsers and windows with the Chrome runtime.
Chrome runtime (`--enable-chrome-runtime`) + Alloy style
(`--use-alloy-style`) supports Views (`--use-views`), native parent
(`--use-native`) and windowless rendering
(`--off-screen-rendering-enabled`).

Print preview is supported in all cases except with windowless rendering
on all platforms and native parent on MacOS. It is disabled by default
with Alloy style for legacy compatibility. Where supported it can be
enabled or disabled globally using `--[enable|disable]-print-preview` or
configured on a per-RequestContext basis using the
`printing.print_preview_disabled` preference. It also behaves as
expected when triggered via the PDF viewer print button.

Chrome runtime + Alloy style behavior differs from Alloy runtime in the
following significant ways:

- Supports Chrome error pages by default.
- DevTools popups are Chrome style only (cannot be windowless).
- The Alloy extension API will not supported.

Chrome runtime + Alloy style passes all expected Alloy ceftests except
the following:

- `DisplayTest.AutoResize` (Alloy extension API not supported)
- `DownloadTest.*` (Download API not yet supported)
- `ExtensionTest.*` (Alloy extension API not supported)

This change also adds Chrome runtime support for
CefContextMenuHandler::RunContextMenu (see #3293).

This change also explicitly blocks (and doesn't retry) FrameAttached
requests from PDF viewer and print preview excluded frames (see #3664).

Known issues specific to Chrome runtime + Alloy style:
- DevTools popup with windowless rendering doesn't load successfully.
  Use windowed rendering or remote debugging as a workaround.
- Chrome style Window with Alloy style BrowserView (`--use-alloy-style
  --use-chrome-style-window`) does not show Chrome theme changes.

To test:
- Run `ceftests --enable-chrome-runtime --use-alloy-style
       [--use-chrome-style-window] [--use-views|--use-native]
       --gtest_filter=...`
- Run `cefclient --enable-chrome-runtime --use-alloy-style
       [--use-chrome-style-window]
       [--use-views|--use-native|--off-screen-rendering-enabled]`
- Run `cefsimple --enable-chrome-runtime --use-alloy-style [--use-views]`
2024-04-22 14:57:37 -04:00

185 lines
6.4 KiB
C++

// Copyright 2016 The Chromium Embedded Framework Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.
#ifndef CEF_LIBCEF_BROWSER_VIEWS_WINDOW_IMPL_H_
#define CEF_LIBCEF_BROWSER_VIEWS_WINDOW_IMPL_H_
#pragma once
#include <map>
#include "include/views/cef_window.h"
#include "include/views/cef_window_delegate.h"
#include "libcef/browser/menu_model_impl.h"
#include "libcef/browser/views/panel_impl.h"
#include "libcef/browser/views/window_view.h"
#include "ui/base/accelerators/accelerator.h"
#include "ui/views/controls/menu/menu_runner.h"
#include "ui/views/widget/widget.h"
namespace views {
class MenuButton;
}
class CefWindowImpl
: public CefPanelImpl<CefWindowView, CefWindow, CefWindowDelegate>,
public CefWindowView::Delegate,
public ui::AcceleratorTarget {
public:
using ParentClass = CefPanelImpl<CefWindowView, CefWindow, CefWindowDelegate>;
CefWindowImpl(const CefWindowImpl&) = delete;
CefWindowImpl& operator=(const CefWindowImpl&) = delete;
// Create a new CefWindow instance. |delegate| may be nullptr. |parent_widget|
// will be used when creating a Chrome child window.
static CefRefPtr<CefWindowImpl> Create(CefRefPtr<CefWindowDelegate> delegate,
gfx::AcceleratedWidget parent_widget);
// CefWindow methods:
void Show() override;
void ShowAsBrowserModalDialog(
CefRefPtr<CefBrowserView> browser_view) override;
void Hide() override;
void CenterWindow(const CefSize& size) override;
void Close() override;
bool IsClosed() override;
void Activate() override;
void Deactivate() override;
bool IsActive() override;
void BringToTop() override;
void SetAlwaysOnTop(bool on_top) override;
bool IsAlwaysOnTop() override;
void Maximize() override;
void Minimize() override;
void Restore() override;
void SetFullscreen(bool fullscreen) override;
bool IsMaximized() override;
bool IsMinimized() override;
bool IsFullscreen() override;
void SetTitle(const CefString& title) override;
CefString GetTitle() override;
void SetWindowIcon(CefRefPtr<CefImage> image) override;
CefRefPtr<CefImage> GetWindowIcon() override;
void SetWindowAppIcon(CefRefPtr<CefImage> image) override;
CefRefPtr<CefImage> GetWindowAppIcon() override;
CefRefPtr<CefOverlayController> AddOverlayView(
CefRefPtr<CefView> view,
cef_docking_mode_t docking_mode,
bool can_activate) override;
void ShowMenu(CefRefPtr<CefMenuModel> menu_model,
const CefPoint& screen_point,
cef_menu_anchor_position_t anchor_position) override;
void CancelMenu() override;
CefRefPtr<CefDisplay> GetDisplay() override;
CefRect GetClientAreaBoundsInScreen() override;
void SetDraggableRegions(
const std::vector<CefDraggableRegion>& regions) override;
CefWindowHandle GetWindowHandle() override;
void SendKeyPress(int key_code, uint32_t event_flags) override;
void SendMouseMove(int screen_x, int screen_y) override;
void SendMouseEvents(cef_mouse_button_type_t button,
bool mouse_down,
bool mouse_up) override;
void SetAccelerator(int command_id,
int key_code,
bool shift_pressed,
bool ctrl_pressed,
bool alt_pressed,
bool high_priority) override;
void RemoveAccelerator(int command_id) override;
void RemoveAllAccelerators() override;
void SetThemeColor(int color_id, cef_color_t color) override;
void ThemeChanged() override;
cef_runtime_style_t GetRuntimeStyle() override;
// CefViewAdapter methods:
void Detach() override;
// CefPanel methods:
CefRefPtr<CefWindow> AsWindow() override { return this; }
// CefView methods:
void SetBounds(const CefRect& bounds) override;
CefRect GetBounds() override;
CefRect GetBoundsInScreen() override;
void SetSize(const CefSize& bounds) override;
void SetPosition(const CefPoint& position) override;
void SizeToPreferredSize() override;
void SetVisible(bool visible) override;
bool IsVisible() override;
bool IsDrawn() override;
void SetBackgroundColor(cef_color_t color) override;
// CefWindowView::Delegate methods:
bool CanWidgetClose() override;
void OnWindowClosing() override;
void OnWindowViewDeleted() override;
// CefViewAdapter methods:
std::string GetDebugType() override { return "Window"; }
void GetDebugInfo(base::Value::Dict* info, bool include_children) override;
// ui::AcceleratorTarget methods:
bool AcceleratorPressed(const ui::Accelerator& accelerator) override;
bool CanHandleAccelerators() const override;
// Called for key events that have not been handled by other controls in the
// window. Returns true if the event was handled.
bool OnKeyEvent(const CefKeyEvent& event);
void ShowMenu(views::MenuButton* menu_button,
CefRefPtr<CefMenuModel> menu_model,
const CefPoint& screen_point,
cef_menu_anchor_position_t anchor_position);
void MenuClosed();
CefWindowView* cef_window_view() const;
views::Widget* widget() const { return widget_; }
bool initialized() const { return initialized_; }
private:
// Create a new implementation object.
// Always call Initialize() after creation.
// |delegate| may be nullptr.
explicit CefWindowImpl(CefRefPtr<CefWindowDelegate> delegate);
// CefViewImpl methods:
CefWindowView* CreateRootView() override;
void InitializeRootView() override;
// Initialize the Widget.
void CreateWidget(gfx::AcceleratedWidget parent_widget);
views::Widget* widget_ = nullptr;
// True if the window has been initialized.
bool initialized_ = false;
// True if the window has been destroyed.
bool destroyed_ = false;
// The currently active menu model and runner.
CefRefPtr<CefMenuModelImpl> menu_model_;
std::unique_ptr<views::MenuRunner> menu_runner_;
// Map of command_id to accelerator.
using AcceleratorMap = std::map<int, ui::Accelerator>;
AcceleratorMap accelerator_map_;
#if defined(USE_AURA)
// Native widget's handler to receive events after the event target.
std::unique_ptr<ui::EventHandler> unhandled_key_event_handler_;
#endif
// True if this window was shown using ShowAsBrowserModalDialog().
bool shown_as_browser_modal_ = false;
IMPLEMENT_REFCOUNTING_DELETE_ON_UIT(CefWindowImpl);
};
#endif // CEF_LIBCEF_BROWSER_VIEWS_WINDOW_IMPL_H_