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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Copyright 2020 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_NEW_BADGE_LABEL_H_
#define COMPONENTS_USER_EDUCATION_VIEWS_NEW_BADGE_LABEL_H_
#include <memory>
#include <string_view>
#include "components/user_education/common/new_badge/new_badge_controller.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/menus/simple_menu_model.h"
#include "ui/strings/grit/ui_strings.h"
#include "ui/views/badge_painter.h"
#include "ui/views/controls/label.h"
#include "ui/views/style/typography.h"
namespace views {
class Border;
}
namespace user_education {
// Extends views::Label to optionally display a "New" badge next to the text,
// drawing attention to a new feature in Chrome.
//
// When |display_new_badge| is set to false, behaves exactly as a normal Label,
// with the caveat that the following are explicitly disallowed:
// * Calling SetDisplayNewBadge() when the label is visible to the user.
// * Calling SetBorder() from external code, as the border is used to create
// space to render the badge.
class NewBadgeLabel : public views::Label {
METADATA_HEADER(NewBadgeLabel, views::Label)
public:
// Determines how the badge is placed relative to the label text if the label
// is wider than its preferred size (has no effect otherwise).
enum class BadgePlacement {
// Places the "New" badge immediately after the label text (default).
kImmediatelyAfterText,
// Places the "New" badge all the way at the trailing edge of the control,
// which is the right edge for LTR and the left edge for RTL.
kTrailingEdge
};
// Constructs a new badge label. Designed to be argument-compatible with the
// views::Label constructor so they can be substituted.
explicit NewBadgeLabel(const std::u16string& text = std::u16string(),
int text_context = views::style::CONTEXT_LABEL,
int text_style = views::style::STYLE_PRIMARY,
gfx::DirectionalityMode directionality_mode =
gfx::DirectionalityMode::DIRECTIONALITY_FROM_TEXT);
NewBadgeLabel(const std::u16string& text, const CustomFont& font);
~NewBadgeLabel() override;
// Sets whether the New badge is shown on this label.
// Should only be called before the label is shown.
void SetDisplayNewBadge(DisplayNewBadge display_new_badge);
bool GetDisplayNewBadge() const { return display_new_badge_; }
void SetPadAfterNewBadge(bool pad_after_new_badge);
bool GetPadAfterNewBadge() const { return pad_after_new_badge_; }
void SetBadgePlacement(BadgePlacement badge_placement);
BadgePlacement GetBadgePlacement() const { return badge_placement_; }
// Gets the accessible description of the badge, which can be added to
// tooltip/screen reader text.
std::u16string GetAccessibleDescription() const;
// Label:
gfx::Size CalculatePreferredSize(
const views::SizeBounds& available_size) const override;
gfx::Size GetMinimumSize() const override;
void OnDeviceScaleFactorChanged(float old_device_scale_factor,
float new_device_scale_factor) override;
void OnPaint(gfx::Canvas* canvas) override;
void SetText(std::u16string_view text) override;
void SetDisplayNewBadgeForTesting(bool display_new_badge);
private:
// Does the actual work of turning the "New" Badge on or off.
void SetDisplayNewBadgeImpl(bool display_new_badge);
// Hide the SetBorder() method so that external callers can't use it since we
// rely on it to add padding. This won't prevent access via downcast, however.
void SetBorder(std::unique_ptr<views::Border> b) override;
void UpdateAccessibleName();
// Specifies whether the badge should be displayed. Defaults to false, which
// behaves like a normal label.
bool display_new_badge_ = false;
// Add the required internal padding to the label so that there is room to
// display the new badge.
void UpdatePaddingForNewBadge();
gfx::Size GetNewBadgeSize() const;
// Specifies the placement of the "New" badge when the label is wider than its
// preferred size.
BadgePlacement badge_placement_ = BadgePlacement::kImmediatelyAfterText;
// Determines whether there is additional internal margin to the right of the
// "New" badge. When set to true, the space will be allocated, and
// kInternalPaddingKey will be set so that layouts know this space is empty.
bool pad_after_new_badge_ = true;
const std::u16string new_badge_text_ =
l10n_util::GetStringUTF16(IDS_NEW_BADGE);
};
} // namespace user_education
#endif // COMPONENTS_USER_EDUCATION_VIEWS_NEW_BADGE_LABEL_H_
|
