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
|
# (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!
""" The handler used to restore editors.
"""
import logging
from pyface.dock.api import SetStructureHandler
logger = logging.getLogger(__name__)
class EditorSetStructureHandler(SetStructureHandler):
""" The handler used to restore editors.
This is part of the 'dock window' API. It is used to resolve dock control
Ids when setting the structure of a dock window.
"""
# ------------------------------------------------------------------------
# 'object' interface.
# ------------------------------------------------------------------------
def __init__(self, window_layout, editor_mementos):
""" Creates a new handler. """
self.window_layout = window_layout
self.editor_mementos = editor_mementos
return
# ------------------------------------------------------------------------
# 'SetStructureHandler' interface.
# ------------------------------------------------------------------------
def resolve_id(self, id):
""" Resolves an unresolved dock control id. """
window_layout = self.window_layout
window = window_layout.window
try:
# Get the memento for the editor with this Id.
memento = self._get_editor_memento(id)
# Ask the editor manager to create an editor from the memento.
editor = window.editor_manager.set_editor_memento(memento)
# Get the editor's toolkit-specific control.
#
# fixme: This is using a 'private' method on the window layout.
# This may be ok since this structure handler is really part of the
# layout!
control = window_layout._wx_get_editor_control(editor)
# fixme: This is ugly manipulating the editors list from in here!
window.editors.append(editor)
except:
logger.warning("could not restore editor [%s]", id)
control = None
return control
# ------------------------------------------------------------------------
# Private interface.
# ------------------------------------------------------------------------
def _get_editor_memento(self, id):
""" Return the editor memento for the editor with the specified Id.
Raises a 'ValueError' if no such memento exists.
"""
editor_memento = self.editor_mementos.get(id)
if editor_memento is None:
raise ValueError("no editor memento with Id %s" % id)
return editor_memento
|
