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::DragAndDropItemViewEvents Class Referenceabstract

Inherits AzQtComponents::CommonDragAndDropBusTraits.

Public Member Functions

virtual int GetDragAndDropItemViewEventsPriority () const
 
bool Compare (const DragAndDropItemViewEvents *other) const
 Compare function required by BusHandlerOrderCompare = BusHandlerCompareDefault.
 
virtual void CanDropItemView (bool &, DragAndDropContextBase &)=0
 
virtual void DoDropItemView (bool &, DragAndDropContextBase &)=0
 

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

◆ CanDropItemView()

virtual void AzQtComponents::DragAndDropItemViewEvents::CanDropItemView ( bool &  ,
DragAndDropContextBase  
)
pure virtual

CanDropItemView is Sent on every mouse move to query whether the data in the context is acceptable to drop on a view item. Note: Set accepted to true if you wish to swallow this event and prevent lower priority listeners from responding. Conversely, always check accepted and return early if its already true. The context depends on the sender of the event, but should contain enough information to answer the CanDrop question. 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.

◆ DoDropItemView()

virtual void AzQtComponents::DragAndDropItemViewEvents::DoDropItemView ( bool &  ,
DragAndDropContextBase  
)
pure virtual

DoDropItemView is sent when a drag and drop action completes in an item view. See notes for CanDrop above.

◆ GetDragAndDropItemViewEventsPriority()

virtual int AzQtComponents::DragAndDropItemViewEvents::GetDragAndDropItemViewEventsPriority ( ) 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: