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
|
# (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 interface of a workbench editor. """
import uuid
from traits.api import (
Any,
Bool,
Event,
VetoableEvent,
Vetoable,
Instance,
)
from traits.api import provides
from .i_workbench_part import IWorkbenchPart, MWorkbenchPart
class IEditor(IWorkbenchPart):
""" The interface of a workbench editor. """
# The optional command stack.
command_stack = Instance("pyface.undo.api.ICommandStack")
# Is the object that the editor is editing 'dirty' i.e., has it been
# modified but not saved?
dirty = Bool(False)
# The object that the editor is editing.
#
# The framework sets this when the editor is created.
obj = Any()
# Editor Lifecycle Events ---------------------------------------------#
# Fired when the editor is closing.
closing = VetoableEvent()
# Fired when the editor is closed.
closed = Event()
# Methods -------------------------------------------------------------#
def close(self):
""" Close the editor.
This method is not currently called by the framework itself as the user
is normally in control of the editor lifecycle. Call this if you want
to control the editor lifecycle programmatically.
"""
@provides(IEditor)
class MEditor(MWorkbenchPart):
""" Mixin containing common code for toolkit-specific implementations. """
# 'IEditor' interface -------------------------------------------------#
# The optional command stack.
command_stack = Instance("pyface.undo.api.ICommandStack")
# Is the object that the editor is editing 'dirty' i.e., has it been
# modified but not saved?
dirty = Bool(False)
# The object that the editor is editing.
#
# The framework sets this when the editor is created.
obj = Any()
# Editor Lifecycle Events ---------------------------------------------#
# Fired when the editor is opening.
opening = VetoableEvent()
# Fired when the editor has been opened.
open = Event()
# Fired when the editor is closing.
closing = Event(VetoableEvent)
# Fired when the editor is closed.
closed = Event()
# ------------------------------------------------------------------------
# 'object' interface.
# ------------------------------------------------------------------------
def __str__(self):
""" Return an informal string representation of the object. """
return "Editor(%s)" % self.id
# ------------------------------------------------------------------------
# 'IWorkbenchPart' interface.
# ------------------------------------------------------------------------
def _id_default(self):
""" Trait initializer. """
# If no Id is specified then use a random uuid
# this gaurantees (barring *really* unusual cases) that there are no
# collisions between the ids of editors.
return uuid.uuid4().hex
# ------------------------------------------------------------------------
# 'IEditor' interface.
# ------------------------------------------------------------------------
def close(self):
""" Close the editor. """
if self.control is not None:
self.closing = event = Vetoable()
if not event.veto:
self.window.close_editor(self)
self.closed = True
return
# Initializers ---------------------------------------------------------
def _command_stack_default(self):
""" Trait initializer. """
# We make sure the undo package is entirely optional.
try:
from pyface.undo.api import CommandStack
except ImportError:
return None
return CommandStack(undo_manager=self.window.workbench.undo_manager)
|
