File: customize_chrome_tab_helper.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 (79 lines) | stat: -rw-r--r-- 2,914 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
// 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_SIDE_PANEL_CUSTOMIZE_CHROME_CUSTOMIZE_CHROME_TAB_HELPER_H_
#define CHROME_BROWSER_UI_SIDE_PANEL_CUSTOMIZE_CHROME_CUSTOMIZE_CHROME_TAB_HELPER_H_

#include "chrome/browser/ui/webui/side_panel/customize_chrome/customize_chrome_section.h"
#include "content/public/browser/web_contents_user_data.h"

namespace content {
class WebContents;
}  // namespace content

// An observer of WebContents that facilitates the logic for the customize
// chrome side panel. This per-tab class also owns the
// CustomizeChromeSidePanelController.
class CustomizeChromeTabHelper
    : public content::WebContentsUserData<CustomizeChromeTabHelper> {
 public:
  // This class delegates the responsibility for registering and deregistering
  // the Customize Chrome side panel.
  class Delegate {
   public:
    virtual void CreateAndRegisterEntry() = 0;
    virtual void DeregisterEntry() = 0;
    virtual void SetCustomizeChromeSidePanelVisible(
        bool visible,
        CustomizeChromeSection section) = 0;
    virtual bool IsCustomizeChromeEntryShowing() const = 0;
    virtual bool IsCustomizeChromeEntryAvailable() const = 0;
    virtual ~Delegate() = default;
  };

  using StateChangedCallBack = base::RepeatingCallback<void(bool)>;

  CustomizeChromeTabHelper(const CustomizeChromeTabHelper&) = delete;
  CustomizeChromeTabHelper& operator=(const CustomizeChromeTabHelper&) = delete;
  ~CustomizeChromeTabHelper() override;

  // Creates a WebUISidePanelView for customize chrome and registers
  // the customize chrome side panel entry.
  void CreateAndRegisterEntry();

  // Deregisters the customize chrome side panel entry.
  void DeregisterEntry();

  // Opens and closes Side Panel to the customize chrome entry.
  virtual void SetCustomizeChromeSidePanelVisible(
      bool visible,
      CustomizeChromeSection section);

  // True if the side panel is open and showing the customize chrome entry.
  bool IsCustomizeChromeEntryShowing() const;

  // True if the customize chrome entry is available in current tabs' registry.
  bool IsCustomizeChromeEntryAvailable() const;

  // Called by when the side panel is shown/hidden, runs callback that
  // shows/hides the customize chrome button
  void EntryStateChanged(bool is_open);

  // Sets callback that is run when side panel entry state is changed
  void SetCallback(StateChangedCallBack callback);

 protected:
  explicit CustomizeChromeTabHelper(content::WebContents* web_contents);

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

  std::unique_ptr<Delegate> delegate_;

  StateChangedCallBack entry_state_changed_callback_;

  WEB_CONTENTS_USER_DATA_KEY_DECL();
};

#endif  // CHROME_BROWSER_UI_SIDE_PANEL_CUSTOMIZE_CHROME_CUSTOMIZE_CHROME_TAB_HELPER_H_