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
101
102
103
104
105
106
107
108
|
# (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!
""" Defines the IDockable interface which objects contained in a DockWindow
DockControl can implement in order to allow themselves to be dragged into
a different DockWindow.
"""
# -------------------------------------------------------------------------------
# 'IDockable' class:
# -------------------------------------------------------------------------------
class IDockable(object):
# ---------------------------------------------------------------------------
# Should the current DockControl be closed before creating the new one:
# ---------------------------------------------------------------------------
def dockable_should_close(self):
""" Should the current DockControl be closed before creating the new
one.
"""
return True
# ---------------------------------------------------------------------------
# Returns whether or not it is OK to close the control, and if it is OK,
# then it closes the DockControl itself:
# ---------------------------------------------------------------------------
def dockable_close(self, dock_control, force):
""" Returns whether or not it is OK to close the control.
"""
return False
# ---------------------------------------------------------------------------
# Gets a control that can be docked into a DockWindow:
# ---------------------------------------------------------------------------
def dockable_get_control(self, parent):
""" Gets a control that can be docked into a DockWindow.
"""
raise NotImplementedError(
"The 'IDockable.dockable_get_control' method must be overridden"
)
# ---------------------------------------------------------------------------
# Allows the object to override the default DockControl settings:
# ---------------------------------------------------------------------------
def dockable_init_dockcontrol(self, dock_control):
""" Allows the object to override the default DockControl settings.
"""
pass
# ---------------------------------------------------------------------------
# Returns the right-click popup menu for a DockControl (if any):
# ---------------------------------------------------------------------------
def dockable_menu(self, dock_control, event):
""" Returns the right-click popup menu for a DockControl (if any).
"""
return None
# ---------------------------------------------------------------------------
# Handles the user double-clicking on the DockControl:
# A result of False indicates the event was not handled; all other results
# indicate that the event was handled successfully.
# ---------------------------------------------------------------------------
def dockable_dclick(self, dock_control, event):
""" Handles the user double-clicking on the DockControl.
A result of False indicates the event was not handled; all other
results indicate that the event was handled successfully.
"""
return False
# ---------------------------------------------------------------------------
# Handles a notebook tab being activated or deactivated:
# ---------------------------------------------------------------------------
def dockable_tab_activated(self, dock_control, activated):
""" Handles a notebook tab being activated or deactivated.
'dock_control' is the control being activated or deactivated.
If 'activated' is True, the control is being activated; otherwise
the control is being deactivated.
"""
pass
# ---------------------------------------------------------------------------
# Handles the IDockable being bound to a specified DockControl:
# ---------------------------------------------------------------------------
def dockable_bind(self, dock_control):
""" Handles the dockable being bound to a specified DockControl.
"""
pass
|
