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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
# (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!
""" Mix-in class for split widgets. """
from traits.api import Callable, Float, HasTraits, Interface
from pyface.ui_traits import Orientation
class ISplitWidget(Interface):
""" Mix-in class for split widgets.
A split widget is one that is split in two either horizontally or
vertically.
"""
# 'ISplitWidget' interface ---------------------------------------------
#: The direction in which the widget is split.
#
#: Splitting vertically means there will be a left hand panel and a right
#: hand panel, splitting horizontally means there will be a top panel and
#: a bottom panel.
direction = Orientation()
#: The ratio of the size of the left/top pane to the right/bottom pane.
ratio = Float(0.5)
#: An optional callable that provides the left hand/top panel, either as
#: a toolkit widget or an IWidget.
lhs = Callable
#: An optional callable that provides the right hand/bottom panel, either
#: as a toolkit widget or an IWidget.
rhs = Callable
# ------------------------------------------------------------------------
# Protected 'ISplitWidget' interface.
# ------------------------------------------------------------------------
def _create_splitter(self, parent):
""" Create the toolkit-specific control that represents the widget.
Parameters
----------
parent : toolkit control
The toolkit control that contains the splitter.
Returns
-------
splitter : toolkit control
The toolkit control for the splitter.
"""
def _create_lhs(self, parent):
""" Creates the left hand/top panel depending on the direction.
Parameters
----------
parent : toolkit control
The splitter's toolkit control.
Returns
-------
lhs : toolkit control
The toolkit control for the lhs.
"""
def _create_rhs(self, parent):
""" Creates the right hand/bottom panel depending on the direction.
Parameters
----------
parent : toolkit control
The splitter's toolkit control.
Returns
-------
rhs : toolkit control
The toolkit control for the rhs.
"""
class MSplitWidget(HasTraits):
""" The mixin class that contains common code for toolkit specific
implementations of the ISplitWidget interface.
"""
# 'ISplitWidget' interface ---------------------------------------------
#: The direction in which the widget is split.
#
#: Splitting vertically means there will be a left hand panel and a right
#: hand panel, splitting horizontally means there will be a top panel and
#: a bottom panel.
direction = Orientation()
#: The ratio of the size of the left/top pane to the right/bottom pane.
ratio = Float(0.5)
#: An optional callable that provides the left hand/top panel, either as
#: a toolkit widget or an IWidget.
lhs = Callable
#: An optional callable that provides the right hand/bottom panel, either
#: as a toolkit widget or an IWidget.
rhs = Callable
def _create_lhs(self, parent):
""" Creates the left hand/top panel depending on the direction.
Parameters
----------
parent : toolkit control
The splitter's toolkit control.
Returns
-------
lhs : toolkit control
The toolkit control for the lhs.
"""
raise NotImplementedError()
def _create_rhs(self, parent):
""" Creates the right hand/bottom panel depending on the direction.
Parameters
----------
parent : toolkit control
The splitter's toolkit control.
Returns
-------
rhs : toolkit control
The toolkit control for the rhs.
"""
raise NotImplementedError()
|
