The interface for configuring and controlling a drag interaction.
SDKs
- iOS 11.0+
- Mac Catalyst 13.0+
Framework
- UIKit
Declaration
protocol UIDragInteractionDelegate
ProtocolUIDrag
UIDrag
Topics
Performing the Drag
func dragAsks the delegate for the array of drag items for an impending drag interaction.
Required.
func dragAsks the delegate for the drag items to add to an in-progress drag session, in response to a user gesture to add the items.
func dragAsks the delegate which drag session to add drag items to when there is more than one in-progress session.
Animating the Drag Behaviors
func dragTells the delegate the system's lift animation is about to start.
func dragTells the delegate the system's cancellation animation is about to start.
Monitoring Drag Progress
func dragTells the delegate the lift animation has finished and the user is starting to move the items across the screen.
func dragTells the delegate an interaction is about to add items to a drag session.
func dragTells the delegate the user moved the drag items to a new location on the screen.
func dragTells the delegate the drag activity will end with the specified operation.
func dragTells the delegate the drag activity and its related animations have finished.
func dragTells the delegate the destination view has received the data for the drag items.
Providing Drag Previews
func dragAsks the delegate for the targeted drag item preview that will appear during the lift animation.
func dragAsks the delegate for the targeted drag item preview to show during the cancellation animation.
func dragAsks the delegate whether the preview should appear in its original size or a scaled size.
Restricting the Drag Behavior
func dragAsks the delegate whether the system should restrict the drag session to the app that started the session.
func dragAsks the delegate whether the session allows the move operation.
Relationships
Inherits From
See Also
Drag-and-Drop Interactions
protocol UIDropThe interface for configuring and controlling a drop interaction.
class UIDragAn interaction to enable dragging of items from a view, employing a delegate to provide drag items and to respond to calls from the drag session.
class UIDropAn interaction to enable dropping of items onto a view, employing a delegate to instantiate objects and respond to calls from the drop session.