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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
|
# (C) Copyright 2004-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!
""" Defines a drop target editor for the wxPython user interface toolkit. A
drop target editor handles drag and drop operations as a drop target.
"""
import wx
from pyface.wx.drag_and_drop import PythonDropTarget, clipboard
from .text_editor import SimpleEditor as Editor
from .constants import DropColor
# -------------------------------------------------------------------------
# 'SimpleEditor' class:
# -------------------------------------------------------------------------
class SimpleEditor(Editor):
"""Simple style of drop editor, which displays a read-only text field that
contains the string representation of the object trait's value.
"""
#: Background color when it is OK to drop objects.
ok_color = DropColor
def init(self, parent):
"""Finishes initializing the editor by creating the underlying toolkit
widget.
"""
if self.factory.readonly:
self.control = wx.TextCtrl(
parent, -1, self.str_value, style=wx.TE_READONLY
)
self.set_tooltip()
else:
super().init(parent)
self.control.SetBackgroundColour(self.ok_color)
self.control.SetDropTarget(PythonDropTarget(self))
def string_value(self, value):
"""Returns the text representation of a specified object trait value."""
if value is None:
return ""
return str(value)
def error(self, excp):
"""Handles an error that occurs while setting the object's trait value."""
pass
# ----- Drag and drop event handlers: -------------------------------------
def wx_dropped_on(self, x, y, data, drag_result):
"""Handles a Python object being dropped on the tree."""
klass = self.factory.klass
value = data
if self.factory.binding:
value = getattr(clipboard, "node", None)
if (klass is None) or isinstance(data, klass):
self._no_update = True
try:
if hasattr(value, "drop_editor_value"):
self.value = value.drop_editor_value()
else:
self.value = value
if hasattr(value, "drop_editor_update"):
value.drop_editor_update(self.control)
else:
self.control.SetValue(self.str_value)
finally:
self._no_update = False
return drag_result
return wx.DragNone
def wx_drag_over(self, x, y, data, drag_result):
"""Handles a Python object being dragged over the tree."""
if self.factory.binding:
data = getattr(clipboard, "node", None)
try:
self.object.base_trait(self.name).validate(
self.object, self.name, data
)
return drag_result
except:
return wx.DragNone
# Define the Text and ReadonlyEditor for use by the editor factory.
TextEditor = ReadonlyEditor = SimpleEditor
|