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
|
// 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_USER_EDUCATION_START_TUTORIAL_IN_PAGE_H_
#define CHROME_BROWSER_UI_USER_EDUCATION_START_TUTORIAL_IN_PAGE_H_
#include <optional>
#include "base/functional/callback_helpers.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/user_education/user_education_types.h"
#include "components/user_education/common/tutorial/tutorial_identifier.h"
#include "components/user_education/common/tutorial/tutorial_service.h"
#include "url/gurl.h"
class Browser;
// Utility for opening a page and starting a tutorial. The object exists
// only as long as the operation is in progress.
//
// Example:
//
// // Open security settings page and start a tutorial.
// StartTutorialInPage::Params params;
//
// // The page does not need to be a WebUI page. It could be any page
// // that is contextually needed for the tutorial.
// // components/user_education/webui/README.md
// params.target_url = "chrome://settings/security";
//
// // The tutorial to start.
// params.tutorial_id = kEnhancedSecuritySettingElementId;
//
// // Log when the tutorial has been triggered. The page navigation
// // may not be complete yet.
// params.callback = base::BindOnce(
// &::MaybeLogEnhancedSecurityTutorialStarted);
//
// // Start the procedure of showing the tutorial and triggering
// // the navigation.
// StartTutorialInPage::Start(browser_, std::move(params));
//
class StartTutorialInPage {
public:
// Called when the tutorial is started.
using Callback = base::OnceCallback<void(
user_education::TutorialService* tutorial_service)>;
// Specifies how a page should be open to show a help bubble.
struct Params {
Params();
Params(Params&& other) noexcept;
Params& operator=(Params&& other) noexcept;
~Params();
// The page to open. If not specified, the current page will be used.
std::optional<GURL> target_url = std::nullopt;
// See page_open_mode in show_promo_in_page.h.
user_education::PageOpenMode page_open_mode =
user_education::PageOpenMode::kNewForegroundTab;
// Callback that notifies when the tutorial was triggered. The
// callback is passed the TutorialService to use to log or check
// if the tutorial was started successfully. Typically used for
// testing or metrics collection.
Callback callback = base::DoNothing();
// The ID of the tutorial to start.
std::optional<user_education::TutorialIdentifier> tutorial_id =
std::nullopt;
};
StartTutorialInPage(const StartTutorialInPage&) = delete;
virtual ~StartTutorialInPage();
void operator=(const StartTutorialInPage&) = delete;
// Opens the page in `browser` and starts a Tutorial as described by
// `params`. This method must be called on the UI thread.
static base::WeakPtr<StartTutorialInPage> Start(Browser* browser,
Params params);
protected:
StartTutorialInPage();
};
#endif // CHROME_BROWSER_UI_USER_EDUCATION_START_TUTORIAL_IN_PAGE_H_
|
