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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_BASE_MODELS_COMBOBOX_MODEL_H_
#define UI_BASE_MODELS_COMBOBOX_MODEL_H_
#include <optional>
#include <string>
#include "base/component_export.h"
#include "base/observer_list.h"
#include "ui/color/color_id.h"
namespace ui {
class ComboboxModelObserver;
class ImageModel;
// A data model for a combo box.
class COMPONENT_EXPORT(UI_BASE) ComboboxModel {
public:
// Determines if selected combobox items should display a checkmark.
enum class ItemCheckmarkConfig {
kDefault, // Use the OS-specific value of `check_selected_combobox_item`.
kDisabled, // Hide the checkmark.
kEnabled // Show the checkmark.
};
ComboboxModel();
virtual ~ComboboxModel();
// Returns the number of items in the combo box.
virtual size_t GetItemCount() const = 0;
// Returns the string at the specified index.
virtual std::u16string GetItemAt(size_t index) const = 0;
// Returns the secondary string at the specified index. Secondary strings are
// displayed in a second line inside every menu item.
virtual std::u16string GetDropDownSecondaryTextAt(size_t index) const;
// Gets the icon for the item at the specified index. ImageModel is empty if
// there is no icon.
virtual ImageModel GetIconAt(size_t index) const;
// Gets the icon for the item at |index|. ImageModel is empty if there is no
// icon. By default, it returns GetIconAt(index).
virtual ImageModel GetDropDownIconAt(size_t index) const;
// Should return true if the item at |index| is a non-selectable separator
// item.
virtual bool IsItemSeparatorAt(size_t index) const;
// TODO(pbos): Consider replacing this (and IsItemSeparatorAt) with something
// that either returns or maps well to MenuModel::ItemType.
virtual bool IsItemTitleAt(size_t index) const;
// The index of the item that is selected by default (before user
// interaction).
virtual std::optional<size_t> GetDefaultIndex() const;
// Returns true if the item at |index| is enabled.
virtual bool IsItemEnabledAt(size_t index) const;
// Returns the config that determines whether selected combobox items should
// display a checkmark.
virtual ItemCheckmarkConfig GetCheckmarkConfig() const;
// Adds/removes an observer.
void AddObserver(ComboboxModelObserver* observer);
void RemoveObserver(ComboboxModelObserver* observer);
// The foreground color of the dropdown. If not overridden, this returns
// std::nullopt and the default color will be used.
virtual std::optional<ui::ColorId> GetDropdownForegroundColorIdAt(
size_t index) const;
// The background color of the dropdown. If not overridden, this returns
// std::nullopt and the default color will be used.
virtual std::optional<ui::ColorId> GetDropdownBackgroundColorIdAt(
size_t index) const;
// The hover / selected color for the dropdown. If not overridden, this
// returns std::nullopt and the default color will be used.
virtual std::optional<ui::ColorId> GetDropdownSelectedBackgroundColorIdAt(
size_t index) const;
protected:
base::ObserverList<ui::ComboboxModelObserver>& observers() {
return observers_;
}
private:
base::ObserverList<ui::ComboboxModelObserver> observers_;
};
} // namespace ui
#endif // UI_BASE_MODELS_COMBOBOX_MODEL_H_
|
