File: search_engine_choice_tab_helper.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (81 lines) | stat: -rw-r--r-- 3,272 bytes parent folder | download | duplicates (5)
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
// Copyright 2023 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_SEARCH_ENGINE_CHOICE_SEARCH_ENGINE_CHOICE_TAB_HELPER_H_
#define CHROME_BROWSER_UI_SEARCH_ENGINE_CHOICE_SEARCH_ENGINE_CHOICE_TAB_HELPER_H_

#include <optional>

#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "ui/gfx/geometry/size.h"

namespace content {
class WebContents;
}

class Browser;

// Helper class which watches `web_contents` to determine whether there is an
// appropriate opportunity to show the SearchEngineChoiceDialogView.
class SearchEngineChoiceTabHelper
    : public content::WebContentsObserver,
      public content::WebContentsUserData<SearchEngineChoiceTabHelper> {
 public:
  SearchEngineChoiceTabHelper(const SearchEngineChoiceTabHelper&) = delete;
  SearchEngineChoiceTabHelper& operator=(const SearchEngineChoiceTabHelper&) =
      delete;
  ~SearchEngineChoiceTabHelper() override;

  // Static method that tells us if the helper is needed. This is to be
  // checked before creating the helper so we don't unnecessarily create one
  // for every `WebContents`.
  // TODO(crbug.com/347223092): Improve this approximative check, that
  // currently only depends on feature flags.
  static bool IsHelperNeeded();

 private:
  friend class content::WebContentsUserData<SearchEngineChoiceTabHelper>;

  explicit SearchEngineChoiceTabHelper(content::WebContents* web_contents);

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

  // Shows the dialog if the user is eligible and if the tab is in compatible
  // state (e.g. visible, loaded, suitable URL).
  void MaybeShowDialog();

  WEB_CONTENTS_USER_DATA_KEY_DECL();
};

// Implemented in
// `chrome/browser/ui/views/search_engine_choice/search_engine_choice_dialog_view.cc`
// because there isn't a dependency between `chrome/browser/ui/` and
// `chrome/browser/ui/views/`.
class SearchEngineChoiceDialog {
 public:
  // `boundary_dimensions_for_test` can be set to specify an upper bound for
  // dialog's width and height. Leaving it empty will make the dialog use the
  // window size as upper bound.
  // `zoom_factor_for_test` can be set to specify the zoom factor needed. This
  // is used to be able to display the full content of the dialog in screenshot
  // tests. Leaving it empty will make the dialog use a zoom of 1.;
  static void Show(
      Browser& browser,
      std::optional<gfx::Size> boundary_dimensions_for_test = std::nullopt,
      std::optional<double> zoom_factor_for_test_ = std::nullopt);
};

// Implemented in
// `chrome/browser/ui/views/search_engine_choice/search_engine_choice_dialog_view.cc`
// because there isn't a dependency between `chrome/browser/ui/` and
// `chrome/browser/ui/views/`.
// Returns whether the smallest height variant of the search engine choice
// dialog can fit in the browser window or not.
bool CanWindowHeightFitSearchEngineChoiceDialog(Browser& browser);

#endif  // CHROME_BROWSER_UI_SEARCH_ENGINE_CHOICE_SEARCH_ENGINE_CHOICE_TAB_HELPER_H_