Package gui :: Module menu
Source Code for Module gui.menu

  1  ############################################################################### 
  2  #                                                                             # 
  3  # Copyright (C) 2009 Michael Bieri                                            # 
  4  # Copyright (C) 2010-2013 Edward d'Auvergne                                   # 
  5  #                                                                             # 
  6  # This file is part of the program relax (http://www.nmr-relax.com).          # 
  7  #                                                                             # 
  8  # This program is free software: you can redistribute it and/or modify        # 
  9  # it under the terms of the GNU General Public License as published by        # 
 10  # the Free Software Foundation, either version 3 of the License, or           # 
 11  # (at your option) any later version.                                         # 
 12  #                                                                             # 
 13  # This program is distributed in the hope that it will be useful,             # 
 14  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
 15  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
 16  # GNU General Public License for more details.                                # 
 17  #                                                                             # 
 18  # You should have received a copy of the GNU General Public License           # 
 19  # along with this program.  If not, see <http://www.gnu.org/licenses/>.       # 
 20  #                                                                             # 
 21  ############################################################################### 
 22   
 23  # Module docstring. 
 24  """The main relax menu bar.""" 
 25   
 26  # Python module imports. 
 27  import sys 
 28  import wx 
 29   
 30  # relax module imports. 
 31  from graphics import fetch_icon 
 32  from gui.components.menu import build_menu_item 
 33  from gui.uf_objects import build_uf_menus, Uf_storage; uf_store = Uf_storage() 
 34  from status import Status; status = Status() 
 35  from user_functions.data import Uf_info; uf_info = Uf_info() 
 36   
 37   
 38 -class Menu: 
 39      """The menu bar GUI class.""" 
 40   
 41      # Some IDs for the menu entries. 
 42      MENU_FILE_NEW = wx.NewId() 
 43      MENU_FILE_CLOSE = wx.NewId() 
 44      MENU_FILE_CLOSE_ALL = wx.NewId() 
 45      MENU_FILE_OPEN = wx.NewId() 
 46      MENU_FILE_SAVE = wx.NewId() 
 47      MENU_FILE_SAVE_AS = wx.NewId() 
 48      MENU_FILE_EXPORT_BMRB = wx.NewId() 
 49      MENU_FILE_EXIT = wx.NewId() 
 50      MENU_VIEW_CONTROLLER = wx.NewId() 
 51      MENU_VIEW_SPIN_VIEW = wx.NewId() 
 52      MENU_VIEW_RESULTS = wx.NewId() 
 53      MENU_VIEW_PIPE_EDIT = wx.NewId() 
 54      MENU_VIEW_PROMPT = wx.NewId() 
 55      MENU_TOOLS_FORMAT = wx.NewId() 
 56      MENU_TOOLS_TEST_SUITE = wx.NewId() 
 57      MENU_TOOLS_TEST_SUITE_ALL = wx.NewId() 
 58      MENU_TOOLS_TEST_SUITE_SYS = wx.NewId() 
 59      MENU_TOOLS_TEST_SUITE_UNIT = wx.NewId() 
 60      MENU_TOOLS_TEST_SUITE_GUI = wx.NewId() 
 61      MENU_TOOLS_TEST_SUITE_VERIFICATION = wx.NewId() 
 62      MENU_TOOLS_SYS_INFO = wx.NewId() 
 63      MENU_HELP_MANUAL = wx.NewId() 
 64      MENU_HELP_MAIL = wx.NewId() 
 65      MENU_HELP_REFS = wx.NewId() 
 66      MENU_HELP_GPL = wx.NewId() 
 67      MENU_HELP_ABOUT = wx.NewId() 
 68   
 69 -    def __init__(self, gui): 
 70          """Build the menu bar.""" 
 71   
 72          # Store the args. 
 73          self.gui = gui 
 74   
 75          # Create the menu bar GUI item. 
 76          self.menubar = wx.MenuBar() 
 77   
 78          # The 'File' menu entries. 
 79          menu = wx.Menu() 
 80          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_NEW, text="&New analysis\tCtrl+N", icon=fetch_icon('oxygen.actions.document-new', "16x16"))) 
 81          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_CLOSE, text="&Close analysis", icon=fetch_icon('oxygen.actions.document-close', "16x16"))) 
 82          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_CLOSE_ALL, text="&Close all analyses", icon=fetch_icon('oxygen.actions.dialog-close', "16x16"))) 
 83          menu.AppendSeparator() 
 84          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_OPEN, text="&Open relax state\tCtrl+O", icon=fetch_icon('oxygen.actions.document-open', "16x16"))) 
 85          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_SAVE, text="S&ave relax state\tCtrl+S", icon=fetch_icon('oxygen.actions.document-save', "16x16"))) 
 86          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_SAVE_AS, text="Save as...\tCtrl+Shift+S", icon=fetch_icon('oxygen.actions.document-save-as', "16x16"))) 
 87          menu.AppendSeparator() 
 88          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_EXPORT_BMRB, text="Export for BMRB deposition", icon=fetch_icon('relax.bmrb'))) 
 89          menu.AppendSeparator() 
 90          menu.AppendItem(build_menu_item(menu, id=self.MENU_FILE_EXIT, text="E&xit\tCtrl+Q", icon=fetch_icon('oxygen.actions.system-shutdown', "16x16"))) 
 91          self.menubar.Append(menu, "&File") 
 92   
 93          # The 'File' menu actions. 
 94          self.gui.Bind(wx.EVT_MENU, self.gui.analysis.menu_new, id=self.MENU_FILE_NEW) 
 95          self.gui.Bind(wx.EVT_MENU, self.gui.analysis.menu_close, id=self.MENU_FILE_CLOSE) 
 96          self.gui.Bind(wx.EVT_MENU, self.gui.analysis.menu_close_all, id=self.MENU_FILE_CLOSE_ALL) 
 97          self.gui.Bind(wx.EVT_MENU, self.gui.state_load, id=self.MENU_FILE_OPEN) 
 98          self.gui.Bind(wx.EVT_MENU, self.gui.action_state_save, id=self.MENU_FILE_SAVE) 
 99          self.gui.Bind(wx.EVT_MENU, self.gui.action_state_save_as, id=self.MENU_FILE_SAVE_AS) 
100          self.gui.Bind(wx.EVT_MENU, self.gui.action_export_bmrb, id=self.MENU_FILE_EXPORT_BMRB) 
101          self.gui.Bind(wx.EVT_MENU, self.gui.exit_gui, id=self.MENU_FILE_EXIT) 
102   
103          # The 'View' menu entries. 
104          menu = wx.Menu() 
105          menu.AppendItem(build_menu_item(menu, id=self.MENU_VIEW_CONTROLLER, text="&Controller\tCtrl+Z", icon=fetch_icon('oxygen.apps.preferences-system-performance', "16x16"))) 
106          menu.AppendItem(build_menu_item(menu, id=self.MENU_VIEW_SPIN_VIEW, text="&Spin viewer\tCtrl+T", icon=fetch_icon('relax.spin', "16x16"))) 
107          menu.AppendItem(build_menu_item(menu, id=self.MENU_VIEW_RESULTS, text="&Results viewer\tCtrl+R", icon=fetch_icon('oxygen.actions.view-statistics', "16x16"))) 
108          menu.AppendItem(build_menu_item(menu, id=self.MENU_VIEW_PIPE_EDIT, text="&Data pipe editor\tCtrl+D", icon=fetch_icon('relax.pipe', "16x16"))) 
109          menu.AppendItem(build_menu_item(menu, id=self.MENU_VIEW_PROMPT, text="relax &prompt\tCtrl+P", icon=fetch_icon('oxygen.mimetypes.application-x-executable-script', "16x16"))) 
110          self.menubar.Append(menu, "&View") 
111   
112          # The 'View' actions. 
113          self.gui.Bind(wx.EVT_MENU, self.gui.show_controller, id=self.MENU_VIEW_CONTROLLER) 
114          self.gui.Bind(wx.EVT_MENU, self.gui.show_prompt, id=self.MENU_VIEW_PROMPT) 
115          self.gui.Bind(wx.EVT_MENU, self.gui.show_tree, id=self.MENU_VIEW_SPIN_VIEW) 
116          self.gui.Bind(wx.EVT_MENU, self.gui.show_results_viewer, id=self.MENU_VIEW_RESULTS) 
117          self.gui.Bind(wx.EVT_MENU, self.gui.show_pipe_editor, id=self.MENU_VIEW_PIPE_EDIT) 
118   
119          # The auto generated 'User functions' menu entries. 
120          self.menu_uf_ids = build_uf_menus(parent=self.gui, menubar=self.menubar) 
121   
122          # The 'Tools' menu entries. 
123          menu = wx.Menu() 
124          menu.AppendItem(build_menu_item(menu, id=self.MENU_TOOLS_FORMAT, text="&Free file format settings", icon=fetch_icon('oxygen.actions.document-properties', "16x16"))) 
125          menu.AppendItem(build_menu_item(menu, id=self.MENU_TOOLS_SYS_INFO, text="System &information", icon=fetch_icon('oxygen.actions.help-about', "16x16"))) 
126   
127          # The 'Tools->Test suite" sub-menu. 
128          test_suite_item = build_menu_item(menu, id=self.MENU_TOOLS_TEST_SUITE, text="&Test suite", icon=fetch_icon('oxygen.mimetypes.application-x-desktop', "16x16")) 
129          sub_menu = wx.Menu() 
130          test_suite_item.SetSubMenu(sub_menu) 
131          sub_menu.AppendItem(build_menu_item(sub_menu, id=self.MENU_TOOLS_TEST_SUITE_ALL, text="&Full test suite", icon=fetch_icon('oxygen.mimetypes.application-x-desktop', "16x16"))) 
132          sub_menu.AppendSeparator() 
133          sub_menu.AppendItem(build_menu_item(sub_menu, id=self.MENU_TOOLS_TEST_SUITE_SYS, text="&System tests", icon=fetch_icon('oxygen.mimetypes.application-x-desktop', "16x16"))) 
134          sub_menu.AppendItem(build_menu_item(sub_menu, id=self.MENU_TOOLS_TEST_SUITE_UNIT, text="&Unit tests", icon=fetch_icon('oxygen.mimetypes.application-x-desktop', "16x16"))) 
135          sub_menu.AppendItem(build_menu_item(sub_menu, id=self.MENU_TOOLS_TEST_SUITE_GUI, text="&GUI tests", icon=fetch_icon('oxygen.mimetypes.application-x-desktop', "16x16"))) 
136          sub_menu.AppendItem(build_menu_item(sub_menu, id=self.MENU_TOOLS_TEST_SUITE_VERIFICATION, text="&Verification tests", icon=fetch_icon('oxygen.mimetypes.application-x-desktop', "16x16"))) 
137          menu.AppendItem(test_suite_item) 
138          self.menubar.Append(menu, "&Tools") 
139   
140          # The 'Tools' menu actions. 
141          self.gui.Bind(wx.EVT_MENU, self.gui.free_file_format_settings, id=self.MENU_TOOLS_FORMAT) 
142          self.gui.Bind(wx.EVT_MENU, self._sys_info, id=self.MENU_TOOLS_SYS_INFO) 
143          self.gui.Bind(wx.EVT_MENU, self.gui.run_test_suite, id=self.MENU_TOOLS_TEST_SUITE_ALL) 
144          self.gui.Bind(wx.EVT_MENU, self.gui.run_test_suite_sys, id=self.MENU_TOOLS_TEST_SUITE_SYS) 
145          self.gui.Bind(wx.EVT_MENU, self.gui.run_test_suite_unit, id=self.MENU_TOOLS_TEST_SUITE_UNIT) 
146          self.gui.Bind(wx.EVT_MENU, self.gui.run_test_suite_gui, id=self.MENU_TOOLS_TEST_SUITE_GUI) 
147          self.gui.Bind(wx.EVT_MENU, self.gui.run_test_suite_verification, id=self.MENU_TOOLS_TEST_SUITE_VERIFICATION) 
148   
149          # The 'Help' menu entries. 
150          menu = wx.Menu() 
151          menu.AppendItem(build_menu_item(menu, id=self.MENU_HELP_MANUAL, text="relax user &manual\tF1", icon=fetch_icon('oxygen.mimetypes.application-pdf', "16x16"))) 
152          menu.AppendSeparator() 
153          menu.AppendItem(build_menu_item(menu, id=self.MENU_HELP_MAIL, text="Mailing list &contact (relax-users@gna.org)", icon=fetch_icon('oxygen.actions.mail-mark-unread-new', "16x16"))) 
154          menu.AppendItem(build_menu_item(menu, id=self.MENU_HELP_REFS, text="&References", icon=fetch_icon('oxygen.actions.flag-blue', "16x16"))) 
155          menu.AppendSeparator() 
156          menu.AppendItem(build_menu_item(menu, id=self.MENU_HELP_GPL, text="&Licence", icon=fetch_icon('relax.gnu-head-mini', "16x16"))) 
157          menu.AppendSeparator() 
158          menu.AppendItem(build_menu_item(menu, id=self.MENU_HELP_ABOUT, text="About rela&x", icon=fetch_icon("relax.relax"))) 
159          self.menubar.Append(menu, "&Help") 
160   
161          # The 'Help' menu actions. 
162          self.gui.Bind(wx.EVT_MENU, self.gui.relax_manual, id=self.MENU_HELP_MANUAL) 
163          self.gui.Bind(wx.EVT_MENU, self.gui.contact_relax, id=self.MENU_HELP_MAIL) 
164          self.gui.Bind(wx.EVT_MENU, self.gui.references, id=self.MENU_HELP_REFS) 
165          self.gui.Bind(wx.EVT_MENU, self._licence, id=self.MENU_HELP_GPL) 
166          self.gui.Bind(wx.EVT_MENU, self.gui.about_relax, id=self.MENU_HELP_ABOUT) 
167   
168          # Add the menu bar GUI item to the main frame. 
169          if status.show_gui: 
170              self.gui.SetMenuBar(self.menubar) 
171   
172          # Menu update. 
173          self.gui.Bind(wx.EVT_MENU_OPEN, self.update_menus) 
174   
175   
176 -    def _create_menu(self, menu, entries): 
177          """Build the menu.""" 
178   
179          # Loop over the menu entries. 
180          for item in entries: 
181              # Build the menu entry. 
182              menu_item = build_menu_item(menu, id=item[0], text=item[1], icon=item[2]) 
183   
184              # A sub-menu. 
185              if len(item[4]): 
186                  # The sub-menu. 
187                  sub_menu = wx.Menu() 
188   
189                  # Loop over the sub-menus. 
190                  for sub_item in item[4]: 
191                      # Build the menu entry. 
192                      sub_menu_item = build_menu_item(sub_menu, id=sub_item[0], text=sub_item[1], icon=sub_item[2]) 
193                      sub_menu.AppendItem(sub_menu_item) 
194   
195                      # The menu actions. 
196                      self.gui.Bind(wx.EVT_MENU, sub_item[3], id=sub_item[0]) 
197   
198                  # Append the sub-menu. 
199                  menu_item.SetSubMenu(sub_menu) 
200   
201              # A normal menu item. 
202              else: 
203                  # The menu actions. 
204                  self.gui.Bind(wx.EVT_MENU, item[3], id=item[0]) 
205   
206              # Append the menu item. 
207              menu.AppendItem(menu_item) 
208   
209   
210 -    def _licence(self, event): 
211          """Show the GPL licence. 
212   
213          @param event:   The wx event. 
214          @type event:    wx event 
215          """ 
216   
217          # Print the GPL to STDOUT. 
218          file = open('docs/COPYING') 
219          for line in file.readlines(): 
220              sys.stdout.write(line) 
221   
222          # Show the relax controller. 
223          self.gui.show_controller(event) 
224   
225   
226 -    def _sys_info(self, event): 
227          """Show the full system information using the sys_info user function. 
228   
229          @param event:   The wx event. 
230          @type event:    wx event 
231          """ 
232   
233          # Launch the user function. 
234          uf_store['sys_info']() 
235   
236   
237 -    def update_menus(self, event): 
238          """Update the menus dependent on the relax state. 
239   
240          @param event:   The wx event. 
241          @type event:    wx event 
242          """ 
243   
244          # The status object. 
245          status = Status() 
246   
247          # Flag for enabling or disabling the menu entries. 
248          enable = False 
249          if not status.exec_lock.locked(): 
250              enable = True 
251   
252          # The file menu entries. 
253          self.menubar.Enable(self.MENU_FILE_NEW, enable) 
254          self.menubar.Enable(self.MENU_FILE_CLOSE, enable) 
255          self.menubar.Enable(self.MENU_FILE_CLOSE_ALL, enable) 
256          self.menubar.Enable(self.MENU_FILE_OPEN, enable) 
257          self.menubar.Enable(self.MENU_FILE_SAVE, enable) 
258          self.menubar.Enable(self.MENU_FILE_SAVE_AS, enable) 
259   
260          # The view menu entries. 
261          self.menubar.Enable(self.MENU_VIEW_PROMPT, enable) 
262   
263          # Loop over the user function menus. 
264          for id in self.menu_uf_ids: 
265              # Loop over the user function menu items. 
266              menu = self.menubar.GetMenu(id) 
267              for item in menu.GetMenuItems(): 
268                  # Enable/disable. 
269                  item.Enable(enable) 
270   
271                  # Sub-menu. 
272                  submenu = item.GetSubMenu() 
273                  if submenu: 
274                      for subitem in submenu.GetMenuItems(): 
275                          subitem.Enable(enable) 
276