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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_QUICK_INSERT_VIEWS_QUICK_INSERT_SECTION_VIEW_H_
#define ASH_QUICK_INSERT_VIEWS_QUICK_INSERT_SECTION_VIEW_H_
#include <memory>
#include <string>
#include <vector>
#include "ash/ash_export.h"
#include "ash/quick_insert/quick_insert_search_result.h"
#include "base/containers/span.h"
#include "base/memory/raw_ptr.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/views/controls/link.h"
#include "ui/views/view.h"
namespace views {
class BoxLayoutView;
class Label;
} // namespace views
namespace ash {
class QuickInsertAssetFetcher;
class QuickInsertImageItemGridView;
class QuickInsertImageItemRowView;
class QuickInsertImageItemView;
class QuickInsertItemWithSubmenuView;
class QuickInsertItemView;
class QuickInsertListItemContainerView;
class QuickInsertListItemView;
class QuickInsertPreviewBubbleController;
class QuickInsertSubmenuController;
class QuickInsertTraversableItemContainer;
enum class QuickInsertActionType;
// View for a Quick Insert section with a title and related items.
class ASH_EXPORT QuickInsertSectionView : public views::View {
METADATA_HEADER(QuickInsertSectionView, views::View)
public:
using SelectResultCallback = base::RepeatingClosure;
// Describes the way local file results are visually presented.
enum class LocalFileResultStyle {
// Shown as list items with the name of the file as the label.
kList,
// Shown as a grid of thumbnail previews.
kGrid,
// Shown as a single row of thumbnail previews.
kRow,
};
explicit QuickInsertSectionView(
int section_width,
QuickInsertAssetFetcher* asset_fetcher,
QuickInsertSubmenuController* submenu_controller);
QuickInsertSectionView(const QuickInsertSectionView&) = delete;
QuickInsertSectionView& operator=(const QuickInsertSectionView&) = delete;
~QuickInsertSectionView() override;
// Creates an item based on `result` and adds it to the section view.
// `preview_controller` can be null if previews are not needed.
// `asset_fetcher` can be null for most result types.
// Both `preview_controller` and `asset_fetcher` must outlive the return
// value.
static std::unique_ptr<QuickInsertItemView> CreateItemFromResult(
const QuickInsertSearchResult& result,
QuickInsertPreviewBubbleController* preview_controller,
QuickInsertAssetFetcher* asset_fetcher,
int available_width,
LocalFileResultStyle local_file_result_style,
SelectResultCallback select_result_callback);
void AddTitleLabel(const std::u16string& title_text);
void AddTitleTrailingLink(const std::u16string& link_text,
const std::u16string& accessible_name,
views::Link::ClickedCallback link_callback);
// Adds a list item. These are displayed in a vertical list, each item
// spanning the width of the section.
QuickInsertListItemView* AddListItem(
std::unique_ptr<QuickInsertListItemView> list_item);
// Adds an image item to the section. These are displayed in a grid with two
// columns.
QuickInsertImageItemView* AddImageGridItem(
std::unique_ptr<QuickInsertImageItemView> image_item);
// Adds an image item to the section. These are displayed in a single row.
QuickInsertImageItemView* AddImageRowItem(
std::unique_ptr<QuickInsertImageItemView> image_item);
// Adds an item with submenu to the section.
QuickInsertItemWithSubmenuView* AddItemWithSubmenu(
std::unique_ptr<QuickInsertItemWithSubmenuView> item_with_submenu);
// Same as `CreateItemFromResult`, but additionally adds the item to this
// section.
QuickInsertItemView* AddResult(
const QuickInsertSearchResult& result,
QuickInsertPreviewBubbleController* preview_controller,
LocalFileResultStyle local_file_result_style,
SelectResultCallback select_result_callback);
void ClearItems();
// Returns the item to highlight to when navigating to this section from the
// top, or nullptr if the section is empty.
views::View* GetTopItem();
// Returns the item to highlight to when navigating to this section from the
// bottom, or nullptr if the section is empty.
views::View* GetBottomItem();
// Returns the item directly above `item`, or nullptr if there is no such item
// in the section.
views::View* GetItemAbove(views::View* item);
// Returns the item directly below `item`, or nullptr if there is no such item
// in the section.
views::View* GetItemBelow(views::View* item);
// Returns the item directly to the left of `item`, or nullptr if there is no
// such item in the section.
views::View* GetItemLeftOf(views::View* item);
// Returns the item directly to the right of `item`, or nullptr if there is no
// such item in the section.
views::View* GetItemRightOf(views::View* item);
// Must be called before creating an image row.
// `accessible_name` is the accessible name of the image row.
void SetImageRowProperties(std::u16string accessible_name,
base::RepeatingClosure more_items_button_callback,
std::u16string more_items_button_accessible_name);
const views::Label* title_label_for_testing() const { return title_label_; }
const views::Link* title_trailing_link_for_testing() const {
return title_trailing_link_;
}
views::Link* title_trailing_link_for_testing() {
return title_trailing_link_;
}
// TODO: b/322900302 - Figure out a nice way to access the item views for
// keyboard navigation (e.g. how to handle grid items).
base::span<const raw_ptr<QuickInsertItemView>> item_views() const {
return item_views_;
}
base::span<const raw_ptr<QuickInsertItemView>> item_views_for_testing()
const {
return item_views_;
}
views::View* GetImageRowMoreItemsButtonForTesting();
private:
struct ImageRowProperties {
std::u16string accessible_name;
base::RepeatingClosure more_items_button_callback;
std::u16string more_items_button_accessible_name;
ImageRowProperties();
~ImageRowProperties();
};
QuickInsertListItemContainerView* GetOrCreateListItemContainer();
QuickInsertImageItemGridView* GetOrCreateImageItemGrid();
QuickInsertImageItemRowView* GetOrCreateImageItemRow();
// Width available for laying out section items. This is needed to determine
// row and column widths for grid items in the section.
int section_width_ = 0;
// Container for the section title contents, which can have a title label and
// a trailing link.
raw_ptr<views::BoxLayoutView> title_container_ = nullptr;
raw_ptr<views::Label> title_label_ = nullptr;
raw_ptr<views::Link> title_trailing_link_ = nullptr;
std::vector<raw_ptr<QuickInsertTraversableItemContainer>> item_containers_;
raw_ptr<QuickInsertListItemContainerView> list_item_container_ = nullptr;
raw_ptr<QuickInsertImageItemGridView> image_item_grid_ = nullptr;
raw_ptr<QuickInsertImageItemRowView> image_item_row_ = nullptr;
// The views for each result item.
std::vector<raw_ptr<QuickInsertItemView>> item_views_;
// `asset_fetcher` outlives `this`.
raw_ptr<QuickInsertAssetFetcher> asset_fetcher_ = nullptr;
// `submenu_controller` outlives `this`.
raw_ptr<QuickInsertSubmenuController> submenu_controller_ = nullptr;
ImageRowProperties image_row_properties_;
};
} // namespace ash
#endif // ASH_QUICK_INSERT_VIEWS_QUICK_INSERT_SECTION_VIEW_H_
|