Changeset d955bf19 in sasview for guiframe/dummyapp.py


Ignore:
Timestamp:
Jun 3, 2010 11:36:56 AM (14 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
d7a39e5
Parents:
83f4445
Message:

working on documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • guiframe/dummyapp.py

    rd68c655 rd955bf19  
    11""" 
    2     Dummy application. 
    3     Allows the user to set an external data manager 
     2Dummy application. 
     3Allows the user to set an external data manager 
    44""" 
    55import gui_manager 
    … …  
    99    def populate_menu(self, id, parent): 
    1010        """ 
    11             Create and return the list of application menu 
    12             items for the plug-in.  
    13              
    14             @param id: deprecated. Un-used. 
    15             @param parent: parent window 
    16             @return: plug-in menu 
     11        Create and return the list of application menu 
     12        items for the plug-in.  
     13         
     14        :param id: deprecated. Un-used. 
     15        :param parent: parent window 
     16         
     17        :return: plug-in menu 
     18         
    1719        """ 
    1820        import wx 
    … …  
    3436    def get_panels(self, parent): 
    3537        """ 
    36             Create and return the list of wx.Panels for your plug-in. 
    37             Define the plug-in perspective. 
    38              
    39             Panels should inherit from DefaultPanel defined below, 
    40             or should present the same interface. They must define 
    41             "window_caption" and "window_name". 
    42              
    43             @param parent: parent window 
    44             @return: list of panels 
     38        Create and return the list of wx.Panels for your plug-in. 
     39        Define the plug-in perspective. 
     40         
     41        Panels should inherit from DefaultPanel defined below, 
     42        or should present the same interface. They must define 
     43        "window_caption" and "window_name". 
     44         
     45        :param parent: parent window 
     46         
     47        :return: list of panels 
     48         
    4549        """ 
    4650        ## Save a reference to the parent 
    … …  
    5963    def get_tools(self): 
    6064        """ 
    61             Returns a set of menu entries for tools 
     65        Returns a set of menu entries for tools 
    6266        """ 
    6367        def _test_dialog(event): 
    … …  
    7074    def get_context_menu(self, graph=None): 
    7175        """ 
    72             This method is optional. 
     76        This method is optional. 
     77     
     78        When the context menu of a plot is rendered, the  
     79        get_context_menu method will be called to give you a  
     80        chance to add a menu item to the context menu. 
    7381         
    74             When the context menu of a plot is rendered, the  
    75             get_context_menu method will be called to give you a  
    76             chance to add a menu item to the context menu. 
    77              
    78             A ref to a Graph object is passed so that you can 
    79             investigate the plot content and decide whether you 
    80             need to add items to the context menu.   
    81              
    82             This method returns a list of menu items. 
    83             Each item is itself a list defining the text to  
    84             appear in the menu, a tool-tip help text, and a 
    85             call-back method. 
    86              
    87             @param graph: the Graph object to which we attach the context menu 
    88             @return: a list of menu items with call-back function 
     82        A ref to a Graph object is passed so that you can 
     83        investigate the plot content and decide whether you 
     84        need to add items to the context menu.   
     85         
     86        This method returns a list of menu items. 
     87        Each item is itself a list defining the text to  
     88        appear in the menu, a tool-tip help text, and a 
     89        call-back method. 
     90         
     91        :param graph: the Graph object to which we attach the context menu 
     92         
     93        :return: a list of menu items with call-back function 
    8994        """ 
    9095        return [["Menu text",  
    … …  
    96101    def __init__(self): 
    97102        """ 
    98             Initialization 
     103        Initialization 
    99104        """ 
    100105        self.gui = gui_manager.ViewApp(0) 
Note: See TracChangeset for help on using the changeset viewer.