stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 1 | // Copyright 2024 The Chromium Authors |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
stluong | 8fc2b9f | 2024-08-23 23:01:13 | [diff] [blame] | 5 | #ifndef CHROME_BROWSER_UI_TOASTS_API_TOAST_SPECIFICATION_H_ |
| 6 | #define CHROME_BROWSER_UI_TOASTS_API_TOAST_SPECIFICATION_H_ |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 7 | |
| 8 | #include <memory> |
| 9 | #include <optional> |
| 10 | |
| 11 | #include "base/functional/callback.h" |
| 12 | #include "base/functional/callback_forward.h" |
| 13 | #include "base/memory/raw_ref.h" |
| 14 | #include "base/types/pass_key.h" |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 15 | #include "ui/gfx/vector_icon_types.h" |
| 16 | |
| 17 | // ToastSpecification details what the toast should contain when shown. |
| 18 | class ToastSpecification { |
| 19 | public: |
| 20 | class Builder final { |
| 21 | public: |
| 22 | Builder(const gfx::VectorIcon& icon, int body_string_id); |
Shakti Sahu | 226b102b | 2025-03-13 23:28:55 | [diff] [blame^] | 23 | explicit Builder(const gfx::VectorIcon& icon); |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 24 | Builder(const Builder& other) = delete; |
| 25 | Builder& operator=(const Builder&) = delete; |
| 26 | |
| 27 | ~Builder(); |
| 28 | |
| 29 | // Adds a "X" close button to the toast. However, if the toast have a menu, |
| 30 | // the close button will be a rounded dismiss button instead. |
| 31 | Builder& AddCloseButton(); |
| 32 | |
| 33 | // Adds a rounded action button toast with the `action_button_string_id` |
| 34 | // for the label. All toasts with an action button must also have a close |
| 35 | // button. |
| 36 | Builder& AddActionButton(int action_button_string_id, |
| 37 | base::RepeatingClosure closure); |
| 38 | |
| 39 | // Adds a three dot menu to the toast. Toasts with an action button are not |
| 40 | // allowed to have menu because they must have an "X" close button instead. |
Jan Keitel | 29b357c | 2024-11-07 17:30:55 | [diff] [blame] | 41 | // If the specification includes a menu, the `ToastParams` that are used |
| 42 | // to show the Toast must have a non-null `menu_model` member. |
| 43 | Builder& AddMenu(); |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 44 | |
Steven Luong | f444e6d | 2024-09-16 22:08:13 | [diff] [blame] | 45 | // Toasts by default are scoped to the active tab when they are triggered. |
| 46 | // Globally scoped toasts will not immediately dismiss when the user |
| 47 | // switches tabs or navigates to another site and will rely on timing out to |
| 48 | // dismiss. |
| 49 | Builder& AddGlobalScoped(); |
| 50 | |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 51 | std::unique_ptr<ToastSpecification> Build(); |
| 52 | |
| 53 | private: |
| 54 | void ValidateSpecification(); |
| 55 | |
| 56 | std::unique_ptr<ToastSpecification> toast_specification_; |
| 57 | }; |
| 58 | |
| 59 | ToastSpecification(base::PassKey<ToastSpecification::Builder>, |
| 60 | const gfx::VectorIcon& icon, |
| 61 | int string_id); |
Shakti Sahu | 226b102b | 2025-03-13 23:28:55 | [diff] [blame^] | 62 | ToastSpecification(base::PassKey<ToastSpecification::Builder>, |
| 63 | const gfx::VectorIcon& icon); |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 64 | ~ToastSpecification(); |
| 65 | |
| 66 | int body_string_id() const { return body_string_id_; } |
| 67 | const gfx::VectorIcon& icon() const { return *icon_; } |
| 68 | bool has_close_button() const { return has_close_button_; } |
| 69 | std::optional<int> action_button_string_id() const { |
| 70 | return action_button_string_id_; |
| 71 | } |
Charles Meng | ab13b8f6 | 2024-09-04 20:11:18 | [diff] [blame] | 72 | base::RepeatingClosure action_button_callback() const { |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 73 | return action_button_closure_; |
| 74 | } |
Jan Keitel | 29b357c | 2024-11-07 17:30:55 | [diff] [blame] | 75 | bool has_menu() const { return has_menu_; } |
Steven Luong | f444e6d | 2024-09-16 22:08:13 | [diff] [blame] | 76 | bool is_global_scope() const { return is_global_scope_; } |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 77 | |
| 78 | void AddCloseButton(); |
| 79 | void AddActionButton(int string_id, base::RepeatingClosure closure); |
Jan Keitel | 29b357c | 2024-11-07 17:30:55 | [diff] [blame] | 80 | void AddMenu(); |
Steven Luong | f444e6d | 2024-09-16 22:08:13 | [diff] [blame] | 81 | void AddGlobalScope(); |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 82 | |
| 83 | private: |
| 84 | const base::raw_ref<const gfx::VectorIcon> icon_; |
Shakti Sahu | 226b102b | 2025-03-13 23:28:55 | [diff] [blame^] | 85 | int body_string_id_ = 0; |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 86 | bool has_close_button_ = false; |
Jan Keitel | 29b357c | 2024-11-07 17:30:55 | [diff] [blame] | 87 | bool has_menu_ = false; |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 88 | std::optional<int> action_button_string_id_; |
| 89 | base::RepeatingClosure action_button_closure_; |
Steven Luong | f444e6d | 2024-09-16 22:08:13 | [diff] [blame] | 90 | bool is_global_scope_ = false; |
stluong | b287cbf3 | 2024-08-16 20:10:56 | [diff] [blame] | 91 | }; |
| 92 | |
stluong | 8fc2b9f | 2024-08-23 23:01:13 | [diff] [blame] | 93 | #endif // CHROME_BROWSER_UI_TOASTS_API_TOAST_SPECIFICATION_H_ |