Source code for pyface.i_drop_handler

# (C) Copyright 2005-2022 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
from traits.api import Interface


[docs]class IDropHandler(Interface): """ Interface for a drop event handler, which provides API to check if the drop can be handled or not, and then handle it if possible. """
[docs] def can_handle_drop(self, event, target): """ Whether or not a drag event can be handled This is used to give feedback to the user about whether a drop is possible via the shape of the cursor or similar indicators. Parameters ---------- event : drag event A drag event with information about the object being dragged. target : toolkit widget The widget that would be dropped on. Returns ------- can_drop : bool True if the current drop handler can handle the given drag event occurring on the given target widget. """
[docs] def handle_drop(self, event, target): """ Performs drop action when drop event occurs on target widget. Parameters ---------- event : drop event A drop event with information about the object being dropped. target : toolkit widget The widget that would be dropped on """