FUICommandDragDropOp Class Reference

#include <UICommandDragDropOp.h>

Inheritance diagram for FUICommandDragDropOp:

Public Member Functions
	FUICommandDragDropOp (FName InItemName, EMultiBlockType InBlockType, bool bInIsDraggingSection, FName InOriginMultiBox, TSharedPtr< SWidget > InCustomDecorator, FVector2D DecoratorOffset)
void	SetOnDropNotification (FSimpleDelegate InOnDropNotification)
virtual SLATE_API TSharedPtr< SWidget >	GetDefaultDecorator () const override
virtual SLATE_API void	OnDragged (const class FDragDropEvent &DragDropEvent) override
virtual SLATE_API void	OnDrop (bool bDropWasHandled, const FPointerEvent &MouseEvent) override
Public Member Functions inherited from FDragDropOperation
SLATECORE_API	FDragDropOperation ()
virtual SLATECORE_API	~FDragDropOperation ()
template<class TType >
bool	IsOfType () const
virtual bool	AffectedByPointerEvent (const FPointerEvent &PointerEvent)
virtual SLATECORE_API FCursorReply	OnCursorQuery ()
virtual FVector2D	GetDecoratorPosition () const
virtual SLATECORE_API void	SetDecoratorVisibility (bool bVisible)
virtual bool	IsExternalOperation () const
virtual bool	IsWindowlessOperation () const
SLATECORE_API void	SetCursorOverride (TOptional< EMouseCursor::Type > CursorType)
virtual bool	IsOfTypeImpl (const FString &Type) const
Public Member Functions inherited from TSharedFromThis< FDragDropOperation >
TSharedRef< FDragDropOperation, Mode >	AsShared ()
TSharedRef< FDragDropOperation const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FDragDropOperation, Mode >	AsWeak ()
TWeakPtr< FDragDropOperation const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static SLATE_API TSharedRef< FUICommandDragDropOp >	New (FName InItemName, EMultiBlockType InBlockType, bool bInIsDraggingSection, FName InOriginMultiBox, TSharedPtr< SWidget > CustomDectorator, FVector2D DecoratorOffset)

Public Attributes
FName	ItemName
EMultiBlockType	BlockType
bool	bIsDraggingSection
FName	OriginMultiBox
TSharedPtr< SWidget >	CustomDecorator
FVector2D	Offset
FSimpleDelegate	OnDropNotification

Additional Inherited Members
Protected Member Functions inherited from FDragDropOperation
virtual SLATECORE_API void	Construct ()
SLATECORE_API void	CreateCursorDecoratorWindow ()
SLATECORE_API void	DestroyCursorDecoratorWindow ()
virtual TSharedPtr< FDragDropOperation >	ConvertTo (const FString &TypeId)
Protected Member Functions inherited from TSharedFromThis< FDragDropOperation >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FDragDropOperation >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)
Protected Attributes inherited from FDragDropOperation
bool	bCreateNewWindow
TSharedPtr< SWindow >	CursorDecoratorWindow
TOptional< EMouseCursor::Type >	MouseCursor
TOptional< EMouseCursor::Type >	MouseCursorOverride

Detailed Description

A drag drop operation for UI Commands

Constructor & Destructor Documentation

FUICommandDragDropOp()

FUICommandDragDropOp::FUICommandDragDropOp ( FName  InItemName, EMultiBlockType  InBlockType, bool  bInIsDraggingSection, FName  InOriginMultiBox, TSharedPtr< SWidget >  InCustomDecorator, FVector2D  DecoratorOffset  )

inline

Member Function Documentation

GetDefaultDecorator()

TSharedPtr< SWidget > FUICommandDragDropOp::GetDefaultDecorator ( ) const

overridevirtual

FDragDropOperation interface

Reimplemented from FDragDropOperation.

New()

TSharedRef< FUICommandDragDropOp > FUICommandDragDropOp::New ( FName  InItemName, EMultiBlockType  InBlockType, bool  bInIsDraggingSection, FName  InOriginMultiBox, TSharedPtr< SWidget >  CustomDectorator, FVector2D  DecoratorOffset  )

static

OnDragged()

void FUICommandDragDropOp::OnDragged ( const class FDragDropEvent &  DragDropEvent )

overridevirtual

Called when the mouse was moved during a drag and drop operation

Parameters

DragDropEvent

The event that describes this drag drop operation.

Reimplemented from FDragDropOperation.

OnDrop()

void FUICommandDragDropOp::OnDrop ( bool  bDropWasHandled, const FPointerEvent &  MouseEvent  )

overridevirtual

Invoked when the drag and drop operation has ended.

Parameters

bDropWasHandled	true when the drop was handled by some widget; false otherwise
MouseEvent	The mouse event which caused the on drop to be called.

Reimplemented from FDragDropOperation.

SetOnDropNotification()

void FUICommandDragDropOp::SetOnDropNotification ( FSimpleDelegate  InOnDropNotification )

inline

Sets a delegate that will be called when the command is dropped

Member Data Documentation

bIsDraggingSection

bool FUICommandDragDropOp::bIsDraggingSection

UI entry being dragged is a section header or section separator

BlockType

EMultiBlockType FUICommandDragDropOp::BlockType

UI entry type being dragged

CustomDecorator

TSharedPtr<SWidget> FUICommandDragDropOp::CustomDecorator

Custom decorator to display

ItemName

FName FUICommandDragDropOp::ItemName

UI entry being dragged

Offset

FVector2D FUICommandDragDropOp::Offset

Offset from the cursor where the decorator should be displayed

OnDropNotification

FSimpleDelegate FUICommandDragDropOp::OnDropNotification

Delegate called when the command is dropped

OriginMultiBox

FName FUICommandDragDropOp::OriginMultiBox

Multibox the UI command was dragged from if any

---

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

• Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandDragDropOp.h
• Engine/Source/Runtime/Slate/Private/Framework/Commands/UICommandDragDropOp.cpp