File: capture_mode_menu_group.cc

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 (513 lines) | stat: -rw-r--r-- 18,905 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
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "ash/capture_mode/capture_mode_menu_group.h"

#include <algorithm>
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include <vector>

#include "ash/capture_mode/capture_mode_constants.h"
#include "ash/capture_mode/capture_mode_util.h"
#include "ash/resources/vector_icons/vector_icons.h"
#include "ash/strings/grit/ash_strings.h"
#include "ash/style/ash_color_id.h"
#include "ash/style/color_util.h"
#include "ash/style/style_util.h"
#include "base/memory/raw_ptr.h"
#include "ui/accessibility/ax_enums.mojom-shared.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/metadata/metadata_impl_macros.h"
#include "ui/base/models/image_model.h"
#include "ui/gfx/paint_vector_icon.h"
#include "ui/gfx/vector_icon_types.h"
#include "ui/views/accessibility/view_accessibility.h"
#include "ui/views/controls/button/button.h"
#include "ui/views/controls/highlight_path_generator.h"
#include "ui/views/controls/image_view.h"
#include "ui/views/controls/label.h"
#include "ui/views/layout/box_layout.h"

namespace ash {

namespace {

constexpr auto kMenuGroupPadding = gfx::Insets::VH(8, 0);

constexpr auto kOptionPadding = gfx::Insets::VH(8, 16);
constexpr auto kIndentedOptionPadding = gfx::Insets::TLBR(8, 52, 8, 16);

constexpr auto kMenuItemPadding = gfx::Insets::VH(10, 16);
constexpr auto kIndentedMenuItemPadding = gfx::Insets::TLBR(10, 52, 10, 16);

constexpr int kSpaceBetweenMenuItem = 0;

void SetInkDropForButton(views::Button* button) {
  StyleUtil::SetUpInkDropForButton(button, gfx::Insets(),
                                   /*highlight_on_hover=*/false,
                                   /*highlight_on_focus=*/false);
  views::InstallRectHighlightPathGenerator(button);
}

// Configures the size and visibility of the given `icon_view`.
void ConfigureIconView(views::ImageView* icon_view, bool is_visible) {
  DCHECK(icon_view);
  icon_view->SetImageSize(capture_mode::kSettingsIconSize);
  icon_view->SetPreferredSize(capture_mode::kSettingsIconSize);
  icon_view->SetVisible(is_visible);
}

}  // namespace

// -----------------------------------------------------------------------------
// CaptureModeMenuHeader:

// The header of the menu group, which has an icon and a text label. Not user
// interactable.
class CaptureModeMenuHeader
    : public views::View,
      public CaptureModeSessionFocusCycler::HighlightableView {
  METADATA_HEADER(CaptureModeMenuHeader, views::View)

 public:
  CaptureModeMenuHeader(const gfx::VectorIcon& icon,
                        std::u16string header_label,
                        bool managed_by_policy)
      : icon_view_(AddChildView(std::make_unique<views::ImageView>())),
        label_view_(AddChildView(
            std::make_unique<views::Label>(std::move(header_label)))),
        managed_icon_view_(
            managed_by_policy
                ? AddChildView(std::make_unique<views::ImageView>())
                : nullptr) {
    icon_view_->SetImageSize(capture_mode::kSettingsIconSize);
    icon_view_->SetPreferredSize(capture_mode::kSettingsIconSize);
    icon_view_->SetImage(
        ui::ImageModel::FromVectorIcon(icon, kColorAshButtonIconColor));

    if (managed_icon_view_) {
      managed_icon_view_->SetImageSize(capture_mode::kSettingsIconSize);
      managed_icon_view_->SetPreferredSize(capture_mode::kSettingsIconSize);
      managed_icon_view_->SetImage(ui::ImageModel::FromVectorIcon(
          kCaptureModeManagedIcon, kColorAshIconColorSecondary));
      managed_icon_view_->SetTooltipText(
          l10n_util::GetStringUTF16(IDS_ASH_SCREEN_CAPTURE_MANAGED_BY_POLICY));
    }

    SetBorder(views::CreateEmptyBorder(capture_mode::kSettingsMenuBorderSize));
    capture_mode_util::ConfigLabelView(label_view_);
    auto* box_layout = capture_mode_util::CreateAndInitBoxLayoutForView(this);
    box_layout->SetFlexForView(label_view_, 1);

    GetViewAccessibility().SetRole(ax::mojom::Role::kHeader);
    GetViewAccessibility().SetName(std::u16string(GetHeaderLabel()));
  }

  CaptureModeMenuHeader(const CaptureModeMenuHeader&) = delete;
  CaptureModeMenuHeader& operator=(const CaptureModeMenuHeader&) = delete;
  ~CaptureModeMenuHeader() override = default;

  bool is_managed_by_policy() const { return !!managed_icon_view_; }

  std::u16string_view GetHeaderLabel() const { return label_view_->GetText(); }

  // CaptureModeSessionFocusCycler::HighlightableView:
  views::View* GetView() override { return this; }

 private:
  raw_ptr<views::ImageView> icon_view_;
  raw_ptr<views::Label> label_view_;
  // `nullptr` if the menu group is not for a setting that is managed by a
  // policy.
  raw_ptr<views::ImageView> managed_icon_view_;
};

BEGIN_METADATA(CaptureModeMenuHeader)
END_METADATA

// -----------------------------------------------------------------------------
// CaptureModeMenuItem:

// A button which has a text label. Its behavior on click can be customized.
// For selecting folder, a folder window will be opened on click.
class CaptureModeMenuItem
    : public views::Button,
      public CaptureModeSessionFocusCycler::HighlightableView {
  METADATA_HEADER(CaptureModeMenuItem, views::Button)

 public:
  // If `indented` is true, the content of this menu item will have some extra
  // padding from the left so that it appears indented. This is useful when this
  // item is added to a group that has a header, and it's desired to make it
  // appear to be pushed inside under the header.
  CaptureModeMenuItem(views::Button::PressedCallback callback,
                      std::u16string item_label,
                      bool indented,
                      bool enabled)
      : views::Button(std::move(callback)),
        label_view_(AddChildView(
            std::make_unique<views::Label>(std::move(item_label)))) {
    SetBorder(views::CreateEmptyBorder(indented ? kIndentedMenuItemPadding
                                                : kMenuItemPadding));
    capture_mode_util::ConfigLabelView(label_view_);
    capture_mode_util::CreateAndInitBoxLayoutForView(this);
    SetInkDropForButton(this);
    GetViewAccessibility().SetIsLeaf(true);
    GetViewAccessibility().SetName(std::u16string(label_view_->GetText()));
    SetEnabled(enabled);
  }

  CaptureModeMenuItem(const CaptureModeMenuItem&) = delete;
  CaptureModeMenuItem& operator=(const CaptureModeMenuItem&) = delete;
  ~CaptureModeMenuItem() override = default;

  // CaptureModeSessionFocusCycler::HighlightableView:
  views::View* GetView() override { return this; }

 private:
  raw_ptr<views::Label> label_view_;
};

BEGIN_METADATA(CaptureModeMenuItem)
END_METADATA

// -----------------------------------------------------------------------------
// CaptureModeOption:

// A button which represents an option of the menu group. It has a text label
// and a checked icon. The checked icon will be shown on button click and any
// other option's checked icon will be set to invisible in the meanwhile. One
// and only one checked icon is visible in the menu group.
class CaptureModeOption
    : public views::Button,
      public CaptureModeSessionFocusCycler::HighlightableView {
  METADATA_HEADER(CaptureModeOption, views::Button)

 public:
  // If `indented` is true, the content of this option will have some extra
  // padding from the left so that it appears indented. This is useful when this
  // option is added to a group that has a header, and it's desired to make it
  // appear to be pushed inside under the header.
  CaptureModeOption(views::Button::PressedCallback callback,
                    const gfx::VectorIcon* option_icon,
                    std::u16string option_label,
                    int option_id,
                    bool checked,
                    bool enabled,
                    bool indented)
      : views::Button(std::move(callback)),
        option_icon_(option_icon),
        option_icon_view_(
            option_icon_ ? AddChildView(std::make_unique<views::ImageView>())
                         : nullptr),
        label_view_(AddChildView(
            std::make_unique<views::Label>(std::move(option_label)))),
        checked_icon_view_(AddChildView(std::make_unique<views::ImageView>())),
        id_(option_id) {
    if (option_icon_view_)
      ConfigureIconView(option_icon_view_, /*is_visible=*/true);
    ConfigureIconView(checked_icon_view_, /*is_visible=*/checked);
    SetBorder(views::CreateEmptyBorder(indented ? kIndentedOptionPadding
                                                : kOptionPadding));
    capture_mode_util::ConfigLabelView(label_view_);
    auto* box_layout = capture_mode_util::CreateAndInitBoxLayoutForView(this);
    box_layout->SetFlexForView(label_view_, 1);
    SetInkDropForButton(this);
    GetViewAccessibility().SetIsLeaf(true);
    GetViewAccessibility().SetName(std::u16string(GetOptionLabel()));
    GetViewAccessibility().SetRole(ax::mojom::Role::kRadioButton);

    SetEnabled(enabled);
  }

  CaptureModeOption(const CaptureModeOption&) = delete;
  CaptureModeOption& operator=(const CaptureModeOption&) = delete;
  ~CaptureModeOption() override = default;

  int id() const { return id_; }

  std::u16string_view GetOptionLabel() const { return label_view_->GetText(); }

  // If `icon` is `nullptr`, removes the `option_icon_view_` (if any).
  // Otherwise, a new image view will be created for the `option_icon_view_` (if
  // needed), and the given `icon` will be set.
  void SetOptionIcon(const gfx::VectorIcon* icon) {
    option_icon_ = icon;

    if (!option_icon_) {
      if (option_icon_view_) {
        RemoveChildViewT(option_icon_view_.get());
        option_icon_view_ = nullptr;
      }
      return;
    }

    if (!option_icon_view_) {
      option_icon_view_ =
          AddChildViewAt(std::make_unique<views::ImageView>(), 0);
      ConfigureIconView(option_icon_view_, /*is_visible=*/true);
    }

    MaybeUpdateOptionIconState();
  }

  void SetOptionLabel(std::u16string option_label) {
    GetViewAccessibility().SetName(option_label);
    label_view_->SetText(std::move(option_label));
  }

  void SetOptionChecked(bool checked) {
    checked_icon_view_->SetVisible(checked);
    GetViewAccessibility().SetCheckedState(
        checked ? ax::mojom::CheckedState::kTrue
                : ax::mojom::CheckedState::kFalse);
  }

  bool IsOptionChecked() { return checked_icon_view_->GetVisible(); }

  // views::Button:
  void StateChanged(ButtonState old_state) override {
    // Don't trigger `UpdateState` when the option is not added to the views
    // hierarchy yet, since we need to get the color from the widget's color
    // provider. When the option is added to the view hierarchy,
    // `OnThemeChanged` will be triggered and then `UpdateState` will be called.
    if (GetWidget())
      UpdateState();
  }

  void OnThemeChanged() override {
    views::Button::OnThemeChanged();
    UpdateState();
  }

  // CaptureModeSessionFocusCycler::HighlightableView:
  views::View* GetView() override { return this; }

 private:
  // Dims out the label and the checked icon if this view is disabled.
  void UpdateState() {
    MaybeUpdateOptionIconState();

    const bool is_disabled = GetState() == STATE_DISABLED;
    const auto* color_provider = GetColorProvider();
    const auto label_enabled_color =
        color_provider->GetColor(kColorAshTextColorPrimary);
    label_view_->SetEnabledColor(
        is_disabled ? ColorUtil::GetDisabledColor(label_enabled_color)
                    : label_enabled_color);

    const auto checked_icon_enabled_color =
        color_provider->GetColor(kColorAshButtonLabelColorBlue);
    checked_icon_view_->SetImage(ui::ImageModel::FromVectorIcon(
        kHollowCheckCircleIcon,
        is_disabled ? ColorUtil::GetDisabledColor(checked_icon_enabled_color)
                    : checked_icon_enabled_color));
  }

  void MaybeUpdateOptionIconState() {
    if (!option_icon_view_) {
      DCHECK(!option_icon_);
      return;
    }

    DCHECK(option_icon_);
    const bool is_disabled = GetState() == STATE_DISABLED;
    option_icon_view_->SetImage(ui::ImageModel::FromVectorIcon(
        *option_icon_, is_disabled ? kColorAshButtonIconDisabledColor
                                   : kColorAshButtonIconColor));
  }

  // An optional icon for the option. Non-null if present.
  raw_ptr<const gfx::VectorIcon> option_icon_ = nullptr;
  raw_ptr<views::ImageView> option_icon_view_ = nullptr;

  raw_ptr<views::Label> label_view_;
  raw_ptr<views::ImageView> checked_icon_view_;
  const int id_;
};

BEGIN_METADATA(CaptureModeOption)
END_METADATA

// -----------------------------------------------------------------------------
// CaptureModeMenuGroup:

CaptureModeMenuGroup::CaptureModeMenuGroup(
    Delegate* delegate,
    const gfx::Insets& inside_border_insets)
    : CaptureModeMenuGroup(delegate,
                           /*menu_header=*/nullptr,
                           inside_border_insets) {}

CaptureModeMenuGroup::CaptureModeMenuGroup(Delegate* delegate,
                                           const gfx::VectorIcon& header_icon,
                                           std::u16string header_label,
                                           bool managed_by_policy)
    : CaptureModeMenuGroup(
          delegate,
          std::make_unique<CaptureModeMenuHeader>(header_icon,
                                                  std::move(header_label),
                                                  managed_by_policy),
          kMenuGroupPadding) {}

CaptureModeMenuGroup::~CaptureModeMenuGroup() = default;

bool CaptureModeMenuGroup::IsManagedByPolicy() const {
  return menu_header_ && menu_header_->is_managed_by_policy();
}

void CaptureModeMenuGroup::AddOption(const gfx::VectorIcon* option_icon,
                                     std::u16string option_label,
                                     int option_id) {
  options_.push_back(
      options_container_->AddChildView(std::make_unique<CaptureModeOption>(
          base::BindRepeating(&CaptureModeMenuGroup::HandleOptionClick,
                              base::Unretained(this), option_id),
          option_icon, std::move(option_label), option_id,
          /*checked=*/delegate_->IsOptionChecked(option_id),
          /*enabled=*/delegate_->IsOptionEnabled(option_id),
          /*indented=*/!!menu_header_)));
}

void CaptureModeMenuGroup::DeleteOptions() {
  for (CaptureModeOption* option : options_)
    options_container_->RemoveChildViewT(option);
  options_.clear();
}

void CaptureModeMenuGroup::AddOrUpdateExistingOption(
    const gfx::VectorIcon* option_icon,
    std::u16string option_label,
    int option_id) {
  auto* option = GetOptionById(option_id);

  if (option) {
    option->SetOptionIcon(option_icon);
    option->SetOptionLabel(std::move(option_label));
    return;
  }

  AddOption(option_icon, std::move(option_label), option_id);
}

void CaptureModeMenuGroup::RefreshOptionsSelections() {
  for (ash::CaptureModeOption* option : options_) {
    option->SetOptionChecked(delegate_->IsOptionChecked(option->id()));
    option->SetEnabled(delegate_->IsOptionEnabled(option->id()));
  }
}

void CaptureModeMenuGroup::RemoveOptionIfAny(int option_id) {
  auto* option = GetOptionById(option_id);
  if (!option)
    return;

  options_container_->RemoveChildViewT(option);
  std::erase(options_, option);
}

void CaptureModeMenuGroup::AddMenuItem(views::Button::PressedCallback callback,
                                       std::u16string item_label,
                                       bool enabled) {
  menu_items_.push_back(
      views::View::AddChildView(std::make_unique<CaptureModeMenuItem>(
          std::move(callback), std::move(item_label),
          /*indented=*/!!menu_header_, enabled)));
}

bool CaptureModeMenuGroup::IsOptionChecked(int option_id) const {
  auto* option = GetOptionById(option_id);
  return option && option->IsOptionChecked();
}

views::View* CaptureModeMenuGroup::SetOptionCheckedForTesting(
    int option_id,
    bool checked) const {
  auto* option = GetOptionById(option_id);
  option->SetOptionChecked(checked);
  return option;
}

bool CaptureModeMenuGroup::IsOptionEnabled(int option_id) const {
  auto* option = GetOptionById(option_id);
  return option && option->GetEnabled();
}

void CaptureModeMenuGroup::AppendHighlightableItems(
    std::vector<CaptureModeSessionFocusCycler::HighlightableView*>&
        highlightable_items) {
  // The camera menu group can be hidden if there are no cameras connected. In
  // this case no items in this group should be highlightable.
  if (!GetVisible())
    return;

  if (menu_header_)
    highlightable_items.push_back(menu_header_);
  for (ash::CaptureModeOption* option : options_) {
    if (option->GetEnabled())
      highlightable_items.push_back(option);
  }
  for (ash::CaptureModeMenuItem* menu_item : menu_items_) {
    highlightable_items.push_back(menu_item);
  }
}

views::View* CaptureModeMenuGroup::GetOptionForTesting(int option_id) {
  return GetOptionById(option_id);
}

views::View* CaptureModeMenuGroup::GetSelectFolderMenuItemForTesting() {
  DCHECK_EQ(1u, menu_items_.size());
  return menu_items_[0];
}

std::u16string_view CaptureModeMenuGroup::GetOptionLabelForTesting(
    int option_id) const {
  auto* option = GetOptionById(option_id);
  DCHECK(option);
  return option->GetOptionLabel();
}

CaptureModeMenuGroup::CaptureModeMenuGroup(
    Delegate* delegate,
    std::unique_ptr<CaptureModeMenuHeader> menu_header,
    const gfx::Insets& inside_border_insets)
    : delegate_(delegate),
      menu_header_(menu_header ? AddChildView(std::move(menu_header))
                               : nullptr),
      options_container_(AddChildView(std::make_unique<views::View>())) {
  DCHECK(delegate_);
  options_container_->SetLayoutManager(std::make_unique<views::BoxLayout>(
      views::BoxLayout::Orientation::kVertical));
  SetLayoutManager(std::make_unique<views::BoxLayout>(
      views::BoxLayout::Orientation::kVertical, inside_border_insets,
      kSpaceBetweenMenuItem));
}

CaptureModeOption* CaptureModeMenuGroup::GetOptionById(int option_id) const {
  auto iter = std::ranges::find(options_, option_id, &CaptureModeOption::id);
  return iter == options_.end() ? nullptr : *iter;
}

void CaptureModeMenuGroup::HandleOptionClick(int option_id) {
  DCHECK(GetOptionById(option_id));

  // The order here matters. We need to tell the delegate first about a change
  // in the selection, before we refresh the checked icons, since for that we
  // need to query the delegate.
  delegate_->OnOptionSelected(option_id);
  RefreshOptionsSelections();
}

views::View* CaptureModeMenuGroup::menu_header() const {
  return menu_header_;
}

BEGIN_METADATA(CaptureModeMenuGroup)
END_METADATA

}  // namespace ash