source: sasview/guiframe/plugin_base.py @ ecc85443

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since ecc85443 was 957723f, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on guiframe config

  • Property mode set to 100644
File size: 6.9 KB
Line 
1################################################################################
2#This software was developed by the University of Tennessee as part of the
3#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
4#project funded by the US National Science Foundation.
5#
6#See the license text in license.txt
7#
8#copyright 2008, University of Tennessee
9################################################################################
10 
11class PluginBase:
12    """
13    This class defines the interface for a Plugin class
14    that can be used by the gui_manager.
15   
16    Plug-ins should be placed in a sub-directory called "perspectives".
17    For example, a plug-in called Foo should be place in "perspectives/Foo".
18    That directory contains at least two files:
19        perspectives/Foo/__init__.py contains two lines:
20       
21            PLUGIN_ID = "Foo plug-in 1.0"
22            from Foo import *
23           
24        perspectives/Foo/Foo.py contains the definition of the Plugin
25        class for the Foo plug-in. The interface of that Plugin class
26        should follow the interface of the class you are looking at.
27       
28    See dummyapp.py for a plugin example.
29    """
30   
31    def __init__(self, name="Test_plugin", standalone=True):
32        """
33            Abstract class for gui_manager Plugins.
34        """
35        # Define if the plugin is local to Viewerframe  and always active
36        self._always_active = False
37        ## Plug-in name. It will appear on the application menu.
38        self.sub_menu = name     
39        #standalone flag
40        self.standalone = standalone
41        ## Reference to the parent window. Filled by get_panels() below.
42        self.parent = None
43        #plugin state reader
44        self.state_reader = None 
45        self._extensions = ''
46        ## List of panels that you would like to open in AUI windows
47        #  for your plug-in. This defines your plug-in "perspective"
48        self.perspective = []
49       
50    def clear_panel(self):
51        """
52        clear all related panels
53        """
54    def get_extensions(self):
55        """
56        return state reader and its extensions
57        """
58        return self.state_reader, self._extensions
59   
60    def can_load_data(self):
61        """
62        if return True, then call handler to laod data
63        """
64        return False
65   
66    def use_data(self):
67        """
68        return True if these plugin use data
69        """
70        return True
71   
72    def is_in_use(self, data_id):
73        """
74        get a  data id and return true or false if the data
75        is currently in use the current plugin
76        """
77        return False
78   
79    def delete_data(self, data_id):
80        """
81        Delete all references of data which id are in data_list.
82        """
83       
84    def load_data(self, event):
85        """
86        Load  data
87        """
88        raise NotImplemented
89 
90    def load_folder(self, event):
91        """
92        Load entire folder
93        """
94        raise NotImplemented 
95   
96    def set_is_active(self, active=False):
97        """
98        """
99        self._always_active = active
100       
101    def is_always_active(self):
102        """
103        return True is this plugin is always active and it is local to guiframe
104        even if the user is switching between perspectives
105        """
106        return self._always_active
107
108    def populate_menu(self, parent):
109        """
110        Create and return the list of application menu
111        items for the plug-in.
112       
113        :param parent: parent window
114       
115        :return: plug-in menu
116       
117        """
118        return []
119   
120    def get_panels(self, parent):
121        """
122        Create and return the list of wx.Panels for your plug-in.
123        Define the plug-in perspective.
124       
125        Panels should inherit from DefaultPanel defined below,
126        or should present the same interface. They must define
127        "window_caption" and "window_name".
128       
129        :param parent: parent window
130       
131        :return: list of panels
132       
133        """
134        ## Save a reference to the parent
135        self.parent = parent
136       
137        # Return the list of panels
138        return []
139   
140 
141    def get_tools(self):
142        """
143        Returns a set of menu entries for tools
144        """
145        return []
146       
147   
148    def get_context_menu(self, plotpanel=None):
149        """
150        This method is optional.
151   
152        When the context menu of a plot is rendered, the
153        get_context_menu method will be called to give you a
154        chance to add a menu item to the context menu.
155       
156        A ref to a plotpanel object is passed so that you can
157        investigate the plot content and decide whether you
158        need to add items to the context menu. 
159       
160        This method returns a list of menu items.
161        Each item is itself a list defining the text to
162        appear in the menu, a tool-tip help text, and a
163        call-back method.
164       
165        :param graph: the Graph object to which we attach the context menu
166       
167        :return: a list of menu items with call-back function
168       
169        """
170        return []
171   
172    def get_perspective(self):
173        """
174        Get the list of panel names for this perspective
175        """
176        return self.perspective
177   
178    def on_perspective(self, event=None):
179        """
180        Call back function for the perspective menu item.
181        We notify the parent window that the perspective
182        has changed.
183       
184        :param event: menu event
185       
186        """
187        self.parent.set_current_perspective(self)
188        self.parent.set_perspective(self.perspective)
189   
190    def post_init(self):
191        """
192        Post initialization call back to close the loose ends
193        """
194        pass
195   
196    def set_default_perspective(self):
197        """
198       Call back method that True to notify the parent that the current plug-in
199       can be set as default  perspective.
200       when returning False, the plug-in is not candidate for an automatic
201       default perspective setting
202        """
203        if self.standalone:
204            return True
205        return False
206   
207    def set_state(self, state=None, datainfo=None):   
208        """
209        update state
210        """
211    def set_data(self, data_list=None):
212        """
213        receive a list of data and use it in the current perspective
214       
215        """
216    def set_theory(self, theory_list=None):
217        """
218        :param theory_list: list of information
219            related to available theory state
220        """
221        msg = "%s plugin: does not support import theory" % str(self.sub_menu)
222        raise ValueError, msg
223   
224    def on_set_state_helper(self, event):
225        """
226        update state
227        """
228   
Note: See TracBrowser for help on using the repository browser.