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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
|
'''
Task Coach - Your friendly task manager
Copyright (C) 2004-2014 Task Coach developers <developers@taskcoach.org>
Task Coach is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Task Coach is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
'''
from taskcoachlib import patterns, persistence, help # pylint: disable=W0622
from taskcoachlib.domain import task, base, category
from taskcoachlib.i18n import _
from wx.lib.pubsub import pub
import uicommand
import viewer
import wx
import os
class Menu(wx.Menu, uicommand.UICommandContainerMixin):
def __init__(self, window):
super(Menu, self).__init__()
self._window = window
self._accels = list()
self._observers = list()
def __len__(self):
return self.GetMenuItemCount()
def DestroyItem(self, menuItem):
if menuItem.GetSubMenu():
menuItem.GetSubMenu().clearMenu()
self._window.Unbind(wx.EVT_MENU, id=menuItem.GetId())
self._window.Unbind(wx.EVT_UPDATE_UI, id=menuItem.GetId())
super(Menu, self).DestroyItem(menuItem)
def clearMenu(self):
''' Remove all menu items. '''
for menuItem in self.MenuItems:
self.DestroyItem(menuItem)
for observer in self._observers:
observer.removeInstance()
self._observers = list()
def accelerators(self):
return self._accels
def appendUICommand(self, uiCommand):
cmd = uiCommand.addToMenu(self, self._window)
self._accels.extend(uiCommand.accelerators())
if isinstance(uiCommand, patterns.Observer):
self._observers.append(uiCommand)
return cmd
def appendMenu(self, text, subMenu, bitmap=None):
subMenuItem = wx.MenuItem(self, id=wx.NewId(), text=text,
subMenu=subMenu)
if bitmap:
subMenuItem.SetBitmap(wx.ArtProvider_GetBitmap(bitmap,
wx.ART_MENU, (16, 16)))
self._accels.extend(subMenu.accelerators())
self.AppendItem(subMenuItem)
def invokeMenuItem(self, menuItem):
''' Programmatically invoke the menuItem. This is mainly for testing
purposes. '''
self._window.ProcessEvent(wx.CommandEvent( \
wx.wxEVT_COMMAND_MENU_SELECTED, winid=menuItem.GetId()))
def openMenu(self):
''' Programmatically open the menu. This is mainly for testing
purposes. '''
# On Mac OSX, an explicit UpdateWindowUI is needed to ensure that
# menu items are updated before the menu is opened. This is not needed
# on other platforms, but it doesn't hurt either.
self._window.UpdateWindowUI()
self._window.ProcessEvent(wx.MenuEvent(wx.wxEVT_MENU_OPEN, menu=self))
class DynamicMenu(Menu):
''' A menu that registers for events and then updates itself whenever the
event is fired. '''
def __init__(self, window, parentMenu=None, labelInParentMenu=''):
''' Initialize the menu. labelInParentMenu is needed to be able to
find this menu in its parentMenu. '''
super(DynamicMenu, self).__init__(window)
self._parentMenu = parentMenu
self._labelInParentMenu = self.__GetLabelText(labelInParentMenu)
self.registerForMenuUpdate()
self.updateMenu()
def registerForMenuUpdate(self):
''' Subclasses are responsible for binding an event to onUpdateMenu so
that the menu gets a chance to update itself at the right time. '''
raise NotImplementedError
def onUpdateMenu(self, newValue, sender):
''' This event handler should be called at the right times so that
the menu has a chance to update itself. '''
try: # Prepare for menu or window to be destroyed
self.updateMenu()
except wx.PyDeadObjectError:
pass
def onUpdateMenu_Deprecated(self, event=None):
''' This event handler should be called at the right times so that
the menu has a chance to update itself. '''
# If this is called by wx, 'skip' the event so that other event
# handlers get a chance too:
if event and hasattr(event, 'Skip'):
event.Skip()
if event.GetMenu() != self._parentMenu:
return
try: # Prepare for menu or window to be destroyed
self.updateMenu()
except wx.PyDeadObjectError:
pass
def updateMenu(self):
''' Updating the menu consists of two steps: updating the menu item
of this menu in its parent menu, e.g. to enable or disable it, and
updating the menu items of this menu. '''
self.updateMenuItemInParentMenu()
self.updateMenuItems()
def updateMenuItemInParentMenu(self):
''' Enable or disable the menu item in the parent menu, depending on
what enabled() returns. '''
if self._parentMenu:
myId = self.myId()
if myId != wx.NOT_FOUND:
self._parentMenu.Enable(myId, self.enabled())
def myId(self):
''' Return the id of our menu item in the parent menu. '''
# I'd rather use wx.Menu.FindItem, but it seems that that
# method currently does not work for menu items with accelerators
# (wxPython 2.8.6 on Ubuntu). When that is fixed replace the 7
# lines below with this one:
# myId = self._parentMenu.FindItem(self._labelInParentMenu)
for item in self._parentMenu.MenuItems:
if self.__GetLabelText(item.GetText()) == self._labelInParentMenu:
return item.Id
return wx.NOT_FOUND
def updateMenuItems(self):
''' Update the menu items of this menu. '''
pass
def enabled(self):
''' Return a boolean indicating whether this menu should be enabled in
its parent menu. This method is called by
updateMenuItemInParentMenu(). It returns True by default. Override
in a subclass as needed.'''
return True
@staticmethod
def __GetLabelText(menuText):
''' Remove accelerators from the menuText. This is necessary because on
some platforms '&' is changed into '_' so menuTexts would compare
different even though they are really the same. '''
return menuText.replace('&', '').replace('_', '')
class DynamicMenuThatGetsUICommandsFromViewer(DynamicMenu):
def __init__(self, viewer, parentMenu=None, labelInParentMenu=''): # pylint: disable=W0621
self._uiCommands = None
super(DynamicMenuThatGetsUICommandsFromViewer, self).__init__(\
viewer, parentMenu, labelInParentMenu)
def registerForMenuUpdate(self):
# Refill the menu whenever the menu is opened, because the menu might
# depend on the status of the viewer:
self._window.Bind(wx.EVT_MENU_OPEN, self.onUpdateMenu_Deprecated)
def updateMenuItems(self):
newCommands = self.getUICommands()
try:
if newCommands == self._uiCommands:
return
except wx._core.PyDeadObjectError: # pylint: disable=W0212
pass # Old viewer was closed
self.clearMenu()
self.fillMenu(newCommands)
self._uiCommands = newCommands
def fillMenu(self, uiCommands):
self.appendUICommands(*uiCommands) # pylint: disable=W0142
def getUICommands(self):
raise NotImplementedError
class MainMenu(wx.MenuBar):
def __init__(self, mainwindow, settings, iocontroller, viewerContainer,
taskFile):
super(MainMenu, self).__init__()
accels = list()
for menu, text in [
(FileMenu(mainwindow, settings, iocontroller,
viewerContainer), _('&File')),
(EditMenu(mainwindow, settings, iocontroller,
viewerContainer), _('&Edit')),
(ViewMenu(mainwindow, settings, viewerContainer,
taskFile), _('&View')),
(NewMenu(mainwindow, settings, taskFile,
viewerContainer), _('&New')),
(ActionMenu(mainwindow, settings, taskFile,
viewerContainer), _('&Actions')),
(HelpMenu(mainwindow, settings, iocontroller), _('&Help'))
]:
self.Append(menu, text)
accels.extend(menu.accelerators())
mainwindow.SetAcceleratorTable(wx.AcceleratorTable(accels))
class FileMenu(Menu):
def __init__(self, mainwindow, settings, iocontroller, viewerContainer):
super(FileMenu, self).__init__(mainwindow)
self.__settings = settings
self.__iocontroller = iocontroller
self.__recentFileUICommands = []
self.__separator = None
self.appendUICommands(
uicommand.FileOpen(iocontroller=iocontroller),
uicommand.FileMerge(iocontroller=iocontroller),
uicommand.FileClose(iocontroller=iocontroller),
None,
uicommand.FileSave(iocontroller=iocontroller),
uicommand.FileMergeDiskChanges(iocontroller=iocontroller),
uicommand.FileSaveAs(iocontroller=iocontroller),
uicommand.FileSaveSelection(iocontroller=iocontroller,
viewer=viewerContainer))
if not settings.getboolean('feature', 'syncml'):
self.appendUICommands(uicommand.FilePurgeDeletedItems(iocontroller=iocontroller))
self.appendUICommands(
None,
uicommand.FileSaveSelectedTaskAsTemplate(iocontroller=iocontroller,
viewer=viewerContainer),
uicommand.FileImportTemplate(iocontroller=iocontroller),
uicommand.FileEditTemplates(settings=settings),
None,
uicommand.PrintPageSetup(settings=settings),
uicommand.PrintPreview(viewer=viewerContainer, settings=settings),
uicommand.Print(viewer=viewerContainer, settings=settings),
None)
self.appendMenu(_('&Import'),
ImportMenu(mainwindow, iocontroller))
self.appendMenu(_('&Export'),
ExportMenu(mainwindow, iocontroller, settings),
'export')
self.appendUICommands(
None,
uicommand.FileManageBackups(iocontroller=iocontroller, settings=settings)
)
if settings.getboolean('feature', 'syncml'):
try:
import taskcoachlib.syncml.core # pylint: disable=W0612,W0404
except ImportError:
pass
else:
self.appendUICommands(uicommand.FileSynchronize(iocontroller=iocontroller,
settings=settings))
self.__recentFilesStartPosition = len(self)
self.appendUICommands(None, uicommand.FileQuit())
self._window.Bind(wx.EVT_MENU_OPEN, self.onOpenMenu)
def onOpenMenu(self, event):
if event.GetMenu() == self:
self.__removeRecentFileMenuItems()
self.__insertRecentFileMenuItems()
event.Skip()
def __insertRecentFileMenuItems(self):
recentFiles = self.__settings.getlist('file', 'recentfiles')
if not recentFiles:
return
maximumNumberOfRecentFiles = self.__settings.getint('file',
'maxrecentfiles')
recentFiles = recentFiles[:maximumNumberOfRecentFiles]
self.__separator = self.InsertSeparator(self.__recentFilesStartPosition)
for index, recentFile in enumerate(recentFiles):
recentFileNumber = index + 1 # Only computer nerds start counting at 0 :-)
recentFileMenuPosition = self.__recentFilesStartPosition + 1 + index
recentFileOpenUICommand = uicommand.RecentFileOpen(filename=recentFile,
index=recentFileNumber, iocontroller=self.__iocontroller)
recentFileOpenUICommand.addToMenu(self, self._window,
recentFileMenuPosition)
self.__recentFileUICommands.append(recentFileOpenUICommand)
def __removeRecentFileMenuItems(self):
for recentFileUICommand in self.__recentFileUICommands:
recentFileUICommand.removeFromMenu(self, self._window)
self.__recentFileUICommands = []
if self.__separator:
self.RemoveItem(self.__separator)
self.__separator = None
class ExportMenu(Menu):
def __init__(self, mainwindow, iocontroller, settings):
super(ExportMenu, self).__init__(mainwindow)
kwargs = dict(iocontroller=iocontroller, settings=settings)
# pylint: disable=W0142
self.appendUICommands(
uicommand.FileExportAsHTML(**kwargs),
uicommand.FileExportAsCSV(**kwargs),
uicommand.FileExportAsICalendar(**kwargs),
uicommand.FileExportAsTodoTxt(**kwargs))
class ImportMenu(Menu):
def __init__(self, mainwindow, iocontroller):
super(ImportMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.FileImportCSV(iocontroller=iocontroller),
uicommand.FileImportTodoTxt(iocontroller=iocontroller))
class TaskTemplateMenu(DynamicMenu):
def __init__(self, mainwindow, taskList, settings):
self.settings = settings
self.taskList = taskList
super(TaskTemplateMenu, self).__init__(mainwindow)
def registerForMenuUpdate(self):
pub.subscribe(self.onTemplatesSaved, 'templates.saved')
def onTemplatesSaved(self):
self.onUpdateMenu(None, None)
def updateMenuItems(self):
self.clearMenu()
self.fillMenu(self.getUICommands())
def fillMenu(self, uiCommands):
self.appendUICommands(*uiCommands) # pylint: disable=W0142
def getUICommands(self):
path = self.settings.pathToTemplatesDir()
commands = [uicommand.TaskNewFromTemplate(os.path.join(path, name),
taskList=self.taskList,
settings=self.settings) for name in persistence.TemplateList(path).names()]
return commands
class EditMenu(Menu):
def __init__(self, mainwindow, settings, iocontroller, viewerContainer):
super(EditMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.EditUndo(),
uicommand.EditRedo(),
None,
uicommand.EditCut(viewer=viewerContainer, id=wx.ID_CUT),
uicommand.EditCopy(viewer=viewerContainer, id=wx.ID_COPY),
uicommand.EditPaste(),
uicommand.EditPasteAsSubItem(viewer=viewerContainer),
None,
uicommand.Edit(viewer=viewerContainer, id=wx.ID_EDIT),
uicommand.Delete(viewer=viewerContainer, id=wx.ID_DELETE),
None)
# Leave sufficient room for command names in the Undo and Redo menu
# items:
self.appendMenu(_('&Select') + ' ' * 50,
SelectMenu(mainwindow, viewerContainer))
self.appendUICommands(None, uicommand.EditPreferences(settings))
if settings.getboolean('feature', 'syncml'):
try:
import taskcoachlib.syncml.core # pylint: disable=W0612,W0404
except ImportError:
pass
else:
self.appendUICommands(uicommand.EditSyncPreferences(mainwindow=mainwindow,
iocontroller=iocontroller))
class SelectMenu(Menu):
def __init__(self, mainwindow, viewerContainer):
super(SelectMenu, self).__init__(mainwindow)
kwargs = dict(viewer=viewerContainer)
# pylint: disable=W0142
self.appendUICommands(uicommand.SelectAll(**kwargs),
uicommand.ClearSelection(**kwargs))
activateNextViewerId = wx.NewId()
activatePreviousViewerId = wx.NewId()
class ViewMenu(Menu):
def __init__(self, mainwindow, settings, viewerContainer, taskFile):
super(ViewMenu, self).__init__(mainwindow)
self.appendMenu(_('&New viewer'),
ViewViewerMenu(mainwindow, settings, viewerContainer, taskFile),
'viewnewviewer')
activateNextViewer = uicommand.ActivateViewer(viewer=viewerContainer,
menuText=_('&Activate next viewer\tCtrl+PgDn'),
helpText=help.viewNextViewer, forward=True,
bitmap='activatenextviewer', id=activateNextViewerId)
activatePreviousViewer = uicommand.ActivateViewer(viewer=viewerContainer,
menuText=_('Activate &previous viewer\tCtrl+PgUp'),
helpText=help.viewPreviousViewer, forward=False,
bitmap='activatepreviousviewer', id=activatePreviousViewerId)
self.appendUICommands(
activateNextViewer,
activatePreviousViewer,
uicommand.RenameViewer(viewer=viewerContainer),
None)
self.appendMenu(_('&Mode'),
ModeMenu(mainwindow, self, _('&Mode')))
self.appendMenu(_('&Filter'),
FilterMenu(mainwindow, self, _('&Filter')))
self.appendMenu(_('&Sort'),
SortMenu(mainwindow, self, _('&Sort')))
self.appendMenu(_('&Columns'),
ColumnMenu(mainwindow, self, _('&Columns')))
self.appendMenu(_('&Rounding'),
RoundingMenu(mainwindow, self, _('&Rounding')))
self.appendUICommands(None)
self.appendMenu(_('&Tree options'),
ViewTreeOptionsMenu(mainwindow, viewerContainer),
'treeview')
self.appendUICommands(None)
self.appendMenu(_('T&oolbar'), ToolBarMenu(mainwindow, settings))
self.appendUICommands(uicommand.UICheckCommand(settings=settings,
menuText=_('Status&bar'), helpText=_('Show/hide status bar'),
setting='statusbar'))
class ViewViewerMenu(Menu):
def __init__(self, mainwindow, settings, viewerContainer, taskFile):
super(ViewViewerMenu, self).__init__(mainwindow)
ViewViewer = uicommand.ViewViewer
kwargs = dict(viewer=viewerContainer, taskFile=taskFile, settings=settings)
# pylint: disable=W0142
viewViewerCommands = [\
ViewViewer(menuText=_('&Task'),
helpText=_('Open a new tab with a viewer that displays tasks'),
viewerClass=viewer.TaskViewer, **kwargs),
ViewViewer(menuText=_('Task &statistics'),
helpText=_('Open a new tab with a viewer that displays task statistics'),
viewerClass=viewer.TaskStatsViewer, **kwargs),
ViewViewer(menuText=_('Task &square map'),
helpText=_('Open a new tab with a viewer that displays tasks in a square map'),
viewerClass=viewer.SquareTaskViewer, **kwargs),
ViewViewer(menuText=_('T&imeline'),
helpText=_('Open a new tab with a viewer that displays a timeline of tasks and effort'),
viewerClass=viewer.TimelineViewer, **kwargs),
ViewViewer(menuText=_('&Calendar'),
helpText=_('Open a new tab with a viewer that displays tasks in a calendar'),
viewerClass=viewer.CalendarViewer, **kwargs),
ViewViewer(menuText=_('&Hierarchical calendar'),
helpText=_('Open a new tab with a viewer that displays task hierarchy in a calendar'),
viewerClass=viewer.HierarchicalCalendarViewer, **kwargs),
ViewViewer(menuText=_('&Category'),
helpText=_('Open a new tab with a viewer that displays categories'),
viewerClass=viewer.CategoryViewer, **kwargs),
ViewViewer(menuText=_('&Effort'),
helpText=_('Open a new tab with a viewer that displays efforts'),
viewerClass=viewer.EffortViewer, **kwargs),
uicommand.ViewEffortViewerForSelectedTask(menuText=_('Eff&ort for selected task(s)'),
helpText=_('Open a new tab with a viewer that displays efforts for the selected task'),
viewerClass=viewer.EffortViewer, **kwargs),
ViewViewer(menuText=_('&Note'),
helpText=_('Open a new tab with a viewer that displays notes'),
viewerClass=viewer.NoteViewer, **kwargs)]
self.appendUICommands(*viewViewerCommands)
class ViewTreeOptionsMenu(Menu):
def __init__(self, mainwindow, viewerContainer):
super(ViewTreeOptionsMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.ViewExpandAll(viewer=viewerContainer),
uicommand.ViewCollapseAll(viewer=viewerContainer))
class ModeMenu(DynamicMenuThatGetsUICommandsFromViewer):
def enabled(self):
return self._window.viewer.hasModes() and \
bool(self._window.viewer.getModeUICommands())
def getUICommands(self):
return self._window.viewer.getModeUICommands()
class FilterMenu(DynamicMenuThatGetsUICommandsFromViewer):
def enabled(self):
return self._window.viewer.isFilterable() and \
bool(self._window.viewer.getFilterUICommands())
def getUICommands(self):
return self._window.viewer.getFilterUICommands()
class ColumnMenu(DynamicMenuThatGetsUICommandsFromViewer):
def enabled(self):
return self._window.viewer.hasHideableColumns()
def getUICommands(self):
return self._window.viewer.getColumnUICommands()
class SortMenu(DynamicMenuThatGetsUICommandsFromViewer):
def enabled(self):
return self._window.viewer.isSortable()
def getUICommands(self):
return self._window.viewer.getSortUICommands()
class RoundingMenu(DynamicMenuThatGetsUICommandsFromViewer):
def enabled(self):
return self._window.viewer.supportsRounding()
def getUICommands(self):
return self._window.viewer.getRoundingUICommands()
class ToolBarMenu(Menu):
def __init__(self, mainwindow, settings):
super(ToolBarMenu, self).__init__(mainwindow)
toolbarCommands = []
for value, menuText, helpText in \
[(None, _('&Hide'), _('Hide the toolbar')),
((16, 16), _('&Small images'), _('Small images (16x16) on the toolbar')),
((22, 22), _('&Medium-sized images'), _('Medium-sized images (22x22) on the toolbar')),
((32, 32), _('&Large images'), _('Large images (32x32) on the toolbar'))]:
toolbarCommands.append(uicommand.UIRadioCommand(settings=settings,
setting='toolbar', value=value, menuText=menuText,
helpText=helpText))
# pylint: disable=W0142
self.appendUICommands(*toolbarCommands)
class NewMenu(Menu):
def __init__(self, mainwindow, settings, taskFile, viewerContainer):
super(NewMenu, self).__init__(mainwindow)
tasks = taskFile.tasks()
self.appendUICommands(
uicommand.TaskNew(taskList=tasks, settings=settings),
uicommand.NewTaskWithSelectedTasksAsPrerequisites(taskList=tasks,
viewer=viewerContainer, settings=settings),
uicommand.NewTaskWithSelectedTasksAsDependencies(taskList=tasks,
viewer=viewerContainer, settings=settings))
self.appendMenu(_('New task from &template'),
TaskTemplateMenu(mainwindow, taskList=tasks, settings=settings),
'newtmpl')
self.appendUICommands(
None,
uicommand.EffortNew(viewer=viewerContainer,
effortList=taskFile.efforts(),
taskList=tasks, settings=settings),
uicommand.CategoryNew(categories=taskFile.categories(),
settings=settings),
uicommand.NoteNew(notes=taskFile.notes(), settings=settings),
None,
uicommand.NewSubItem(viewer=viewerContainer))
class ActionMenu(Menu):
def __init__(self, mainwindow, settings, taskFile, viewerContainer):
super(ActionMenu, self).__init__(mainwindow)
tasks = taskFile.tasks()
efforts = taskFile.efforts()
categories = taskFile.categories()
# Generic actions, applicable to all/most domain objects:
self.appendUICommands(
uicommand.AddAttachment(viewer=viewerContainer, settings=settings),
uicommand.OpenAllAttachments(viewer=viewerContainer,
settings=settings),
None,
uicommand.AddNote(viewer=viewerContainer, settings=settings),
uicommand.OpenAllNotes(viewer=viewerContainer,
settings=settings),
None,
uicommand.Mail(viewer=viewerContainer),
None)
self.appendMenu(_('&Toggle category'),
ToggleCategoryMenu(mainwindow, categories=categories,
viewer=viewerContainer),
'folder_blue_arrow_icon')
# Start of task specific actions:
self.appendUICommands(
None,
uicommand.TaskMarkInactive(settings=settings, viewer=viewerContainer),
uicommand.TaskMarkActive(settings=settings, viewer=viewerContainer),
uicommand.TaskMarkCompleted(settings=settings, viewer=viewerContainer),
None)
self.appendMenu(_('Change task &priority'),
TaskPriorityMenu(mainwindow, tasks, viewerContainer),
'incpriority')
self.appendUICommands(
None,
uicommand.EffortStart(viewer=viewerContainer, taskList=tasks),
uicommand.EffortStop(viewer=viewerContainer, effortList=efforts, taskList=tasks),
uicommand.EditTrackedTasks(taskList=tasks, settings=settings))
class TaskPriorityMenu(Menu):
def __init__(self, mainwindow, taskList, viewerContainer):
super(TaskPriorityMenu, self).__init__(mainwindow)
kwargs = dict(taskList=taskList, viewer=viewerContainer)
# pylint: disable=W0142
self.appendUICommands(
uicommand.TaskIncPriority(**kwargs),
uicommand.TaskDecPriority(**kwargs),
uicommand.TaskMaxPriority(**kwargs),
uicommand.TaskMinPriority(**kwargs))
class HelpMenu(Menu):
def __init__(self, mainwindow, settings, iocontroller):
super(HelpMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.Help(),
uicommand.FAQ(),
uicommand.Tips(settings=settings),
uicommand.Anonymize(iocontroller=iocontroller),
None,
uicommand.RequestSupport(),
uicommand.ReportBug(),
uicommand.RequestFeature(),
None,
uicommand.HelpTranslate(),
uicommand.Donate(),
None,
uicommand.HelpAbout(),
uicommand.CheckForUpdate(settings=settings),
uicommand.HelpLicense())
class TaskBarMenu(Menu):
def __init__(self, taskBarIcon, settings, taskFile, viewer):
super(TaskBarMenu, self).__init__(taskBarIcon)
tasks = taskFile.tasks()
efforts = taskFile.efforts()
self.appendUICommands(
uicommand.TaskNew(taskList=tasks, settings=settings))
self.appendMenu(_('New task from &template'),
TaskTemplateMenu(taskBarIcon, taskList=tasks, settings=settings),
'newtmpl')
self.appendUICommands(None) # Separator
self.appendUICommands(
uicommand.EffortNew(effortList=efforts, taskList=tasks,
settings=settings),
uicommand.CategoryNew(categories=taskFile.categories(),
settings=settings),
uicommand.NoteNew(notes=taskFile.notes(), settings=settings))
self.appendUICommands(None) # Separator
label = _('&Start tracking effort')
self.appendMenu(label,
StartEffortForTaskMenu(taskBarIcon,
base.filter.DeletedFilter(tasks),
self, label), 'clock_icon')
self.appendUICommands(uicommand.EffortStop(viewer=viewer,
effortList=efforts,
taskList=tasks))
self.appendUICommands(
None,
uicommand.MainWindowRestore(),
uicommand.FileQuit())
class ToggleCategoryMenu(DynamicMenu):
def __init__(self, mainwindow, categories, viewer): # pylint: disable=W0621
self.categories = categories
self.viewer = viewer
super(ToggleCategoryMenu, self).__init__(mainwindow)
def registerForMenuUpdate(self):
for eventType in (self.categories.addItemEventType(),
self.categories.removeItemEventType()):
patterns.Publisher().registerObserver(self.onUpdateMenu_Deprecated,
eventType=eventType,
eventSource=self.categories)
patterns.Publisher().registerObserver(self.onUpdateMenu_Deprecated,
eventType=category.Category.subjectChangedEventType())
def updateMenuItems(self):
self.clearMenu()
self.addMenuItemsForCategories(self.categories.rootItems(), self)
def addMenuItemsForCategories(self, categories, menu):
# pylint: disable=W0621
categories = categories[:]
categories.sort(key=lambda category: category.subject().lower())
for category in categories:
uiCommand = uicommand.ToggleCategory(category=category,
viewer=self.viewer)
uiCommand.addToMenu(menu, self._window)
categoriesWithChildren = [category for category in categories if category.children()]
if categoriesWithChildren:
menu.AppendSeparator()
for category in categoriesWithChildren:
subMenu = Menu(self._window)
self.addMenuItemsForCategories(category.children(), subMenu)
menu.AppendSubMenu(subMenu, self.subMenuLabel(category))
@staticmethod
def subMenuLabel(category): # pylint: disable=W0621
return _('%s (subcategories)') % category.subject()
def enabled(self):
return bool(self.categories)
class StartEffortForTaskMenu(DynamicMenu):
def __init__(self, taskBarIcon, tasks, parentMenu=None,
labelInParentMenu=''):
self.tasks = tasks
super(StartEffortForTaskMenu, self).__init__(taskBarIcon, parentMenu,
labelInParentMenu)
def registerForMenuUpdate(self):
for eventType in (self.tasks.addItemEventType(),
self.tasks.removeItemEventType()):
patterns.Publisher().registerObserver(self.onUpdateMenu_Deprecated,
eventType=eventType,
eventSource=self.tasks)
for eventType in (task.Task.subjectChangedEventType(),
task.Task.trackingChangedEventType(),
task.Task.plannedStartDateTimeChangedEventType(),
task.Task.dueDateTimeChangedEventType(),
task.Task.actualStartDateTimeChangedEventType(),
task.Task.completionDateTimeChangedEventType()):
if eventType.startswith('pubsub'):
pub.subscribe(self.onUpdateMenu, eventType)
else:
patterns.Publisher().registerObserver(self.onUpdateMenu_Deprecated,
eventType)
def updateMenuItems(self):
self.clearMenu()
trackableRootTasks = self._trackableRootTasks()
trackableRootTasks.sort(key=lambda task: task.subject())
for trackableRootTask in trackableRootTasks:
self.addMenuItemForTask(trackableRootTask, self)
def addMenuItemForTask(self, task, menu): # pylint: disable=W0621
uiCommand = uicommand.EffortStartForTask(task=task, taskList=self.tasks)
uiCommand.addToMenu(menu, self._window)
trackableChildren = [child for child in task.children() if \
child in self.tasks and not child.completed()]
if trackableChildren:
trackableChildren.sort(key=lambda child: child.subject())
subMenu = Menu(self._window)
for child in trackableChildren:
self.addMenuItemForTask(child, subMenu)
menu.AppendSubMenu(subMenu, _('%s (subtasks)') % task.subject())
def enabled(self):
return bool(self._trackableRootTasks())
def _trackableRootTasks(self):
return [rootTask for rootTask in self.tasks.rootItems() \
if not rootTask.completed()]
class TaskPopupMenu(Menu):
def __init__(self, mainwindow, settings, tasks, efforts, categories, taskViewer):
super(TaskPopupMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.EditCut(viewer=taskViewer),
uicommand.EditCopy(viewer=taskViewer),
uicommand.EditPaste(),
uicommand.EditPasteAsSubItem(viewer=taskViewer),
None,
uicommand.Edit(viewer=taskViewer),
uicommand.Delete(viewer=taskViewer),
None,
uicommand.AddAttachment(viewer=taskViewer, settings=settings),
uicommand.OpenAllAttachments(viewer=taskViewer,
settings=settings),
None,
uicommand.AddNote(viewer=taskViewer,
settings=settings),
uicommand.OpenAllNotes(viewer=taskViewer, settings=settings),
None,
uicommand.Mail(viewer=taskViewer),
None)
self.appendMenu(_('&Toggle category'),
ToggleCategoryMenu(mainwindow, categories=categories,
viewer=taskViewer),
'folder_blue_arrow_icon')
self.appendUICommands(
None,
uicommand.TaskMarkInactive(settings=settings, viewer=taskViewer),
uicommand.TaskMarkActive(settings=settings, viewer=taskViewer),
uicommand.TaskMarkCompleted(settings=settings, viewer=taskViewer),
None)
self.appendMenu(_('&Priority'),
TaskPriorityMenu(mainwindow, tasks, taskViewer),
'incpriority')
self.appendUICommands(
None,
uicommand.EffortNew(viewer=taskViewer, effortList=efforts,
taskList=tasks, settings=settings),
uicommand.EffortStart(viewer=taskViewer, taskList=tasks),
uicommand.EffortStop(viewer=taskViewer, effortList=efforts, taskList=tasks),
None,
uicommand.NewSubItem(viewer=taskViewer))
class EffortPopupMenu(Menu):
def __init__(self, mainwindow, tasks, efforts, settings, effortViewer):
super(EffortPopupMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.EditCut(viewer=effortViewer),
uicommand.EditCopy(viewer=effortViewer),
uicommand.EditPaste(),
None,
uicommand.Edit(viewer=effortViewer),
uicommand.Delete(viewer=effortViewer),
None,
uicommand.EffortNew(viewer=effortViewer, effortList=efforts,
taskList=tasks, settings=settings),
uicommand.EffortStartForEffort(viewer=effortViewer, taskList=tasks),
uicommand.EffortStop(viewer=effortViewer, effortList=efforts, taskList=tasks))
class CategoryPopupMenu(Menu):
def __init__(self, mainwindow, settings, taskFile, categoryViewer,
localOnly=False):
super(CategoryPopupMenu, self).__init__(mainwindow)
categories = categoryViewer.presentation()
tasks = taskFile.tasks()
notes = taskFile.notes()
self.appendUICommands(
uicommand.EditCut(viewer=categoryViewer),
uicommand.EditCopy(viewer=categoryViewer),
uicommand.EditPaste(),
uicommand.EditPasteAsSubItem(viewer=categoryViewer),
None,
uicommand.Edit(viewer=categoryViewer),
uicommand.Delete(viewer=categoryViewer),
None,
uicommand.AddAttachment(viewer=categoryViewer, settings=settings),
uicommand.OpenAllAttachments(viewer=categoryViewer,
settings=settings),
None,
uicommand.AddNote(viewer=categoryViewer, settings=settings),
uicommand.OpenAllNotes(viewer=categoryViewer, settings=settings),
None,
uicommand.Mail(viewer=categoryViewer))
if not localOnly:
self.appendUICommands(
None,
uicommand.NewTaskWithSelectedCategories(taskList=tasks,
settings=settings,
categories=categories,
viewer=categoryViewer),
uicommand.NewNoteWithSelectedCategories(notes=notes,
settings=settings, categories=categories,
viewer=categoryViewer))
self.appendUICommands(
None,
uicommand.NewSubItem(viewer=categoryViewer))
class NotePopupMenu(Menu):
def __init__(self, mainwindow, settings, categories, noteViewer):
super(NotePopupMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.EditCut(viewer=noteViewer),
uicommand.EditCopy(viewer=noteViewer),
uicommand.EditPaste(),
uicommand.EditPasteAsSubItem(viewer=noteViewer),
None,
uicommand.Edit(viewer=noteViewer),
uicommand.Delete(viewer=noteViewer),
None,
uicommand.AddAttachment(viewer=noteViewer, settings=settings),
uicommand.OpenAllAttachments(viewer=noteViewer,
settings=settings),
None,
uicommand.Mail(viewer=noteViewer),
None)
self.appendMenu(_('&Toggle category'),
ToggleCategoryMenu(mainwindow, categories=categories,
viewer=noteViewer),
'folder_blue_arrow_icon')
self.appendUICommands(
None,
uicommand.NewSubItem(viewer=noteViewer))
class ColumnPopupMenuMixin(object):
''' Mixin class for column header popup menu's. These menu's get the
column index property set by the control popping up the menu to
indicate which column the user clicked. See
widgets._CtrlWithColumnPopupMenuMixin. '''
def __setColumn(self, columnIndex):
self.__columnIndex = columnIndex # pylint: disable=W0201
def __getColumn(self):
return self.__columnIndex
columnIndex = property(__getColumn, __setColumn)
def getUICommands(self):
if not self._window: # Prevent PyDeadObject exception when running tests
return []
return [uicommand.HideCurrentColumn(viewer=self._window), None] + \
self._window.getColumnUICommands()
class ColumnPopupMenu(ColumnPopupMenuMixin, Menu):
''' Column header popup menu. '''
def __init__(self, window):
super(ColumnPopupMenu, self).__init__(window)
wx.CallAfter(self.appendUICommands, *self.getUICommands())
def appendUICommands(self, *args, **kwargs):
# Prepare for PyDeadObjectError since we're called from wx.CallAfter
try:
super(ColumnPopupMenu, self).appendUICommands(*args, **kwargs)
except wx.PyDeadObjectError:
pass
class EffortViewerColumnPopupMenu(ColumnPopupMenuMixin,
DynamicMenuThatGetsUICommandsFromViewer):
''' Column header popup menu. '''
def registerForMenuUpdate(self):
pub.subscribe(self.onChangeAggregation, 'effortviewer.aggregation')
def onChangeAggregation(self):
self.onUpdateMenu(None, None)
class AttachmentPopupMenu(Menu):
def __init__(self, mainwindow, settings, attachments, attachmentViewer):
super(AttachmentPopupMenu, self).__init__(mainwindow)
self.appendUICommands(
uicommand.EditCut(viewer=attachmentViewer),
uicommand.EditCopy(viewer=attachmentViewer),
uicommand.EditPaste(),
None,
uicommand.Edit(viewer=attachmentViewer),
uicommand.Delete(viewer=attachmentViewer),
None,
uicommand.AddNote(viewer=attachmentViewer, settings=settings),
uicommand.OpenAllNotes(viewer=attachmentViewer,
settings=settings),
None,
uicommand.AttachmentOpen(viewer=attachmentViewer,
attachments=attachments,
settings=settings))
|
