File: unified_side_search_controller.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (99 lines) | stat: -rw-r--r-- 3,875 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_VIEWS_SIDE_SEARCH_UNIFIED_SIDE_SEARCH_CONTROLLER_H_
#define CHROME_BROWSER_UI_VIEWS_SIDE_SEARCH_UNIFIED_SIDE_SEARCH_CONTROLLER_H_

#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "base/timer/elapsed_timer.h"
#include "chrome/browser/ui/side_search/side_search_metrics.h"
#include "chrome/browser/ui/side_search/side_search_tab_contents_helper.h"
#include "chrome/browser/ui/views/side_panel/side_panel_coordinator.h"
#include "chrome/browser/ui/views/side_panel/side_panel_registry_observer.h"
#include "chrome/browser/ui/views/side_search/default_search_icon_source.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "ui/base/models/image_model.h"
#include "ui/views/controls/webview/unhandled_keyboard_event_handler.h"
#include "ui/views/view.h"

class BrowserView;
class Profile;

// Responsible for managing the WebContents hosted in the browser's side panel
// for Side Search. Created immediately following the creation of the tab's
// WebContents.
class UnifiedSideSearchController
    : public SideSearchTabContentsHelper::Delegate,
      public content::WebContentsObserver,
      public SidePanelEntryObserver,
      public content::WebContentsUserData<UnifiedSideSearchController> {
 public:
  explicit UnifiedSideSearchController(content::WebContents* web_contents);
  UnifiedSideSearchController(const UnifiedSideSearchController&) = delete;
  UnifiedSideSearchController& operator=(const UnifiedSideSearchController&) =
      delete;
  ~UnifiedSideSearchController() override;

  // SideSearchTabContentsHelper::Delegate:
  bool HandleKeyboardEvent(
      content::WebContents* source,
      const content::NativeWebKeyboardEvent& event) override;
  content::WebContents* OpenURLFromTab(
      content::WebContents* source,
      const content::OpenURLParams& params) override;
  void SidePanelAvailabilityChanged(bool should_close) override;
  void OpenSidePanel() override;

  // content::WebContentsObserver:
  void DidFinishNavigation(
      content::NavigationHandle* navigation_handle) override;

  // SidePanelEntryObserver:
  void OnEntryShown(SidePanelEntry* entry) override;
  void OnEntryHidden(SidePanelEntry* entry) override;

  base::WeakPtr<UnifiedSideSearchController> GetWeakPtr();
  void CloseSidePanel();

  // Gets the URL needed to open the current side search side panel contents
  // into a new tab.
  GURL GetOpenInNewTabURL() const;

  WEB_CONTENTS_USER_DATA_KEY_DECL();

 private:
  BrowserView* GetBrowserView() const;
  Profile* GetProfile() const;
  SidePanelUI* GetSidePanelUI();

  // Create a WebView to host the side search WebContents.
  std::unique_ptr<views::View> GetSideSearchView();

  // Creates a ImageModel for the current DSE's favicon.
  ui::ImageModel GetSideSearchIcon();

  // Creates a string representing the side search side panel's hosted content.
  std::u16string GetSideSearchName() const;

  // Updates side panel's availability from SideSearchTabContentsHelper.
  void UpdateSidePanel();

  void UpdateSidePanelRegistry(bool is_available);

  // True if the side panel should be automatically triggered after a navigation
  // defined by `navigation_handle`.
  bool ShouldAutomaticallyTriggerAfterNavigation(
      content::NavigationHandle* navigation_handle);

  // A handler to handle unhandled keyboard messages coming back from the
  // renderer process.
  views::UnhandledKeyboardEventHandler unhandled_keyboard_event_handler_;

  base::WeakPtrFactory<UnifiedSideSearchController> weak_factory_{this};
};

#endif  // CHROME_BROWSER_UI_VIEWS_SIDE_SEARCH_UNIFIED_SIDE_SEARCH_CONTROLLER_H_