/
layered_panel.py
179 lines (131 loc) · 5.68 KB
/
layered_panel.py
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
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/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!
#
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" A Layered panel. """
from __future__ import absolute_import
# Major package imports.
import wx
from wx.lib.scrolledpanel import ScrolledPanel
# Enthought library imports.
from traits.api import Any, Str, Int
# Local imports.
from .widget import Widget
class LayeredPanel(Widget):
""" A Layered panel.
A layered panel contains one or more named layers, with only one layer
visible at any one time (think of a 'tab' control minus the tabs!). Each
layer is a toolkit-specific control.
"""
# The default style.
STYLE = wx.CLIP_CHILDREN
#### "Layered Panel' interface ############################################
# The toolkit-specific control of the currently displayed layer.
current_layer = Any
# The name of the currently displayed layer.
current_layer_name = Str
# The minimum for the panel, which is the maximum of the minimum
# sizes of the layers
min_width = Int(0)
min_height = Int(0)
###########################################################################
# 'object' interface.
###########################################################################
def __init__(self, parent, **traits):
""" Creates a new LayeredPanel. """
# Base class constructor.
super(LayeredPanel, self).__init__(**traits)
# Create the toolkit-specific control that represents the widget.
self.control = self._create_control(parent)
# The layers in the panel.
#
# { str name : wx.Window layer }
self._layers = {}
return
###########################################################################
# 'LayeredPanel' interface.
###########################################################################
def add_layer(self, name, layer):
""" Adds a layer with the specified name.
All layers are hidden when they are added. Use 'show_layer' to make a
layer visible.
"""
# Add the layer to our sizer.
sizer = self.control.GetSizer()
sizer.Add(layer, 1, wx.EXPAND)
# All layers are hidden when they are added. Use 'show_layer' to make
# a layer visible.
sizer.Show(layer, False)
# fixme: Should we warn if a layer is being overridden?
self._layers[name] = layer
# fixme: The minimum size stuff that was added for linux broke the
# sizing on Windows (at least for the preference dialog). The
# preference dialog now sets the minimum width and height to -1 so
# that this layout code doesn't get executed.
if self.min_width != -1 or self.min_height != -1:
if layer.GetSizer() is None:
return layer
min_size = layer.GetSizer().CalcMin()
needs_layout = False
if min_size.GetWidth() > self.min_width:
self.min_width = min_size.GetWidth()
needs_layout = True
if min_size.GetHeight() > self.min_height:
self.min_height = min_size.GetHeight()
needs_layout = True
if needs_layout:
# Reset our size hints and relayout
self.control.SetSizeHints(self.min_width, self.min_height)
self.control.GetSizer().Layout()
# fixme: Force our parent to reset it's size hints to its
# minimum
parent = self.control.GetParent()
parent.GetSizer().SetSizeHints(parent)
parent.GetSizer().Layout()
return layer
def show_layer(self, name):
""" Shows the layer with the specified name. """
# Hide the current layer (if one is displayed).
if self.current_layer is not None:
self._hide_layer(self.current_layer)
# Show the specified layer.
layer = self._show_layer(name, self._layers[name])
return layer
def has_layer(self, name):
""" Does the panel contain a layer with the specified name? """
return self._layers.has_key(name)
###########################################################################
# Private interface.
###########################################################################
def _create_control(self, parent):
""" Create the toolkit-specific control that represents the widget. """
panel = ScrolledPanel(parent, -1, style=self.STYLE)
sizer = wx.BoxSizer(wx.VERTICAL)
panel.SetSizer(sizer)
panel.SetAutoLayout(True)
panel.SetupScrolling()
return panel
def _hide_layer(self, layer):
""" Hides the specified layer. """
sizer = self.control.GetSizer()
sizer.Show(layer, False)
sizer.Layout()
return
def _show_layer(self, name, layer):
""" Shows the specified layer. """
sizer = self.control.GetSizer()
sizer.Show(layer, True)
sizer.Layout()
self.current_layer = layer
self.current_layer_name = name
return layer
#### EOF ######################################################################