1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
# (C) Copyright 2005-2023 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
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.
"""
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.
"""
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
"""
|
