chrome: Add ability to hide toolbar and app menu contents (see issue c…

…hromiumembedded#3280)

This change adds new CefCommandHandler callbacks for optionally hiding
specific Chrome toolbar icons, buttons and app menu items.

To test: Run `cefclient --enable-chrome-runtime --filter-chrome-commands`.
Most icons, buttons and app/context menu items will be hidden.

include/capi/cef_command_handler_capi.h

@@ -33,7 +33,7 @@
 // by hand. See the translator.README.txt file in the tools directory for
 // more information.
 //
-// $hash=46817ef557307a55a9b7138134c4f5c32562f2d7$
+// $hash=0cbb756a64d2aca1075480b5188b36cae533864d$
 //
 
 #ifndef CEF_INCLUDE_CAPI_CEF_COMMAND_HANDLER_CAPI_H_
@@ -71,6 +71,46 @@ typedef struct _cef_command_handler_t {
  struct _cef_browser_t* browser,
  int command_id,
  cef_window_open_disposition_t disposition);
+
+ ///
+ /// Called to check if a Chrome app menu item should be visible. Values for
+ /// |command_id| can be found in the cef_command_ids.h file. Only called for
+ /// menu items that would be visible by default. Only used with the Chrome
+ /// runtime.
+ ///
+ int(CEF_CALLBACK* is_chrome_app_menu_item_visible)(
+ struct _cef_command_handler_t* self,
+ struct _cef_browser_t* browser,
+ int command_id);
+
+ ///
+ /// Called to check if a Chrome app menu item should be enabled. Values for
+ /// |command_id| can be found in the cef_command_ids.h file. Only called for
+ /// menu items that would be enabled by default. Only used with the Chrome
+ /// runtime.
+ ///
+ int(CEF_CALLBACK* is_chrome_app_menu_item_enabled)(
+ struct _cef_command_handler_t* self,
+ struct _cef_browser_t* browser,
+ int command_id);
+
+ ///
+ /// Called during browser creation to check if a Chrome page action icon
+ /// should be visible. Only called for icons that would be visible by default.
+ /// Only used with the Chrome runtime.
+ ///
+ int(CEF_CALLBACK* is_chrome_page_action_icon_visible)(
+ struct _cef_command_handler_t* self,
+ cef_chrome_page_action_icon_type_t icon_type);
+
+ ///
+ /// Called during browser creation to check if a Chrome toolbar button should
+ /// be visible. Only called for buttons that would be visible by default. Only
+ /// used with the Chrome runtime.
+ ///
+ int(CEF_CALLBACK* is_chrome_toolbar_button_visible)(
+ struct _cef_command_handler_t* self,
+ cef_chrome_toolbar_button_type_t button_type);
 } cef_command_handler_t;
 
 #ifdef __cplusplus

include/cef_api_hash.h

@@ -42,13 +42,13 @@
 // way that may cause binary incompatibility with other builds. The universal
 // hash value will change if any platform is affected whereas the platform hash
 // values will change only if that particular platform is affected.
-#define CEF_API_HASH_UNIVERSAL "a41a1ba176d9a8cd7d8f15bc0d0c9c88f3c5a3a3"
+#define CEF_API_HASH_UNIVERSAL "149694d7fffd78ef85e127229819c69e2189ef32"
 #if defined(OS_WIN)
-#define CEF_API_HASH_PLATFORM "b47745d2e8919e00416c26eb078fdde5ee546b9d"
+#define CEF_API_HASH_PLATFORM "6f31babeb3f7d2723af55fbd32868284694e4015"
 #elif defined(OS_MAC)
-#define CEF_API_HASH_PLATFORM "d04c2a5ab471493c185eb7c7aa894bc4a79d5a7c"
+#define CEF_API_HASH_PLATFORM "ff1bc603897dca8e100a1d4f9391ef4e49db02df"
 #elif defined(OS_LINUX)
-#define CEF_API_HASH_PLATFORM "d7d4cbffa4a798fea97e7b9f3610b5cb803d949e"
+#define CEF_API_HASH_PLATFORM "7f1ef8d0456bdcaff80c4e15a9806c603f204455"
 #endif
 
 #ifdef __cplusplus

include/cef_command_handler.h

@@ -63,6 +63,52 @@ class CefCommandHandler : public virtual CefBaseRefCounted {
  cef_window_open_disposition_t disposition) {
  return false;
  }
+
+ ///
+ /// Called to check if a Chrome app menu item should be visible. Values for
+ /// |command_id| can be found in the cef_command_ids.h file. Only called for
+ /// menu items that would be visible by default. Only used with the Chrome
+ /// runtime.
+ ///
+ /*--cef()--*/
+ virtual bool IsChromeAppMenuItemVisible(CefRefPtr<CefBrowser> browser,
+ int command_id) {
+ return true;
+ }
+
+ ///
+ /// Called to check if a Chrome app menu item should be enabled. Values for
+ /// |command_id| can be found in the cef_command_ids.h file. Only called for
+ /// menu items that would be enabled by default. Only used with the Chrome
+ /// runtime.
+ ///
+ /*--cef()--*/
+ virtual bool IsChromeAppMenuItemEnabled(CefRefPtr<CefBrowser> browser,
+ int command_id) {
+ return true;
+ }
+
+ ///
+ /// Called during browser creation to check if a Chrome page action icon
+ /// should be visible. Only called for icons that would be visible by default.
+ /// Only used with the Chrome runtime.
+ ///
+ /*--cef(optional_param=browser)--*/
+ virtual bool IsChromePageActionIconVisible(
+ cef_chrome_page_action_icon_type_t icon_type) {
+ return true;
+ }
+
+ ///
+ /// Called during browser creation to check if a Chrome toolbar button
+ /// should be visible. Only called for buttons that would be visible by
+ /// default. Only used with the Chrome runtime.
+ ///
+ /*--cef(optional_param=browser)--*/
+ virtual bool IsChromeToolbarButtonVisible(
+ cef_chrome_toolbar_button_type_t button_type) {
+ return true;
+ }
 };
 
 #endif // CEF_INCLUDE_CEF_COMMAND_HANDLER_H_

include/internal/cef_types.h

@@ -3251,14 +3251,59 @@ typedef enum {
 } cef_text_field_commands_t;
 
 ///
-/// Supported Chrome toolbar types.
+/// Chrome toolbar types.
 ///
 typedef enum {
  CEF_CTT_NONE = 1,
  CEF_CTT_NORMAL,
  CEF_CTT_LOCATION,
 } cef_chrome_toolbar_type_t;
 
+///
+/// Chrome page action icon types. Should be kept in sync with Chromium's
+/// PageActionIconType type.
+///
+typedef enum {
+ CEF_CPAIT_BOOKMARK_STAR = 0,
+ CEF_CPAIT_CLICK_TO_CALL,
+ CEF_CPAIT_COOKIE_CONTROLS,
+ CEF_CPAIT_FILE_SYSTEM_ACCESS,
+ CEF_CPAIT_FIND,
+ CEF_CPAIT_HIGH_EFFICIENCY,
+ CEF_CPAIT_INTENT_PICKER,
+ CEF_CPAIT_LOCAL_CARD_MIGRATION,
+ CEF_CPAIT_MANAGE_PASSWORDS,
+ CEF_CPAIT_PAYMENTS_OFFER_NOTIFICATION,
+ CEF_CPAIT_PRICE_TRACKING,
+ CEF_CPAIT_PWA_INSTALL,
+ CEF_CPAIT_QR_CODE_GENERATOR,
+ CEF_CPAIT_READER_MODE,
+ CEF_CPAIT_SAVE_AUTOFILL_ADDRESS,
+ CEF_CPAIT_SAVE_CARD,
+ CEF_CPAIT_SEND_TAB_TO_SELF,
+ CEF_CPAIT_SHARING_HUB,
+ CEF_CPAIT_SIDE_SEARCH,
+ CEF_CPAIT_SMS_REMOTE_FETCHER,
+ CEF_CPAIT_TRANSLATE,
+ CEF_CPAIT_VIRTUAL_CARD_ENROLL,
+ CEF_CPAIT_VIRTUAL_CARD_MANUAL_FALLBACK,
+ CEF_CPAIT_ZOOM,
+ CEF_CPAIT_SAVE_IBAN,
+ CEF_CPAIT_MAX_VALUE = CEF_CPAIT_SAVE_IBAN,
+} cef_chrome_page_action_icon_type_t;
+
+///
+/// Chrome toolbar button types. Should be kept in sync with CEF's internal
+/// ToolbarButtonType type.
+///
+typedef enum {
+ CEF_CTBT_CAST = 0,
+ CEF_CTBT_DOWNLOAD,
+ CEF_CTBT_SEND_TAB_TO_SELF,
+ CEF_CTBT_SIDE_PANEL,
+ CEF_CTBT_MAX_VALUE = CEF_CTBT_SIDE_PANEL,
+} cef_chrome_toolbar_button_type_t;
+
 ///
 /// Docking modes supported by CefWindow::AddOverlay.
 ///

libcef/browser/chrome/browser_delegate.h

@@ -9,6 +9,7 @@
 #include <memory>
 
 #include "base/memory/scoped_refptr.h"
+#include "chrome/browser/ui/page_action/page_action_icon_type.h"
 #include "content/public/browser/web_contents_delegate.h"
 #include "ui/base/window_open_disposition.h"
 
@@ -65,6 +66,32 @@ class BrowserDelegate : public content::WebContentsDelegate {
  return false;
  }
 
+ // Return true if the app menu item should be visible. ID values come from
+ // chrome/app/chrome_command_ids.h.
+ virtual bool IsAppMenuItemVisible(int command_id) { return true; }
+
+ // Return true if the app menu item should be enabled. ID values come from
+ // chrome/app/chrome_command_ids.h.
+ virtual bool IsAppMenuItemEnabled(int command_id) { return true; }
+
+ // Return true if the page action icon should be visible.
+ virtual bool IsPageActionIconVisible(PageActionIconType icon_type) {
+ return true;
+ }
+
+ enum class ToolbarButtonType {
+ kCast = 0,
+ kDownload,
+ kSendTabToSelf,
+ kSidePanel,
+ kMaxValue = kSidePanel,
+ };
+
+ // Return true if the toolbar button should be visible.
+ virtual bool IsToolbarButtonVisible(ToolbarButtonType button_type) {
+ return true;
+ }
+
  // Same as RequestMediaAccessPermission but returning |callback| if the
  // request is unhandled.
  [[nodiscard]] virtual content::MediaResponseCallback

libcef/browser/chrome/chrome_browser_delegate.cc

@@ -122,6 +122,60 @@ bool ChromeBrowserDelegate::HandleCommand(int command_id,
  return false;
 }
 
+bool ChromeBrowserDelegate::IsAppMenuItemVisible(int command_id) {
+ if (auto browser = ChromeBrowserHostImpl::GetBrowserForBrowser(browser_)) {
+ if (auto client = browser->GetClient()) {
+ if (auto handler = client->GetCommandHandler()) {
+ return handler->IsChromeAppMenuItemVisible(browser.get(), command_id);
+ }
+ }
+ }
+ return true;
+}
+
+bool ChromeBrowserDelegate::IsAppMenuItemEnabled(int command_id) {
+ if (auto browser = ChromeBrowserHostImpl::GetBrowserForBrowser(browser_)) {
+ if (auto client = browser->GetClient()) {
+ if (auto handler = client->GetCommandHandler()) {
+ return handler->IsChromeAppMenuItemEnabled(browser.get(), command_id);
+ }
+ }
+ }
+ return true;
+}
+
+bool ChromeBrowserDelegate::IsPageActionIconVisible(
+ PageActionIconType icon_type) {
+ // Verify that our enum matches Chromium's values.
+ static_assert(static_cast<int>(CEF_CPAIT_MAX_VALUE) ==
+ static_cast<int>(PageActionIconType::kMaxValue),
+ "enum mismatch");
+
+ if (auto client = create_params_.client) {
+ if (auto handler = client->GetCommandHandler()) {
+ return handler->IsChromePageActionIconVisible(
+ static_cast<cef_chrome_page_action_icon_type_t>(icon_type));
+ }
+ }
+ return true;
+}
+
+bool ChromeBrowserDelegate::IsToolbarButtonVisible(
+ ToolbarButtonType button_type) {
+ // Verify that our enum matches BrowserDelegate's values.
+ static_assert(static_cast<int>(CEF_CTBT_MAX_VALUE) ==
+ static_cast<int>(ToolbarButtonType::kMaxValue),
+ "enum mismatch");
+
+ if (auto client = create_params_.client) {
+ if (auto handler = client->GetCommandHandler()) {
+ return handler->IsChromeToolbarButtonVisible(
+ static_cast<cef_chrome_toolbar_button_type_t>(button_type));
+ }
+ }
+ return true;
+}
+
 content::MediaResponseCallback
 ChromeBrowserDelegate::RequestMediaAccessPermissionEx(
  content::WebContents* web_contents,

libcef/browser/chrome/chrome_browser_delegate.h

@@ -56,6 +56,10 @@ class ChromeBrowserDelegate : public cef::BrowserDelegate {
  bool ShowStatusBubble(bool show_by_default) override;
  bool HandleCommand(int command_id,
  WindowOpenDisposition disposition) override;
+ bool IsAppMenuItemVisible(int command_id) override;
+ bool IsAppMenuItemEnabled(int command_id) override;
+ bool IsPageActionIconVisible(PageActionIconType icon_type) override;
+ bool IsToolbarButtonVisible(ToolbarButtonType button_type) override;
  [[nodiscard]] content::MediaResponseCallback RequestMediaAccessPermissionEx(
  content::WebContents* web_contents,
  const content::MediaStreamRequest& request,