/[thuban]/branches/WIP-pyshapelib-bramz/Thuban/UI/dock.py
ViewVC logotype

Annotation of /branches/WIP-pyshapelib-bramz/Thuban/UI/dock.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 666 - (hide annotations)
Mon Apr 14 16:36:33 2003 UTC (21 years, 10 months ago) by jonathan
Original Path: trunk/thuban/Thuban/UI/dock.py
File MIME type: text/x-python
File size: 12792 byte(s)
Always assume the button bitmaps will be there. Code clean up.

1 jonathan 561 # Copyright (c) 2003 by Intevation GmbH
2     # Authors:
3     # Jonathan Coles <[email protected]>
4     #
5     # This program is free software under the GPL (>=v2)
6     # Read the file COPYING coming with Thuban for details.
7    
8     """Classes for creating dockable windows"""
9    
10     __version__ = "$Revision$"
11    
12 jonathan 651 import resource
13    
14 jonathan 561 from Thuban import _
15    
16     from wxPython.wx import *
17    
18     from Thuban.Lib.connector import Publisher
19    
20 jonathan 566 from dialogs import NonModalDialog
21    
22 jonathan 561 from messages import DOCKABLE_DOCKED, DOCKABLE_UNDOCKED, DOCKABLE_CLOSED
23    
24     ID_BUTTON_DOCK = 4001
25 jonathan 571 ID_BUTTON_CLOSE = 4002
26 jonathan 561
27 jonathan 571 PANEL_ID = 3141
28    
29 jonathan 651 DOCK_BMP = "dock_12"
30     UNDOCK_BMP = "undock_12"
31     CLOSE_BMP = "close_12"
32    
33 jonathan 561 class DockPanel(wxPanel):
34    
35     def __init__(self, parent, id):
36    
37 jonathan 571 if not isinstance(parent, DockableWindow):
38     raise TypeError("")
39 jonathan 561
40 jonathan 571 wxPanel.__init__(self, parent.GetCurrentParent(), id)
41 jonathan 561
42 jonathan 659 self.parent = parent
43    
44 jonathan 571 #self.SetDockParent(None)
45 jonathan 659 #parent.SetPanel(self)
46 jonathan 571
47 jonathan 659 def Create(self):
48     self.parent.SetPanel(self)
49    
50 jonathan 561 def SetDockParent(self, parent):
51 jonathan 571 self.__dockParent = parent
52 jonathan 561
53     def GetDockParent(self):
54 jonathan 571 return self.__dockParent
55 jonathan 561
56 jonathan 571 def SetDock(self, dock):
57     #if dock == self.IsDocked(): return
58    
59     if dock:
60     self.Dock()
61     else:
62     self.UnDock()
63    
64 jonathan 561 def Dock(self):
65     self.GetDockParent().Dock()
66    
67     def UnDock(self):
68     self.GetDockParent().UnDock()
69    
70     def IsDocked(self):
71     return self.GetDockParent().IsDocked()
72    
73 jonathan 571 class DockableWindow(Publisher):
74 jonathan 561
75 jonathan 571 def __getattr__(self, attr):
76     return getattr(self.__topWindow, attr)
77    
78 jonathan 659 def __init__(self, parent, id, name, title, dockWindow, orient):
79     """Create the dockable window.
80 jonathan 561
81 jonathan 659 Initially, the window is hidden, but in an undocked state.
82     """
83    
84 jonathan 571 if not isinstance(parent, DockFrame): raise TypeError("")
85 jonathan 561
86 jonathan 571 self.__parent = parent
87     self.__id = id
88     self.__name = name
89 jonathan 561
90 jonathan 571 self.__orientation = orient
91 jonathan 561
92 jonathan 571 self.__dockWindow = dockWindow
93     self.__floatWindow = wxFrame(parent, id, title)
94 jonathan 561
95 jonathan 571 self.__docked = False
96     if self.__docked:
97     self.__topWindow = self.__dockWindow
98     else:
99     self.__topWindow = self.__floatWindow
100 jonathan 561
101 jonathan 571 self.__floatSize = None
102     self.__floatPosition = None
103    
104 jonathan 659 self.__dockPanel = None
105 jonathan 571 self.__panel = None
106    
107     self.__dockWindow.Hide()
108     self.__floatWindow.Hide()
109    
110     EVT_CLOSE(self, self._OnClose)
111    
112     ##
113     # Public methods
114     #
115    
116     def GetName(self):
117     return self.__name
118    
119     def SetPanel(self, panel):
120    
121 jonathan 561 if not isinstance(panel, DockPanel):
122     raise TypeError("")
123    
124 jonathan 571 self.__panel = panel
125     self.__panel.SetDockParent(self)
126 jonathan 561 self.__CreateBorder()
127 jonathan 571
128     self.SetDock(self.__docked)
129    
130     def GetPanel(self):
131     return self.__panel
132 jonathan 561
133 jonathan 571 def GetCurrentParent(self):
134     return self.__topWindow
135    
136 jonathan 561 def SetDock(self, dock):
137 jonathan 571
138     self.__CheckAllGood()
139    
140 jonathan 561 if dock:
141     self.Dock()
142     else:
143     self.UnDock()
144    
145     def Dock(self):
146 jonathan 571 self.__CheckAllGood()
147 jonathan 561
148 jonathan 571 wasVisible = self.IsShown()
149 jonathan 561
150 jonathan 571 if wasVisible: self.Show(False)
151 jonathan 561
152 jonathan 571 self.__docked = True
153 jonathan 561
154 jonathan 571 #
155     # save window information
156     #
157     self.__floatSize = self.GetSize()
158     self.__floatPosition = self.GetPosition()
159 jonathan 561
160 jonathan 571 #
161     # reparent
162     #
163     self.__topWindow = self.__dockWindow
164     self.__dockPanel.Reparent(self.__topWindow)
165 jonathan 561
166 jonathan 666 #self.__dockButton.SetBitmapLabel(self.__bmpUnDock)
167     #self.__dockButton.SetBitmapFocus(self.__bmpUnDock)
168     self.__dockButton.SetToolTip(wxToolTip(_("Undock")))
169 jonathan 561
170 jonathan 571 self.SetDockSize(self.__dockWindow.GetSize())
171 jonathan 561
172 jonathan 571 if wasVisible: self.Show(True)
173    
174     self.issue(DOCKABLE_DOCKED, self.__id, self)
175    
176 jonathan 561 def UnDock(self):
177 jonathan 571 self.__CheckAllGood()
178 jonathan 561
179 jonathan 571 wasVisible = self.IsShown()
180 jonathan 561
181 jonathan 571 if wasVisible: self.Show(False)
182    
183     self.__docked = False
184 jonathan 561
185 jonathan 571 #
186     # reparent
187     #
188     self.__topWindow = self.__floatWindow
189     self.__dockPanel.Reparent(self.__topWindow)
190 jonathan 561
191 jonathan 666 #self.__dockButton.SetBitmapLabel(self.__bmpDock)
192     #self.__dockButton.SetBitmapFocus(self.__bmpDock)
193     self.__dockButton.SetToolTip(wxToolTip(_("Dock")))
194 jonathan 561
195 jonathan 571 if wasVisible: self.Show()
196 jonathan 561
197 jonathan 571 #
198     # restore window information
199     #
200 jonathan 666 if self.__floatPosition is not None:
201     self.SetPosition(self.__floatPosition)
202     if self.__floatSize is not None:
203     self.SetSize(self.__floatSize)
204 jonathan 561
205 jonathan 620 self.__dockPanel.SetSize(self.__topWindow.GetClientSize())
206    
207 jonathan 571 self.issue(DOCKABLE_UNDOCKED, self.__id, self)
208 jonathan 561
209     def IsDocked(self):
210 jonathan 571 self.__CheckAllGood()
211     return self.__docked
212 jonathan 561
213 jonathan 571 def Show(self, show = True):
214     if show:
215     self.__DoShow()
216     else:
217     self.__DoHide()
218 jonathan 561
219 jonathan 571 def SetDockSize(self, rect = None):
220 jonathan 561
221 jonathan 571 w0, h0 = self.__dockPanel.GetBestSize()
222     w, h = self.__panel.GetBestSize()
223 jonathan 561
224 jonathan 571 if (w, h) < (w0, h0):
225     w = w0
226     h = h0
227 jonathan 659
228 jonathan 571 if rect is not None:
229     rw = rect.width
230     rh = rect.height
231     if rw < w: rw = w
232     if rh < h: rh = h
233     else:
234     rw = w
235     rh = h
236    
237     # these are to account for the border?!!?
238     rw += 8 # XXX: without this the sash isn't visible!?!?!?!
239     rh += 8 # XXX: without this the sash isn't visible!?!?!?!
240    
241     self.__dockWindow.SetDefaultSize(wxSize(rw, rh))
242 jonathan 561
243    
244 jonathan 577 def Destroy(self):
245     self.__panel.Destroy()
246 jonathan 571 self.__floatWindow.Destroy()
247     self.__dockWindow.Destroy()
248 jonathan 631 self.__parent.OnDockDestroy(self)
249 jonathan 577
250 jonathan 571 ##
251     # Event handlers
252     #
253 jonathan 561
254 jonathan 571 def _OnButtonClose(self, event):
255 jonathan 583 #self.Close()
256 jonathan 631 self.Show(False)
257 jonathan 561
258 jonathan 571 def _OnClose(self, force = False):
259 jonathan 631 self.Show(False)
260 jonathan 561
261 jonathan 571 def _OnToggleDock(self, event):
262     self.__CheckAllGood()
263 jonathan 561
264 jonathan 571 self.SetDock(not self.IsDocked())
265 jonathan 561
266 jonathan 571 ##
267     # Private methods
268     #
269 jonathan 561
270 jonathan 571 def __CheckAllGood(self):
271     if self.__panel is None:
272     raise TypeError("")
273 jonathan 561
274 jonathan 571 def __DoShow(self):
275     if self.IsShown(): return
276 jonathan 561
277 jonathan 571 self.__topWindow.Show()
278 jonathan 561
279 jonathan 571 if self.__topWindow is self.__dockWindow:
280     self.__parent._UpdateDocks()
281    
282     def __DoHide(self):
283     if not self.IsShown(): return
284 jonathan 666
285 jonathan 571 self.__topWindow.Show(False)
286    
287     if self.__topWindow is self.__dockWindow:
288     self.__parent._UpdateDocks()
289    
290     def __CreateBorder(self):
291    
292     self.__dockPanel = wxPanel(self.__topWindow, -1, style=wxSUNKEN_BORDER)
293    
294 jonathan 657 self.__panel.Reparent(self.__dockPanel)
295     self.__panel.SetId(PANEL_ID)
296    
297 jonathan 571 if self.__orientation == wxLAYOUT_VERTICAL:
298     sizer = wxBoxSizer(wxVERTICAL)
299     headerBoxOrient = wxHORIZONTAL
300 jonathan 561 else:
301 jonathan 571 sizer = wxBoxSizer(wxHORIZONTAL)
302     headerBoxOrient = wxVERTICAL
303    
304 jonathan 561
305 jonathan 571 headerBox = wxStaticBoxSizer(
306     wxStaticBox(self.__dockPanel, -1, ""), headerBoxOrient)
307 jonathan 561
308 jonathan 571 #
309     # ideally, we should be able to rotate this text depending on
310     # our orientation
311     #
312     text = wxStaticText(self.__dockPanel, -1, self.GetTitle(),
313 jonathan 620 style = wxALIGN_CENTRE)
314 jonathan 651 font = text.GetFont()
315     font.SetPointSize(10)
316     text.SetFont(font)
317    
318 jonathan 561 #
319 jonathan 666 # load the dock/undock/close bitmaps
320     # and create the buttons
321 jonathan 561 #
322 jonathan 657 self.__bmpDock = \
323 jonathan 651 resource.GetBitmapResource(DOCK_BMP, wxBITMAP_TYPE_XPM)
324 jonathan 657 self.__bmpUnDock = \
325 jonathan 651 resource.GetBitmapResource(UNDOCK_BMP, wxBITMAP_TYPE_XPM)
326 jonathan 561
327 jonathan 666 if self.__docked:
328     bmp = self.__bmpDock
329 jonathan 651 else:
330 jonathan 666 bmp = self.__bmpUnDock
331 jonathan 561
332 jonathan 666 self.__dockButton = wxBitmapButton(
333     self.__dockPanel, ID_BUTTON_DOCK,
334     bmp,
335     size = wxSize(bmp.GetWidth() + 4, bmp.GetHeight() + 4),
336     style = wxBU_EXACTFIT | wxADJUST_MINSIZE)
337 jonathan 561
338 jonathan 651 bmp = resource.GetBitmapResource(CLOSE_BMP, wxBITMAP_TYPE_XPM)
339    
340     closeX = wxBitmapButton(self.__dockPanel, ID_BUTTON_CLOSE, bmp,
341     size = wxSize(bmp.GetWidth() + 4,
342     bmp.GetHeight() + 4),
343     style = wxBU_EXACTFIT | wxADJUST_MINSIZE)
344     closeX.SetToolTip(wxToolTip(_("Close")))
345    
346 jonathan 666 #
347     # fill in the sizer in an order appropriate to the orientation
348     #
349 jonathan 571 if self.__orientation == wxLAYOUT_VERTICAL:
350     headerBox.Add(text, 0, wxALIGN_LEFT | wxALIGN_CENTRE_VERTICAL, 0)
351 jonathan 651 headerBox.Add(1, 5, 1, wxGROW)
352     headerBox.Add(self.__dockButton, 0, wxALIGN_RIGHT, 0)
353     headerBox.Add(closeX, 0, wxALIGN_RIGHT | wxLEFT, 4)
354 jonathan 571 else:
355 jonathan 651 headerBox.Add(closeX, 0, wxALIGN_RIGHT | wxBOTTOM, 4)
356     headerBox.Add(self.__dockButton, 0, wxALIGN_RIGHT, 0)
357 jonathan 571 headerBox.Add(text, 0, wxALIGN_LEFT | wxALIGN_CENTRE_VERTICAL, 0)
358 jonathan 561
359 jonathan 571 sizer.Add(headerBox, 0, wxGROW, 0)
360     sizer.Add(self.__panel, 1, wxGROW, 0)
361 jonathan 561
362 jonathan 666
363 jonathan 659 self.__dockPanel.SetAutoLayout(True)
364     self.__dockPanel.SetSizer(sizer)
365     sizer.SetSizeHints(self.__dockPanel)
366 jonathan 666 sizer.SetSizeHints(self.__floatWindow)
367 jonathan 571
368     EVT_BUTTON(self.__dockPanel, ID_BUTTON_DOCK, self._OnToggleDock)
369     EVT_BUTTON(self.__dockPanel, ID_BUTTON_CLOSE, self._OnButtonClose)
370    
371    
372     class DockFrame(wxFrame):
373    
374     def __init__(self, parent, id, title, position, size):
375     wxFrame.__init__(self, parent, id, title, position, size)
376    
377     self.openWindows = {}
378    
379 jonathan 577 self.__update_lock = 0
380 jonathan 571
381     self.SetMainWindow(None)
382    
383 jonathan 577
384     EVT_SIZE(self, self._OnSashSize)
385     EVT_CLOSE(self, self._OnClose)
386    
387 jonathan 571 layout2oppSash = {
388     wxLAYOUT_NONE : wxSASH_NONE,
389     wxLAYOUT_TOP : wxSASH_BOTTOM,
390     wxLAYOUT_LEFT : wxSASH_RIGHT,
391     wxLAYOUT_RIGHT : wxSASH_LEFT,
392     wxLAYOUT_BOTTOM : wxSASH_TOP }
393    
394 jonathan 577
395     def _OnClose(self, event):
396    
397     self.__update_lock += 1
398    
399     #
400     # child windows are not notified when the parent is destroyed
401     # as of v2.4.0.3 so we need to interate over our children
402     # and tell them to go away.
403     #
404     for key in self.openWindows.keys():
405     win = self.openWindows[key]
406     win.Destroy()
407    
408     self.__update_lock -= 1
409    
410     # should really call _UpdateDocks() here but we don't need to
411     # since we're going away
412    
413 jonathan 571 def CreateDock(self, name, id, title, align):
414    
415     if align in (wxLAYOUT_NONE, wxLAYOUT_LEFT, wxLAYOUT_RIGHT):
416     orient = wxLAYOUT_VERTICAL
417     else:
418     orient = wxLAYOUT_HORIZONTAL
419    
420     sash = wxSashLayoutWindow(self, id, style=wxNO_BORDER|wxSW_3D)
421     sash.SetOrientation(orient)
422     sash.SetAlignment(align)
423     sash.SetSashVisible(DockFrame.layout2oppSash[align], True)
424     sash.SetSashBorder(DockFrame.layout2oppSash[align], True)
425    
426     win = DockableWindow(self, id, name, title, sash, orient)
427    
428     self.__RegisterDock(name, win)
429     EVT_SASH_DRAGGED(self, id, self._OnSashDragged)
430    
431     return win
432    
433     def FindRegisteredDock(self, name):
434     return self.openWindows.get(name)
435    
436 jonathan 631 def OnDockDestroy(self, win):
437 jonathan 571 del self.openWindows[win.GetName()]
438     self._UpdateDocks()
439    
440     def SetMainWindow(self, main):
441     self.__mainWindow = main
442     self._UpdateDocks()
443    
444     def _UpdateDocks(self):
445 jonathan 577 if self.__update_lock == 0:
446     wxLayoutAlgorithm().LayoutWindow(self, self.__mainWindow)
447 jonathan 571
448     def _OnSashDragged(self, event):
449     if event.GetDragStatus() == wxSASH_STATUS_OUT_OF_RANGE:
450     return
451    
452     id = event.GetId()
453     sash = self.FindWindowById(id)
454     #assert(isinstance(win, wxPanel))
455     dockPanel = sash.GetChildren()[0]
456     panel = dockPanel.FindWindowById(PANEL_ID)
457 jonathan 605 assert isinstance(panel, DockPanel)
458 jonathan 571 win = panel.GetDockParent()
459 jonathan 605 assert isinstance(win, DockableWindow)
460 jonathan 571
461 jonathan 605 assert win.IsDocked()
462 jonathan 571
463     rect = event.GetDragRect()
464    
465     win.SetDockSize(rect)
466    
467     self._UpdateDocks()
468    
469     def _OnSashSize(self, event):
470     self._UpdateDocks()
471    
472     def __RegisterDock(self, name, win):
473     if self.FindRegisteredDock(name) is not None:
474     raise ValueError(
475     "A dockable window is already registered under the name '%s'" % name)
476    
477     self.openWindows[name] = win
478    

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26