-
Notifications
You must be signed in to change notification settings - Fork 1
/
DiagramNotebook.py
410 lines (308 loc) · 10.5 KB
/
DiagramNotebook.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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
# -*- coding: utf-8 -*-
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
# DiagramNoteBook.py ---
# --------------------------------
# Copyright (c) 2013
# Laurent CAPOCCHI
# University of Corsica
# --------------------------------
# Version 1.0 last modified: 21/01/2018
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
#
# GENERAL NOTES AND REMARKS:
#
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
#
# GLOBAL VARIABLES AND FUNCTIONS
#
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
import wx
import os
import sys
import __builtin__
# to send event
if wx.VERSION_STRING < '2.9':
from wx.lib.pubsub import Publisher as pub
else:
#from wx.lib.pubsub import pub
from pubsub import pub
import Container
import Menu
from DetachedFrame import DetachedFrame
from PrintOut import Printable
_ = wx.GetTranslation
#-------------------------------------------------------------------
class GeneralNotebook(Printable):
"""
"""
def __init__(self, *args, **kwargs):
"""
General Notebook class for Diagram Notebook on the right part of DEVSimPy.
"""
# for splash screen
pub.sendMessage('object.added', message='Loading notebook diagram...\n')
Printable.__init__(self)
# local copy
self.parent = args[0]
self.pages = [] # keeps track of pages
### to propagate the dsp file path in __setstate__ of Block object
self.current_dsp_file_path = ""
#icon under tab
imgList = wx.ImageList(16, 16)
for img in [os.path.join(ICON_PATH_16_16,'network.png')]:
imgList.Add(wx.Image(img, wx.BITMAP_TYPE_PNG).ConvertToBitmap())
self.AssignImageList(imgList)
### binding
self.Bind(wx.EVT_LEFT_DCLICK, self.__AddPage)
def GetPages(self):
""" Return pages array
"""
return self.pages
def __AddPage(self, event):
""" Add page
"""
self.AddEditPage(_("Diagram%d")%len(self.pages))
def AddEditPage(self, title, defaultDiagram = None):
""" Adds a new page for editing to the notebook and keeps track of it.
@type title: string
@param title: Title for a new page
"""
### title page list
title_pages = map(lambda p: p.name, self.pages)
### occurrence of title in existing title pages
c = title_pages.count(title)
title = title+"(%d)"%c if c != 0 else title
### new page
newPage = Container.ShapeCanvas(self, wx.NewId(), name=title)
### new diagram
d = defaultDiagram or Container.Diagram()
d.SetParent(newPage)
### diagram and background new page setting
newPage.SetDiagram(d)
### print canvas variable setting
self.print_canvas = newPage
self.print_size = self.GetSize()
self.pages.append(newPage)
self.AddPage(newPage, title, imageId=0)
self.SetSelection(self.GetPageCount()-1)
def OnClearPage(self, evt):
""" Clear page.
@type evt: event
@param evt: Event Object, None by default
"""
id = self.GetSelection()
if self.GetPageCount() > 0:
canvas = self.GetPage(id)
diagram = canvas.GetDiagram()
diagram.DeleteAllShapes()
diagram.modified = True
canvas.deselect()
canvas.Refresh()
def OnRenamePage(self, evt):
"""Rename the title of notebook page.
@type evt: event
@param evt: Event Object, None by default
"""
selection = self.GetSelection()
dlg = wx.TextEntryDialog(self, _("Enter a new name:"), _("Diagram Manager"))
dlg.SetValue(self.GetPageText(selection))
if dlg.ShowModal() == wx.ID_OK:
txt = dlg.GetValue()
self.SetPageText(selection,txt)
dlg.Destroy()
def OnDetachPage(self, evt):
"""
Detach the notebook page on frame.
@type evt: event
@param evt: Event Object, None by default
"""
mainW = self.GetTopLevelParent()
selection = self.GetSelection()
canvas = self.GetPage(selection)
title = self.GetPageText(selection)
frame = DetachedFrame(canvas, wx.ID_ANY, title, canvas.GetDiagram())
frame.SetIcon(mainW.icon)
frame.SetFocus()
frame.Show()
def OnPageChanged(self, evt):
""" Page has been changed
"""
id = self.GetSelection()
### id is -1 when DEVSimPy is starting
if id != -1 and self.GetPageCount() > 0:
canvas = self.GetPage(id)
self.print_canvas = canvas
self.print_size = self.GetSize()
### action history
if hasattr(self.parent, 'tb'):
self.parent.tb.EnableTool(wx.ID_UNDO, not len(canvas.stockUndo) == 0)
self.parent.tb.EnableTool(wx.ID_REDO, not len(canvas.stockRedo) == 0)
### refresh canvas
canvas.deselect()
canvas.Refresh()
### update status bar depending on the diagram modification
if hasattr(self.parent, 'statusbar'):
diagram = canvas.GetDiagram()
txt = _('%s modified')%(self.GetPageText(id)) if diagram.modify else ""
self.parent.statusbar.SetStatusText(txt)
### propagate event also error in OnClosePage because GetSelection is wrong
evt.Skip()
def DeleteBuiltinConstants(self):
""" Delete builtin constants for the diagram.
"""
try:
name = self.GetPageText(self.GetSelection())
del __builtin__.__dict__[str(os.path.splitext(name)[0])]
except Exception:
pass
#sys.stdout.write("Constants builtin not delete for %s : %s"%(name, info))
### ---------------------------------------------
### if flatnotebook can be imported, we work with it
### more information about FlatNotebook http://wiki.wxpython.org/Flatnotebook%20(AGW)
USE_FLATNOTEBOOK = False
try:
if (wx.VERSION >= (2, 8, 9, 2)):
import wx.lib.agw.flatnotebook as fnb
else:
import wx.lib.flatnotebook as fnb
USE_FLATNOTEBOOK = True
except:
pass
if USE_FLATNOTEBOOK:
#
# FlatNotebook generalized class
#
class DiagramNotebook(fnb.FlatNotebook, GeneralNotebook):
""" Diagram FlatNotebook class
"""
###
def __init__(self, *args, **kwargs):
""" Constructor.
FlatNotebook class that allows overriding and adding methods for the right pane of DEVSimPy
"""
fnb.FlatNotebook.__init__(self, *args, **kwargs)
GeneralNotebook.__init__(self, *args, **kwargs)
self.Bind(fnb.EVT_FLATNOTEBOOK_PAGE_CLOSING, self.OnClosingPage)
self.Bind(fnb.EVT_FLATNOTEBOOK_PAGE_CHANGED, self.OnPageChanged)
self.CreateRightClickMenu()
self.SetRightClickMenu(self._rmenu)
def CreateRightClickMenu(self):
""" Right click has been invoked and contextual menu is displayed.
"""
self._rmenu = Menu.DiagramTabPopupMenu(self)
### 4 because 3 is the separator object in Menu.py !!!
close_item = self._rmenu.FindItemByPosition(4)
#close_item.Enable(self.GetPageCount() > 1)
### unbind last event binding with OnClose Page
self.Unbind(wx.EVT_MENU, close_item)
### bind event with new OnDeletePage
self.Bind(wx.EVT_MENU, self.OnClosePage, close_item)
###
def OnClosingPage(self, evt):
""" Called when tab is closed.
With FlatNoteBock, this method is used to ask if diagram should be saved and to update properties panel
"""
id = self.GetSelection()
canvas = self.GetPage(id)
diagram = canvas.GetDiagram()
mainW = self.GetTopLevelParent()
val = None
if diagram.modify:
title = self.GetPageText(id)
dlg = wx.MessageDialog(self, _('%s\nSave changes to the current diagram?')%(title), title, wx.YES_NO | wx.YES_DEFAULT | wx.CANCEL |wx.ICON_QUESTION)
val = dlg.ShowModal()
if val == wx.ID_YES:
mainW.OnSaveFile(evt)
elif val == wx.ID_NO:
self.DeleteBuiltinConstants()
else:
pass
dlg.Destroy()
else:
self.DeleteBuiltinConstants()
### if user cancel the delete process, we stop the event propagation in order to enable the DeletePage function
if val == wx.ID_CANCEL:
evt.Veto()
else:
self.pages.remove(canvas)
### update (clear) of properties panel (Control notebook)
propPanel = mainW.GetControlNotebook().GetPropPanel()
### If properties panel is active, we update it
if propPanel:
propPanel.UpdatePropertiesPage(propPanel.defaultPropertiesPage())
evt.Skip()
def DeletePage(self, *args, **kwargs):
canvas = self.GetPage(args[0])
result = fnb.FlatNotebook.DeletePage(self, *args, **kwargs)
return not canvas in self.pages
def OnClosePage(self, evt):
return self.DeletePage(self.GetSelection())
else:
#
# Classic Notebook class
#
class DiagramNotebook(wx.Notebook, GeneralNotebook):
""" Diagram classic NoteBook class
"""
def __init__(self, *args, **kwargs):
""" Notebook class that allows overriding and adding methods for the right pane of DEVSimPy
"""
wx.Notebook.__init__(self, *args, **kwargs)
GeneralNotebook.__init__(self,*args, **kwargs)
self.Bind(wx.EVT_RIGHT_DOWN, self.__ShowMenu)
self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self.OnPageChanged)
def __ShowMenu(self, evt):
""" Callback for the right click on a tab. Displays the menu.
@type evt: event
@param evt: Event Object, None by default
"""
### mouse position
pos = evt.GetPosition()
### pointed page and flag
page,flag = self.HitTest(pos)
### if no where click (don't hit with windows)
if flag == wx.BK_HITTEST_NOWHERE:
self.PopupMenu(Menu.DiagramNoTabPopupMenu(self), pos)
### if tab has been clicked
elif flag == wx.BK_HITTEST_ONLABEL:
self.PopupMenu(Menu.DiagramTabPopupMenu(self), pos)
else:
pass
def OnClosePage(self, evt):
""" Close current page.
@type evt: event
@param evt: Event Object, None by default
"""
if self.GetPageCount() > 0:
id = self.GetSelection()
canvas = self.GetPage(id)
diagram = canvas.GetDiagram()
mainW = self.GetTopLevelParent()
if diagram.modify:
title = self.GetPageText(id)
dlg = wx.MessageDialog(self, _('%s\nSave changes to the current diagram?')%(title), title, wx.YES_NO | wx.YES_DEFAULT | wx.CANCEL |wx.ICON_QUESTION)
val = dlg.ShowModal()
if val == wx.ID_YES:
mainW.OnSaveFile(evt)
elif val == wx.ID_NO:
self.DeleteBuiltinConstants()
self.pages.remove(canvas)
if not self.DeletePage(id):
sys.stdout.write(_(" %s not deleted! \n"%(title)))
else:
dlg.Destroy()
return False
dlg.Destroy()
else:
self.DeleteBuiltinConstants()
self.pages.remove(canvas)
if not self.DeletePage(id):
sys.stdout.write(_("%s not deleted ! \n"%(title)))
### clear "property" notebook
nb1 = mainW.GetControlNotebook()
propPanel = nb1.GetPropPanel()
### if page is active, then update and stay on this
if propPanel:
propPanel.UpdatePropertiesPage(propPanel.defaultPropertiesPage())
return True