File: custom_help_bubble_view.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 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 (102 lines) | stat: -rw-r--r-- 4,515 bytes parent folder | download | duplicates (3)
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
100
101
102
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_USER_EDUCATION_VIEWS_CUSTOM_HELP_BUBBLE_VIEW_H_
#define COMPONENTS_USER_EDUCATION_VIEWS_CUSTOM_HELP_BUBBLE_VIEW_H_

#include <concepts>
#include <memory>

#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/memory/ptr_util.h"
#include "components/user_education/common/feature_promo/feature_promo_specification.h"
#include "components/user_education/common/help_bubble/custom_help_bubble.h"
#include "components/user_education/common/help_bubble/help_bubble_params.h"
#include "components/user_education/views/help_bubble_factory_views.h"
#include "components/user_education/views/help_bubble_views.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/element_tracker.h"
#include "ui/views/bubble/bubble_dialog_delegate_view.h"
#include "ui/views/widget/widget.h"

namespace user_education {

template <typename T>
concept IsCustomHelpBubbleView =
    std::derived_from<T, views::BubbleDialogDelegateView> &&
    std::derived_from<T, CustomHelpBubbleUi>;

// Factory method that generates a custom help bubble view from the home context
// of the promo controller and the build params.
template <typename T>
  requires IsCustomHelpBubbleView<T>
using CustomHelpBubbleViewFactoryCallback =
    base::RepeatingCallback<std::unique_ptr<T>(
        ui::ElementContext from_context,
        HelpBubbleArrow arrow,
        FeaturePromoSpecification::BuildHelpBubbleParams build_params)>;

// Convenience method that creates the callback to feed to
// `FeaturePromoSpecification::CreateForCustomUi()` from a callback that creates
// just the bubble. The bubble will be created with the simpler callback
// provided, shown, and then wrapped in a `CustomHelpBubbleViews` and returned.
//
// If your dialog has default dialog "Accept" and/or "Cancel" buttons, you
// should specify the corresponding `accept_button_action` and
// `cancel_button_action`. The "close" button - i.e. (X) - and the ESC key are
// always automatically handled for you, and you should NEVER call
// `Widget::MakeCloseSynchronous` yourself.
//
// Prefer this to constructing CustomHelpBubbleViews directly.
template <typename T>
  requires IsCustomHelpBubbleView<T>
FeaturePromoSpecification::CustomHelpBubbleFactoryCallback<
    CustomHelpBubbleViews>
CreateCustomHelpBubbleViewFactoryCallback(
    CustomHelpBubbleViewFactoryCallback<T> bubble_factory_callback,
    std::optional<CustomHelpBubbleUi::UserAction> accept_button_action =
        std::nullopt,
    std::optional<CustomHelpBubbleUi::UserAction> cancel_button_action =
        std::nullopt) {
  return base::BindRepeating(
      [](const CustomHelpBubbleViewFactoryCallback<T>& bubble_factory_callback,
         std::optional<CustomHelpBubbleUi::UserAction> accept_button_action,
         std::optional<CustomHelpBubbleUi::UserAction> cancel_button_action,
         ui::ElementContext from_context, HelpBubbleArrow arrow,
         FeaturePromoSpecification::BuildHelpBubbleParams build_params) {
        auto* const anchor_element = build_params.anchor_element.get();
        auto bubble = bubble_factory_callback.Run(from_context, arrow,
                                                  std::move(build_params));
        T* const bubble_ptr = bubble.get();

        // Specific shadow types are required for help bubbles in order to
        // properly render visible bubble arrows.
        bubble_ptr->set_shadow(
            HelpBubbleFactoryViews::GetDefaultBubbleShadow());

        auto widget =
            base::WrapUnique(views::BubbleDialogDelegateView::CreateBubble(
                std::move(bubble),
                views::Widget::InitParams::CLIENT_OWNS_WIDGET));

        // Maybe set the arrow. This may require recalculating the bubble
        // bounds.
        if (arrow != HelpBubbleArrow::kNone) {
          bubble_ptr->GetBubbleFrameView()->SetDisplayVisibleArrow(true);
          bubble_ptr->SizeToContents();
        }

        widget->Show();
        return std::make_unique<CustomHelpBubbleViews>(
            std::move(widget), bubble_ptr, anchor_element, accept_button_action,
            cancel_button_action);
      },
      std::move(bubble_factory_callback), accept_button_action,
      cancel_button_action);
}

}  // namespace user_education

#endif  // COMPONENTS_USER_EDUCATION_VIEWS_CUSTOM_HELP_BUBBLE_VIEW_H_