UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SDragAndDropVerticalBox Class Reference

#include <SBoxPanel.h>

+ Inheritance diagram for SDragAndDropVerticalBox:

Public Types

enum class  EItemDropZone { AboveItem , BelowItem }
 
- Public Types inherited from SVerticalBox
using FScopedWidgetSlotArguments = SBoxPanel::FScopedWidgetSlotArguments< SVerticalBox::FSlot >
 

Public Member Functions

 DECLARE_DELEGATE_RetVal_FourParams (FReply, FOnDragAndDropVerticalBoxDragDetected, const FGeometry &, const FPointerEvent &, int32, SVerticalBox::FSlot *) DECLARE_DELEGATE_OneParam(FOnDragAndDropVerticalBoxDragEnter
 
FDragDropEvent const & DECLARE_DELEGATE_OneParam (FOnDragAndDropVerticalBoxDragLeave, FDragDropEvent const &)
 
 DECLARE_DELEGATE_RetVal_OneParam (FReply, FOnDragAndDropVerticalBoxDrop, FDragDropEvent const &)
 
 DECLARE_DELEGATE_RetVal_ThreeParams (TOptional< EItemDropZone >, FOnCanAcceptDrop, const FDragDropEvent &, SDragAndDropVerticalBox::EItemDropZone, SVerticalBox::FSlot *)
 
 DECLARE_DELEGATE_RetVal_FourParams (TOptional< EItemDropZone >, FOnCanAcceptDropAdvanced, const FDragDropEvent &, SDragAndDropVerticalBox::EItemDropZone, int32, SVerticalBox::FSlot *)
 
 DECLARE_DELEGATE_RetVal_FourParams (FReply, FOnAcceptDrop, const FDragDropEvent &, SDragAndDropVerticalBox::EItemDropZone, int32, SVerticalBox::FSlot *)
 
 SLATE_BEGIN_ARGS (SDragAndDropVerticalBox)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FOnCanAcceptDropAdvanced ConvertCanAcceptDropFn (const FOnCanAcceptDrop &LegacyDelegate)
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS SLATECORE_API void Construct (const FArguments &InArgs)
 
SDragAndDropVerticalBoxSetDropIndicator_Above (const FSlateBrush &InValue)
 
SDragAndDropVerticalBoxSetDropIndicator_Below (const FSlateBrush &InValue)
 
virtual SLATECORE_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATECORE_API void OnDragEnter (FGeometry const &MyGeometry, FDragDropEvent const &DragDropEvent) override
 
virtual SLATECORE_API void OnDragLeave (FDragDropEvent const &DragDropEvent) override
 
virtual SLATECORE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
virtual SLATECORE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
virtual SLATECORE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
- Public Member Functions inherited from SVerticalBox
 SLATE_BEGIN_ARGS (SVerticalBox)
 
FScopedWidgetSlotArguments AddSlot ()
 
FScopedWidgetSlotArguments InsertSlot (int32 Index=INDEX_NONE)
 
SLATECORE_API FSlotGetSlot (int32 SlotIndex)
 
SLATECORE_API const FSlotGetSlot (int32 SlotIndex) const
 
FORCENOINLINE SVerticalBox ()
 
SLATECORE_API void Construct (const FArguments &InArgs)
 
- Public Member Functions inherited from SBoxPanel
SLATECORE_API int32 RemoveSlot (const TSharedRef< SWidget > &SlotWidget)
 
SLATECORE_API void ClearChildren ()
 
int32 NumSlots () const
 
bool IsValidSlotIndex (int32 Index) const
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATECORE_API FChildrenGetChildren () override
 
- Public Member Functions inherited from SPanel
void Construct ()
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
 
virtual SLATECORE_API FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentStateGetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildrenGetAllChildren ()
 
virtual SLATECORE_API bool SupportsKeyboardFocus () const
 
virtual SLATECORE_API bool HasKeyboardFocus () const
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
virtual SLATECORE_API FString ToString () const
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassDataGetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget 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
 

Additional Inherited Members

- Static Public Member Functions inherited from SVerticalBox
static FSlot::FSlotArguments Slot ()
 
- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Protected Member Functions inherited from SBoxPanel
virtual SLATECORE_API FVector2D ComputeDesiredSize (float) const override
 
SLATECORE_API SBoxPanel ()
 
SLATECORE_API SBoxPanel (EOrientation InOrientation)
 
SLATECORE_API ~SBoxPanel ()
 
SLATECORE_API void SetOrientation (EOrientation InOrientation)
 
EOrientation GetOrientation () const
 
- Protected Member Functions inherited from SPanel
SLATECORE_API int32 PaintArrangedChildren (const FPaintArgs &Args, const FArrangedChildren &ArrangedChildren, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
SLATECORE_API SPanel ()
 
virtual SLATECORE_API ~SPanel ()
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual bool CustomPrepass (float LayoutScaleMultiplier)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::TypeGetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrushGetFocusBrush () const
 
virtual bool ComputeVolatility () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibilityAccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
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 SBoxPanel
TPanelChildren< FSlotChildren
 
EOrientation Orientation
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Detailed Description

A Vertical Box Panel. See SBoxPanel for more info.

Member Enumeration Documentation

◆ EItemDropZone

Where we are going to drop relative to the target item.

Enumerator
AboveItem 
BelowItem 

Member Function Documentation

◆ Construct()

void SDragAndDropVerticalBox::Construct ( const FArguments &  InArgs)

Handle this event to determine whether a drag and drop operation can be executed on top of the target row widget. Most commonly, this is used for previewing re-ordering and re-organization operations in lists or trees. e.g. A user is dragging one item into a different spot in the list or tree. This delegate will be called to figure out if we should give visual feedback on whether an item will successfully drop into the list. Perform a drop operation onto the target row widget Most commonly used for executing a re-ordering and re-organization operations in lists or trees. e.g. A user was dragging one item into a different spot in the list; they just dropped it. This is our chance to handle the drop by reordering items and calling for a list refresh.

◆ ConvertCanAcceptDropFn()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FOnCanAcceptDropAdvanced SDragAndDropVerticalBox::ConvertCanAcceptDropFn ( const FOnCanAcceptDrop LegacyDelegate)
inline

◆ DECLARE_DELEGATE_OneParam()

FDragDropEvent const & SDragAndDropVerticalBox::DECLARE_DELEGATE_OneParam ( FOnDragAndDropVerticalBoxDragLeave  ,
FDragDropEvent const &   
)

◆ DECLARE_DELEGATE_RetVal_FourParams() [1/3]

SDragAndDropVerticalBox::DECLARE_DELEGATE_RetVal_FourParams ( FReply  ,
FOnAcceptDrop  ,
const FDragDropEvent ,
SDragAndDropVerticalBox::EItemDropZone  ,
int32  ,
SVerticalBox::FSlot  
)

Delegate signature for handling the drop of FDragDropEvent onto target of type ItemType

◆ DECLARE_DELEGATE_RetVal_FourParams() [2/3]

SDragAndDropVerticalBox::DECLARE_DELEGATE_RetVal_FourParams ( FReply  ,
FOnDragAndDropVerticalBoxDragDetected  ,
const FGeometry ,
const FPointerEvent ,
int32  ,
SVerticalBox::FSlot  
)

◆ DECLARE_DELEGATE_RetVal_FourParams() [3/3]

SDragAndDropVerticalBox::DECLARE_DELEGATE_RetVal_FourParams ( TOptional< EItemDropZone ,
FOnCanAcceptDropAdvanced  ,
const FDragDropEvent ,
SDragAndDropVerticalBox::EItemDropZone  ,
int32  ,
SVerticalBox::FSlot  
)

Delegate signature for querying whether this FDragDropEvent will be handled by the drop target of type ItemType.

◆ DECLARE_DELEGATE_RetVal_OneParam()

SDragAndDropVerticalBox::DECLARE_DELEGATE_RetVal_OneParam ( FReply  ,
FOnDragAndDropVerticalBoxDrop  ,
FDragDropEvent const &   
)

◆ DECLARE_DELEGATE_RetVal_ThreeParams()

SDragAndDropVerticalBox::DECLARE_DELEGATE_RetVal_ThreeParams ( TOptional< EItemDropZone ,
FOnCanAcceptDrop  ,
const FDragDropEvent ,
SDragAndDropVerticalBox::EItemDropZone  ,
SVerticalBox::FSlot  
)

◆ OnDragDetected()

FReply SDragAndDropVerticalBox::OnDragDetected ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

Called when Slate detects that a widget started to be dragged. Usage: A widget can ask Slate to detect a drag. OnMouseDown() reply with FReply::Handled().DetectDrag( SharedThis(this) ). Slate will either send an OnDragDetected() event or do nothing. If the user releases a mouse button or leaves the widget before a drag is triggered (maybe user started at the very edge) then no event will be sent.

Parameters
InMyGeometryWidget geometry
InMouseEventMouseMove that triggered the drag

Reimplemented from SWidget.

◆ OnDragEnter()

void SDragAndDropVerticalBox::OnDragEnter ( FGeometry const &  MyGeometry,
FDragDropEvent const &  DragDropEvent 
)
overridevirtual

Called during drag and drop when the drag enters a widget.

Enter/Leave events in slate are meant as lightweight notifications. So we do not want to capture mouse or set focus in response to these. However, OnDragEnter must also support external APIs (e.g. OLE Drag/Drop) Those require that we let them know whether we can handle the content being dragged OnDragEnter.

The concession is to return a can_handled/cannot_handle boolean rather than a full FReply.

Parameters
MyGeometryThe geometry of the widget receiving the event.
DragDropEventThe drag and drop event.
Returns
A reply that indicated whether the contents of the DragDropEvent can potentially be processed by this widget.

Reimplemented from SWidget.

◆ OnDragLeave()

void SDragAndDropVerticalBox::OnDragLeave ( FDragDropEvent const &  DragDropEvent)
overridevirtual

Called during drag and drop when the drag leaves a widget.

Parameters
DragDropEventThe drag and drop event.

Reimplemented from SWidget.

◆ OnDragOver()

FReply SDragAndDropVerticalBox::OnDragOver ( const FGeometry MyGeometry,
const FDragDropEvent DragDropEvent 
)
overridevirtual

Called during drag and drop when the the mouse is being dragged over a widget.

Parameters
MyGeometryThe geometry of the widget receiving the event.
DragDropEventThe drag and drop event.
Returns
A reply that indicated whether this event was handled.

Reimplemented from SWidget.

◆ OnDrop()

FReply SDragAndDropVerticalBox::OnDrop ( const FGeometry MyGeometry,
const FDragDropEvent DragDropEvent 
)
overridevirtual

Called when the user is dropping something onto a widget; terminates drag and drop.

Parameters
MyGeometryThe geometry of the widget receiving the event.
DragDropEventThe drag and drop event.
Returns
A reply that indicated whether this event was handled.

Reimplemented from SWidget.

◆ OnMouseButtonDown()

FReply SDragAndDropVerticalBox::OnMouseButtonDown ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

Drag detection and handling

Reimplemented from SWidget.

◆ OnPaint()

int32 SDragAndDropVerticalBox::OnPaint ( const FPaintArgs Args,
const FGeometry AllottedGeometry,
const FSlateRect MyCullingRect,
FSlateWindowElementList OutDrawElements,
int32  LayerId,
const FWidgetStyle InWidgetStyle,
bool  bParentEnabled 
) const
overridevirtual

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.

Parameters
ArgsAll the arguments necessary to paint this widget (
AllottedGeometryThe FGeometry that describes an area in which the widget should appear.
MyCullingRectThe rectangle representing the bounds currently being used to completely cull widgets. Unless IsChildWidgetCulled(...) returns true, you should paint the widget.
OutDrawElementsA list of FDrawElements to populate with the output.
LayerIdThe Layer onto which this widget should be rendered.
InColorAndOpacityColor and Opacity to be applied to all the descendants of the widget being painted
bParentEnabledTrue if the parent of this widget is enabled.
Returns
The maximum layer ID attained by this widget or any of its children.

Reimplemented from SPanel.

◆ SetDropIndicator_Above()

SDragAndDropVerticalBox & SDragAndDropVerticalBox::SetDropIndicator_Above ( const FSlateBrush InValue)
inline

Set the Drop indicators

◆ SetDropIndicator_Below()

SDragAndDropVerticalBox & SDragAndDropVerticalBox::SetDropIndicator_Below ( const FSlateBrush InValue)
inline

◆ SLATE_BEGIN_ARGS()

SDragAndDropVerticalBox::SLATE_BEGIN_ARGS ( SDragAndDropVerticalBox  )
inline

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