Source Code for Module user_functions.reset

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2003-2013 Edward d'Auvergne                                   # 
 4  #                                                                             # 
 5  # This file is part of the program relax (http://www.nmr-relax.com).          # 
 6  #                                                                             # 
 7  # This program is free software: you can redistribute it and/or modify        # 
 8  # it under the terms of the GNU General Public License as published by        # 
 9  # the Free Software Foundation, either version 3 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # This program is distributed in the hope that it will be useful,             # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
15  # GNU General Public License for more details.                                # 
16  #                                                                             # 
17  # You should have received a copy of the GNU General Public License           # 
18  # along with this program.  If not, see <http://www.gnu.org/licenses/>.       # 
19  #                                                                             # 
20  ############################################################################### 
21   
22  # Module docstring. 
23  """The reset user function definitions.""" 
24   
25  # relax module imports. 
26  from graphics import WIZARD_IMAGE_PATH 
27  import pipe_control.reset 
28  from user_functions.data import Uf_info; uf_info = Uf_info() 
29  from user_functions.objects import Desc_container 
30   
31   
32  # The reset user function. 
33  uf = uf_info.add_uf('reset') 
34  uf.title = "Reinitialise the relax data storage object." 
35  uf.title_short = "Reset relax." 
36  # Description. 
37  uf.desc.append(Desc_container()) 
38  uf.desc[-1].add_paragraph("All of the data of the relax data storage object will be erased and hence relax will return to its initial state.") 
39  uf.backend = pipe_control.reset.reset 
40  uf.menu_text = "&reset" 
41  uf.gui_icon = "oxygen.actions.dialog-close" 
42  uf.gui_sync = True    # Force synchronous operation, as asynchronous calls kill the GUI! 
43  uf.wizard_size = (600, 300) 
44  uf.wizard_apply_button = False 
45  uf.wizard_image = WIZARD_IMAGE_PATH + 'reset.png' 
46