File: mojo_web_ui_controller.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 (55 lines) | stat: -rw-r--r-- 2,228 bytes parent folder | download | duplicates (6)
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
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_WEBUI_MOJO_WEB_UI_CONTROLLER_H_
#define UI_WEBUI_MOJO_WEB_UI_CONTROLLER_H_

#include "content/public/browser/web_ui.h"
#include "content/public/browser/web_ui_controller.h"

namespace ui {

// EnableMojoWebUI is intended for WebUI pages that use Mojo. Inherit from this
// class in addition to WebUIController (or other WebUIController subclass) to
// enable Mojo for a given WebUI page. See below for expectations.
class EnableMojoWebUI {
 public:
  explicit EnableMojoWebUI(content::WebUI* contents, bool enable_chrome_send);

  EnableMojoWebUI(const EnableMojoWebUI&) = delete;
  EnableMojoWebUI& operator=(const EnableMojoWebUI&) = delete;

  virtual ~EnableMojoWebUI();
};

// MojoWebUIController is intended for WebUI pages that use Mojo. It is
// expected that subclasses will:
// . Add all Mojo Bindings Resources via AddResourcePath(), eg:
//     source->AddResourcePath("chrome/browser/ui/webui/omnibox/omnibox.mojom",
//                              IDR_OMNIBOX_MOJO_JS);
// . Overload void BindInterface(mojo::PendingReceiver<InterfaceName>) for all
//   Mojo Interfaces it wishes to handle.
// . Use WEB_UI_CONTROLLER_TYPE_DECL macro in .h file and
//   WEB_UI_CONTROLLER_TYPE_IMPL macro in .cc file.
// . Register all Mojo Interfaces it wishes to handle in the appropriate
//   BinderMap:
//     - chrome/browser/chrome_browser_interface_binders.cc for chrome/ WebUIs;
//     - content/browser/browser_interface_binders.cc for content/ WebUIs.
class MojoWebUIController : public content::WebUIController,
                            public EnableMojoWebUI {
 public:
  // By default MojoWebUIControllers do not have normal WebUI bindings. Pass
  // |enable_chrome_send| as true if these are needed.
  explicit MojoWebUIController(content::WebUI* contents,
                               bool enable_chrome_send = false);

  MojoWebUIController(const MojoWebUIController&) = delete;
  MojoWebUIController& operator=(const MojoWebUIController&) = delete;

  ~MojoWebUIController() override;
};

}  // namespace ui

#endif  // UI_WEBUI_MOJO_WEB_UI_CONTROLLER_H_