Open 3D Engine AzQtComponents API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzQtComponents::DragAndDropEvents Class Reference

Inherits AzQtComponents::CommonDragAndDropBusTraits.

Public Member Functions

virtual int GetDragAndDropEventsPriority () const
 
bool Compare (const DragAndDropEvents *other) const
 Compare function required by BusHandlerOrderCompare = BusHandlerCompareDefault.
 
virtual void DragEnter (QDragEnterEvent *, DragAndDropContextBase &)
 
virtual void DragMove (QDragMoveEvent *, DragAndDropContextBase &)
 Sent when a drag and drop action is in progress.
 
virtual void DragLeave (QDragLeaveEvent *)
 
virtual void Drop (QDropEvent *, DragAndDropContextBase &)
 Sent when a drag and drop action completes.
 
virtual void DropAtLocation (QDropEvent *, DragAndDropContextBase &, QString &)
 Sent when a drag and drop action completes. Contains a suggested destination path that can be overridden in the dialog.
 

Additional Inherited Members

- Public Types inherited from AzQtComponents::CommonDragAndDropBusTraits
using BusIdType = AZ::u32
 
- Static Public Attributes inherited from AzQtComponents::CommonDragAndDropBusTraits
static constexpr AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::MultipleAndOrdered
 
static constexpr AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 
static constexpr const int s_LowPriority = -10
 
static constexpr const int s_NormalPriority = 0
 Run this handler after the default handler.
 
static constexpr const int s_HighPriority = 10
 The default handler.
 

Member Function Documentation

◆ DragEnter()

virtual void AzQtComponents::DragAndDropEvents::DragEnter ( QDragEnterEvent *  ,
DragAndDropContextBase  
)
inlinevirtual

Sent when a drag and drop action enters a widget. The context is intentionally non const, so that higher level listeners can add additional contextual information such as decoding the data and caching it, or partially consuming the data.

◆ DragLeave()

virtual void AzQtComponents::DragAndDropEvents::DragLeave ( QDragLeaveEvent *  )
inlinevirtual

Sent when a drag and drop action leaves a widget. note that when drag leaves a widget, the context is not transmitted since there is no longer any context.

◆ GetDragAndDropEventsPriority()

virtual int AzQtComponents::DragAndDropEvents::GetDragAndDropEventsPriority ( ) const
inlinevirtual

Override this with one of the above priority values (or a number between them) to control what order your handler gets invoked relative to the other handlers.


The documentation for this class was generated from the following file: