chrome/browser/ui/views/autofill/popup/popup_cell_utils.h

// 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_VIEWS_AUTOFILL_POPUP_POPUP_CELL_UTILS_H_
#define CHROME_BROWSER_UI_VIEWS_AUTOFILL_POPUP_POPUP_CELL_UTILS_H_

#include <memory>

#include "base/memory/weak_ptr.h"
#include "components/autofill/core/browser/ui/suggestion.h"
#include "ui/gfx/vector_icon_types.h"

namespace views {
class View;
class Label;
class BoxLayout;
class ImageView;
}  // namespace views

namespace autofill {
class AutofillPopupController;
class PopupCellView;
}  // namespace autofill

namespace gfx {
class Insets;
}

namespace autofill::popup_cell_utils {

// Returns the padding for a content cell.
//
// For content cells that make up the entire Autofill popup row (i.e. there is
// no control element), the following reasoning applies:
// * If `kAutofillShowAutocompleteDeleteButton` is on, then there is padding
//   with distance `DISTANCE_CONTENT_LIST_VERTICAL_SINGLE` between the edge of
//   the Autofill popup row and the start of the content cell.
// * In addition, there is also padding inside the content cell. Together, these
//   two paddings need to add up to `PopupBaseView::GetHorizontalMargin`, since
//   to ensure that the content inside the content cell is aligned with the
//   popup bubble's arrow.
// * Similarly, the right padding of the content cell needs to be adjusted.
//
//           / \
//          /   \
//         /     \
//        / arrow \
// ┌─────/         \────────────────────────┐
// │  ┌──────────────────────────────────┐  │
// │  │  ┌─────────┐ ┌────────────────┐  │  │
// ├──┼──┤         │ │                │  │  │
// ├──┤▲ │  Icon   │ │ Text labels    │  │  │
// │▲ │| │         │ │                │  │  │
// ││ ││ └─────────┘ └────────────────┘  │  │
// ││ └┼─────────────────────────────────┘  │
// └┼──┼────────────────────────────────────┘
//  │  │
//  │  PopupBaseView::GetHorizontalMargin()
//  │
//  DISTANCE_CONTENT_LIST_VERTICAL_SINGLE
//
// If the popup row has a control element, then the adjustment does not need
// to be made for the right padding, since the right side of the content cell
// borders another cell and not the right padding area of the popup row.
gfx::Insets GetMarginsForContentCell(bool has_control_element);

std::u16string GetVoiceOverStringFromSuggestion(const Suggestion& suggestion);

std::unique_ptr<views::ImageView> GetIconImageView(
    const Suggestion& suggestion);

std::unique_ptr<views::ImageView> GetTrailingIconImageView(
    const Suggestion& suggestion);

// Adds a spacer with `spacer_width` to `view`. `layout` must be the
// LayoutManager of `view`.
void AddSpacerWithSize(views::View& view,
                       views::BoxLayout& layout,
                       int spacer_width,
                       bool resize);

// Creates the table in which all the Autofill suggestion content apart from
// leading and trailing icons is contained and adds it to `content_view`.
// It registers `main_text_label`, `minor_text_label`, and `description_label`
// with `content_view` for tracking, but assumes that the labels inside of of
// `subtext_views` have already been registered for tracking with
// `content_view`.
void AddSuggestionContentTableToView(
    std::unique_ptr<views::Label> main_text_label,
    std::unique_ptr<views::Label> minor_text_label,
    std::unique_ptr<views::Label> description_label,
    std::vector<std::unique_ptr<views::View>> subtext_views,
    PopupCellView& content_view);

// Creates the content structure shared by autocomplete, address, credit card,
// and password suggestions.
// - `minor_text_label`, `description_label`, and `subtext_labels` may all be
// null or empty.
// - `content_view` is the (assumed to be empty) view to which the content
// structure for the `suggestion` is added.
void AddSuggestionContentToView(
    const Suggestion& suggestion,
    std::unique_ptr<views::Label> main_text_label,
    std::unique_ptr<views::Label> minor_text_label,
    std::unique_ptr<views::Label> description_label,
    std::vector<std::unique_ptr<views::View>> subtext_views,
    PopupCellView& content_view);

void FormatLabel(views::Label& label,
                 const Suggestion::Text& text,
                 base::WeakPtr<const AutofillPopupController> controller);

// Creates a label for the suggestion's main text.
std::unique_ptr<views::Label> CreateMainTextLabel(
    const Suggestion::Text& main_text,
    int text_style);

// Creates a label for the suggestion's minor text.
std::unique_ptr<views::Label> CreateMinorTextLabel(
    const Suggestion::Text& minor_text);

std::vector<std::unique_ptr<views::View>> CreateAndTrackSubtextViews(
    PopupCellView& content_view,
    base::WeakPtr<AutofillPopupController> controller,
    int line_number);

std::unique_ptr<views::Label> CreateDescriptionLabel(
    PopupCellView& content_view,
    base::WeakPtr<AutofillPopupController> controller,
    int line_number);

// Adds the callbacks for the content area to `content_view`.
void AddCallbacksToContentView(
    base::WeakPtr<AutofillPopupController> controller,
    int line_number,
    PopupCellView& content_view);

void AddSuggestionStrategyContentCellChildren(
    PopupCellView* view,
    base::WeakPtr<AutofillPopupController> controller,
    int line_number);

std::unique_ptr<views::ImageView> ImageViewFromVectorIcon(
    const gfx::VectorIcon& vector_icon,
    int icon_size);

}  // namespace autofill::popup_cell_utils

#endif  // CHROME_BROWSER_UI_VIEWS_AUTOFILL_POPUP_POPUP_CELL_UTILS_H_