#include <ToastBus.h>
Inherits AZ::EBusTraits.
|
using | BusIdType = ToastRequestBusId |
|
|
virtual void | HideToastNotification (const ToastId &toastId)=0 |
|
virtual ToastId | ShowToastNotification (const AzQtComponents::ToastConfiguration &toastConfiguration)=0 |
|
virtual ToastId | ShowToastAtCursor (const AzQtComponents::ToastConfiguration &toastConfiguration)=0 |
|
virtual ToastId | ShowToastAtPoint (const QPoint &screenPosition, const QPointF &anchorPoint, const AzQtComponents::ToastConfiguration &)=0 |
|
|
static const AZ::EBusHandlerPolicy | HandlerPolicy = AZ::EBusHandlerPolicy::Multiple |
|
static const AZ::EBusAddressPolicy | AddressPolicy = AZ::EBusAddressPolicy::ById |
|
An EBus used to hide or show toast notifications. Generally, these request are handled by a ToastNotificationsView that has been created with a specific ToastRequestBusId e.g. AZ_CRC("ExampleToastNotificationView")
◆ HideToastNotification()
virtual void AzToolsFramework::ToastRequests::HideToastNotification |
( |
const ToastId & |
toastId | ) |
|
|
pure virtual |
Hide a toast notification widget.
- Parameters
-
toastId | The toast notification's ToastId |
◆ ShowToastAtCursor()
virtual ToastId AzToolsFramework::ToastRequests::ShowToastAtCursor |
( |
const AzQtComponents::ToastConfiguration & |
toastConfiguration | ) |
|
|
pure virtual |
Show a toast notification with the specified toast configuration at the current moust cursor location.
- Parameters
-
toastConfiguration | The toast configuration |
- Returns
- a ToastId
◆ ShowToastAtPoint()
virtual ToastId AzToolsFramework::ToastRequests::ShowToastAtPoint |
( |
const QPoint & |
screenPosition, |
|
|
const QPointF & |
anchorPoint, |
|
|
const AzQtComponents::ToastConfiguration & |
|
|
) |
| |
|
pure virtual |
Show a toast notification with the specified toast configuration at the specified location.
- Parameters
-
screenPosition | The screen position |
anchorPoint | The anchorPoint for the toast notification widget |
toastConfiguration | The toast configuration |
- Returns
- a ToastId
◆ ShowToastNotification()
virtual ToastId AzToolsFramework::ToastRequests::ShowToastNotification |
( |
const AzQtComponents::ToastConfiguration & |
toastConfiguration | ) |
|
|
pure virtual |
Show a toast notification with the specified toast configuration. When handled by a ToastNotificationsView, notifications are queued and presented to the user in sequence.
- Parameters
-
toastConfiguration | The toast configuration |
- Returns
- a ToastId
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/UI/Notifications/ToastBus.h