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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
# (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!
import logging
from traits.api import HasTraits
from .dock_pane import AREA_MAP, INVERSE_AREA_MAP
from pyface.tasks.task_layout import (
PaneItem,
Tabbed,
Splitter,
)
# row/col orientation for AUI
ORIENTATION_NEEDS_NEW_ROW = {
"horizontal": {"top": False, "bottom": False, "left": True, "right": True},
"vertical": {"top": True, "bottom": True, "left": False, "right": False},
}
# Logging.
logger = logging.getLogger(__name__)
class MainWindowLayout(HasTraits):
""" A class for applying declarative layouts to an AUI managed window.
"""
# ------------------------------------------------------------------------
# 'MainWindowLayout' interface.
# ------------------------------------------------------------------------
def get_layout(self, layout, window):
""" Get the layout by adding sublayouts to the specified DockLayout.
"""
logger.debug("get_layout: %s" % layout)
layout.perspective = window._aui_manager.SavePerspective()
logger.debug("get_layout: saving perspective %s" % layout.perspective)
def set_layout(self, layout, window):
""" Applies a DockLayout to the window.
"""
logger.debug("set_layout: %s" % layout)
if hasattr(layout, "perspective"):
self._set_layout_from_aui(layout, window)
return
# Perform the layout. This will assign fixed sizes to the dock widgets
# to enforce size constraints specified in the PaneItems.
for name, direction in AREA_MAP.items():
sublayout = getattr(layout, name)
if sublayout:
self.set_layout_for_area(sublayout, direction)
self._add_dock_panes(window)
def _add_dock_panes(self, window):
# Add all panes not assigned an area by the TaskLayout.
mgr = window._aui_manager
for dock_pane in self.state.dock_panes:
info = mgr.GetPane(dock_pane.pane_name)
if not info.IsOk():
logger.debug(
"_add_dock_panes: managing pane %s" % dock_pane.pane_name
)
dock_pane.add_to_manager()
else:
logger.debug(
"_add_dock_panes: arleady managed pane: %s"
% dock_pane.pane_name
)
def _set_layout_from_aui(self, layout, window):
# The central pane will have already been added, but we need to add all
# of the dock panes to the manager before the call to LoadPerspective
logger.debug("_set_layout_from_aui: using saved perspective")
self._add_dock_panes(window)
logger.debug(
"_set_layout_from_aui: restoring perspective %s"
% layout.perspective
)
window._aui_manager.LoadPerspective(layout.perspective)
for dock_pane in self.state.dock_panes:
logger.debug("validating dock pane traits for %s" % dock_pane.id)
dock_pane.validate_traits_from_pane_info()
def set_layout_for_area(self, layout, direction, row=None, pos=None):
""" Applies a LayoutItem to the specified dock area.
"""
# AUI doesn't have full, arbitrary row/col positions, nor infinitely
# splittable areas. Top and bottom docks are only splittable
# vertically, and within each vertical split each can be split
# horizontally and that's it. Similarly, left and right docks can
# only be split horizontally and within each horizontal split can be
# split vertically.
logger.debug("set_layout_for_area: %s" % INVERSE_AREA_MAP[direction])
if isinstance(layout, PaneItem):
dock_pane = self._get_dock_pane(layout)
if dock_pane is None:
raise MainWindowLayoutError("Unknown dock pane %r" % layout)
dock_pane.dock_area = INVERSE_AREA_MAP[direction]
logger.debug("layout size (%d,%d)" % (layout.width, layout.height))
dock_pane.add_to_manager(row=row, pos=pos)
dock_pane.visible = True
elif isinstance(layout, Tabbed):
active_pane = first_pane = None
for item in layout.items:
dock_pane = self._get_dock_pane(item)
dock_pane.dock_area = INVERSE_AREA_MAP[direction]
if item.id == layout.active_tab:
active_pane = dock_pane
dock_pane.add_to_manager(tabify_pane=first_pane)
if not first_pane:
first_pane = dock_pane
dock_pane.visible = True
# Activate the appropriate tab, if possible.
if not active_pane:
# By default, AUI will activate the last widget.
active_pane = first_pane
if active_pane:
mgr = active_pane.task.window._aui_manager
info = active_pane.get_pane_info()
mgr.ShowPane(info.window, True)
elif isinstance(layout, Splitter):
dock_area = INVERSE_AREA_MAP[direction]
needs_new_row = ORIENTATION_NEEDS_NEW_ROW[layout.orientation][
dock_area
]
if needs_new_row:
if row is None:
row = 0
else:
row += 1
for i, item in enumerate(layout.items):
self.set_layout_for_area(item, direction, row, pos)
row += 1
else:
pos = 0
for i, item in enumerate(layout.items):
self.set_layout_for_area(item, direction, row, pos)
pos += 1
else:
raise MainWindowLayoutError("Unknown layout item %r" % layout)
# ------------------------------------------------------------------------
# 'MainWindowLayout' abstract interface.
# ------------------------------------------------------------------------
def _get_dock_widget(self, pane):
""" Returns the QDockWidget associated with a PaneItem.
"""
raise NotImplementedError()
def _get_pane(self, dock_widget):
""" Returns a PaneItem for a QDockWidget.
"""
raise NotImplementedError()
def _get_dock_pane(self, pane):
""" Returns the DockPane associated with a PaneItem.
"""
for dock_pane in self.state.dock_panes:
if dock_pane.id == pane.id:
return dock_pane
return None
class MainWindowLayoutError(ValueError):
""" Exception raised when a malformed LayoutItem is passed to the
MainWindowLayout.
"""
pass
|
