File: omnibox_header_view.cc

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 (243 lines) | stat: -rw-r--r-- 10,776 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
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
// 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.

#include "chrome/browser/ui/views/omnibox/omnibox_header_view.h"

#include "base/functional/bind.h"
#include "base/i18n/case_conversion.h"
#include "chrome/browser/ui/layout_constants.h"
#include "chrome/browser/ui/omnibox/omnibox_theme.h"
#include "chrome/browser/ui/views/chrome_typography.h"
#include "chrome/browser/ui/views/omnibox/omnibox_match_cell_view.h"
#include "chrome/browser/ui/views/omnibox/omnibox_popup_view_views.h"
#include "chrome/browser/ui/views/omnibox/omnibox_result_view.h"
#include "components/omnibox/browser/omnibox_edit_model.h"
#include "components/omnibox/browser/omnibox_field_trial.h"
#include "components/omnibox/browser/omnibox_popup_selection.h"
#include "components/omnibox/browser/vector_icons.h"
#include "components/strings/grit/components_strings.h"
#include "ui/accessibility/ax_node_data.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/metadata/metadata_impl_macros.h"
#include "ui/color/color_provider.h"
#include "ui/gfx/image/image_skia_operations.h"
#include "ui/gfx/paint_vector_icon.h"
#include "ui/views/accessibility/view_accessibility.h"
#include "ui/views/animation/ink_drop.h"
#include "ui/views/controls/button/button.h"
#include "ui/views/controls/button/image_button.h"
#include "ui/views/controls/button/image_button_factory.h"
#include "ui/views/controls/focus_ring.h"
#include "ui/views/controls/highlight_path_generator.h"
#include "ui/views/controls/label.h"
#include "ui/views/layout/box_layout.h"
#include "ui/views/style/typography.h"
#include "ui/views/style/typography_provider.h"

OmniboxHeaderView::OmniboxHeaderView(OmniboxPopupViewViews* popup_view,
                                     size_t model_index)
    : popup_view_(popup_view),
      model_index_(model_index),
      // Using base::Unretained is correct here. 'this' outlives the callback.
      mouse_enter_exit_handler_(
          base::BindRepeating(&OmniboxHeaderView::UpdateUI,
                              base::Unretained(this))) {
  views::BoxLayout* layout =
      SetLayoutManager(std::make_unique<views::BoxLayout>(
          views::BoxLayout::Orientation::kHorizontal));
  // This is the designer-provided spacing that matches the NTP Realbox.
  // TODO(khalidpeer): Update this spacing for realbox per CR23 guidelines.
  const int spacing_between_label_and_icon =
      OmniboxFieldTrial::IsChromeRefreshSuggestIconsEnabled() ? 0 : 8;
  layout->set_between_child_spacing(spacing_between_label_and_icon);

  header_label_ = AddChildView(std::make_unique<views::Label>());
  header_label_->SetHorizontalAlignment(gfx::HorizontalAlignment::ALIGN_LEFT);

  const gfx::FontList& font =
      views::TypographyProvider::Get()
          .GetFont(CONTEXT_OMNIBOX_SECTION_HEADER, views::style::STYLE_PRIMARY)
          .DeriveWithWeight(gfx::Font::Weight::MEDIUM);
  header_label_->SetFontList(font);

  header_toggle_button_ = AddChildView(views::CreateVectorToggleImageButton(
      base::BindRepeating(&OmniboxHeaderView::HeaderToggleButtonPressed,
                          base::Unretained(this))));
  mouse_enter_exit_handler_.ObserveMouseEnterExitOn(header_toggle_button_);
  views::InstallCircleHighlightPathGenerator(header_toggle_button_);
  header_toggle_button_->SetFocusBehavior(FocusBehavior::ACCESSIBLE_ONLY);

  views::FocusRing::Install(header_toggle_button_);
  views::FocusRing::Get(header_toggle_button_)
      ->SetHasFocusPredicate(base::BindRepeating(
          [](const OmniboxHeaderView* header, const View* view) {
            return view->GetVisible() &&
                   header->popup_view_->model()->GetPopupSelection() ==
                       header->GetHeaderSelection();
          },
          base::Unretained(this)));
  views::FocusRing::Get(header_toggle_button_)
      ->SetOutsetFocusRingDisabled(true);
}

void OmniboxHeaderView::SetHeader(const std::u16string& header_text,
                                  bool is_suggestion_group_hidden) {
  header_text_ = header_text;

  // TODO(tommycli): Our current design calls for uppercase text here, but
  // it seems like an open question what should happen for non-Latin locales.
  // Moreover, it seems unusual to do case conversion in Views in general.
  std::u16string header_str = header_text_;
  if (!OmniboxFieldTrial::IsChromeRefreshSuggestIconsEnabled()) {
    header_str = base::i18n::ToUpper(header_str);
  }
  header_label_->SetText(header_str);
  header_toggle_button_->SetToggled(is_suggestion_group_hidden);
}

gfx::Insets OmniboxHeaderView::GetInsets() const {
  // Makes the header height roughly the same as the single-line row height.
  const int vertical =
      OmniboxFieldTrial::IsChromeRefreshSuggestIconsEnabled() ? 8 : 6;

  // Aligns the header text with the icons of ordinary matches. The assumed
  // small icon width here is lame, but necessary, since it's not explicitly
  // defined anywhere else in the code.
  constexpr int assumed_match_cell_icon_width = 16;
  constexpr int left_inset = OmniboxMatchCellView::kMarginLeft +
                             (OmniboxMatchCellView::kImageBoundsWidth -
                              assumed_match_cell_icon_width) /
                                 2;

  return gfx::Insets::TLBR(vertical, left_inset, vertical,
                           OmniboxMatchCellView::kMarginRight);
}

bool OmniboxHeaderView::OnMousePressed(const ui::MouseEvent& event) {
  // Needed to receive the OnMouseReleased event.
  return true;
}

void OmniboxHeaderView::OnMouseReleased(const ui::MouseEvent& event) {
  popup_view_->model()->OpenSelection(GetHeaderSelection(), event.time_stamp());
}

void OmniboxHeaderView::OnMouseEntered(const ui::MouseEvent& event) {
  UpdateUI();
}

void OmniboxHeaderView::OnMouseExited(const ui::MouseEvent& event) {
  UpdateUI();
}

void OmniboxHeaderView::OnThemeChanged() {
  views::View::OnThemeChanged();

  // When the theme is updated, also refresh the hover-specific UI, which is
  // all of the UI.
  UpdateUI();
}

void OmniboxHeaderView::GetAccessibleNodeData(ui::AXNodeData* node_data) {
  // Hidden OmniboxHeaderView instances are not associated with any group ID, so
  // they are neither collapsed or expanded.s
  if (!GetVisible()) {
    return;
  }

  node_data->AddState(suggestion_group_hidden_ ? ax::mojom::State::kCollapsed
                                               : ax::mojom::State::kExpanded);
}

void OmniboxHeaderView::UpdateUI() {
  OmniboxPartState part_state = OmniboxPartState::NORMAL;
  if (popup_view_->model()->GetPopupSelection() == GetHeaderSelection()) {
    part_state = OmniboxPartState::SELECTED;
  } else if (IsMouseHovered()) {
    part_state = OmniboxPartState::HOVERED;
  }

  const auto* const color_provider = GetColorProvider();
  const SkColor text_color =
      color_provider->GetColor((part_state == OmniboxPartState::SELECTED)
                                   ? kColorOmniboxResultsTextDimmedSelected
                                   : kColorOmniboxResultsTextDimmed);
  header_label_->SetEnabledColor(text_color);

  const SkColor icon_color =
      color_provider->GetColor((part_state == OmniboxPartState::SELECTED)
                                   ? kColorOmniboxResultsIconSelected
                                   : kColorOmniboxResultsIcon);
  views::InkDrop::Get(header_toggle_button_)->SetBaseColor(icon_color);

  int dip_size = GetLayoutConstant(LOCATION_BAR_ICON_SIZE);
  const gfx::ImageSkia arrow_down = gfx::CreateVectorIcon(
      OmniboxFieldTrial::IsChromeRefreshSuggestIconsEnabled()
          ? omnibox::kArrowDownChromeRefreshIcon
          : omnibox::kChevronIcon,
      dip_size, icon_color);
  const gfx::ImageSkia arrow_up =
      OmniboxFieldTrial::IsChromeRefreshSuggestIconsEnabled()
          ? gfx::CreateVectorIcon(omnibox::kArrowUpChromeRefreshIcon, dip_size,
                                  icon_color)
          : gfx::ImageSkiaOperations::CreateRotatedImage(
                arrow_down, SkBitmapOperations::ROTATION_180_CW);

  // The "untoggled" button state corresponds with the group being shown.
  // The button's action is therefore to Hide the group, when clicked.
  header_toggle_button_->SetImage(views::Button::STATE_NORMAL, arrow_up);
  header_toggle_button_->SetTooltipText(
      l10n_util::GetStringUTF16(IDS_TOOLTIP_HEADER_HIDE_SUGGESTIONS_BUTTON));
  header_toggle_button_->SetAccessibleName(l10n_util::GetStringFUTF16(
      IDS_ACC_HEADER_HIDE_SUGGESTIONS_BUTTON, header_text_));

  // The "toggled" button state corresponds with the group being hidden.
  // The button's action is therefore to Show the group, when clicked.
  header_toggle_button_->SetToggledImageModel(
      views::Button::STATE_NORMAL, ui::ImageModel::FromImageSkia(arrow_down));
  header_toggle_button_->SetToggledTooltipText(
      l10n_util::GetStringUTF16(IDS_TOOLTIP_HEADER_SHOW_SUGGESTIONS_BUTTON));
  header_toggle_button_->SetToggledAccessibleName(l10n_util::GetStringFUTF16(
      IDS_ACC_HEADER_SHOW_SUGGESTIONS_BUTTON, header_text_));

  views::FocusRing::Get(header_toggle_button_)->SchedulePaint();

  // It's a little hokey that we're stealing the logic for the background
  // color from OmniboxResultView. If we start doing this is more than just
  // one place, we should introduce a more elegant abstraction here.
  if (!OmniboxFieldTrial::IsChromeRefreshSuggestIconsEnabled()) {
    SetBackground(OmniboxResultView::GetPopupCellBackground(this, part_state));
  }
}

void OmniboxHeaderView::HeaderToggleButtonPressed() {
  popup_view_->model()->OpenSelection(GetHeaderSelection(), base::TimeTicks());
  // The PrefChangeRegistrar will update the actual button toggle state.
}

void OmniboxHeaderView::SetSuggestionGroupVisibility(
    bool suggestion_group_hidden) {
  suggestion_group_hidden_ = suggestion_group_hidden;

  NotifyAccessibilityEvent(ax::mojom::Event::kExpandedChanged, true);

  // Because this view doesn't have true focus (it stays on the textfield),
  // we also need to manually announce state changes.
  GetViewAccessibility().AnnounceText(l10n_util::GetStringFUTF16(
      suggestion_group_hidden_ ? IDS_ACC_HEADER_SECTION_HIDDEN
                               : IDS_ACC_HEADER_SECTION_SHOWN,
      header_text_));

  header_toggle_button_->SetToggled(suggestion_group_hidden_);
}

// Convenience method to get the OmniboxPopupSelection for this view.
OmniboxPopupSelection OmniboxHeaderView::GetHeaderSelection() const {
  return OmniboxPopupSelection(model_index_,
                               OmniboxPopupSelection::FOCUSED_BUTTON_HEADER);
}

BEGIN_METADATA(OmniboxHeaderView, views::View)
ADD_READONLY_PROPERTY_METADATA(OmniboxPopupSelection, HeaderSelection)
END_METADATA