source: sasview/fittingview/src/sans/perspectives/fitting/help_panel.py @ 8e4a562

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 8e4a562 was ec538c7, checked in by Gervaise Alina <gervyh@…>, 13 years ago

add help for batch
  • Property mode set to 100644
File size: 5.6 KB
Line 
1#!/usr/bin/python
2
3import wx
4import wx.html as html
5from wx.lib.splitter import MultiSplitterWindow
6import os
7
8from wx.lib.scrolledpanel import ScrolledPanel
9
10class HelpPanel(ScrolledPanel):
11    def __init__(self, parent, **kwargs):
12        ScrolledPanel.__init__(self, parent, **kwargs)
13        self.SetupScrolling()
14       
15class HelpWindow(wx.Frame):
16    """
17    """
18    def __init__(self, parent, id, title= 'HelpWindow', pageToOpen=None):
19        wx.Frame.__init__(self, parent, id, title, size=(850, 530))
20        """
21        contains help info
22        """
23     
24        splitter = MultiSplitterWindow(self, style=wx.SP_LIVE_UPDATE)
25        rpanel = wx.Panel(splitter, -1)
26        lpanel = wx.Panel(splitter, -1,style=wx.BORDER_SUNKEN)
27       
28        vbox = wx.BoxSizer(wx.VERTICAL)
29        header = wx.Panel(rpanel, -1)
30        header.SetBackgroundColour('#6666FF')
31        header.SetForegroundColour('WHITE')
32        hbox = wx.BoxSizer(wx.HORIZONTAL)
33        st = wx.StaticText(header, -1, 'Contents', (5, 5))
34        font = st.GetFont()
35        font.SetPointSize(10)
36        st.SetFont(font)
37        hbox.Add(st, 1, wx.TOP | wx.BOTTOM | wx.LEFT, 5)
38        header.SetSizer(hbox)
39        vbox.Add(header, 0, wx.EXPAND)
40       
41        vboxl= wx.BoxSizer(wx.VERTICAL)
42        headerl = wx.Panel(lpanel, -1, size=(-1, 20))
43       
44        headerl.SetBackgroundColour('#6666FF')
45        headerl.SetForegroundColour('WHITE')
46        hboxl = wx.BoxSizer(wx.HORIZONTAL)
47        lst = wx.StaticText(headerl, -1, 'Menu', (5, 5))
48        fontl = lst.GetFont()
49        fontl.SetPointSize(10)
50        lst.SetFont(fontl)
51        hboxl.Add(lst, 1, wx.TOP | wx.BOTTOM | wx.LEFT, 5)
52        headerl.SetSizer(hboxl)
53        vboxl.Add(headerl, 0, wx.EXPAND)
54        self.lhelp = html.HtmlWindow(lpanel, -1, style=wx.NO_BORDER)
55        self.rhelp = html.HtmlWindow(rpanel, -1, style=wx.NO_BORDER, size=(500,-1))
56
57        # get the media path
58        if pageToOpen != None:
59            path = os.path.dirname(pageToOpen)
60        else:
61            from sans.models import get_data_path as model_path
62            # Get models help model_function path
63            path = model_path(media='media')
64
65        self.path = os.path.join(path,"model_functions.html")
66        self.path_pd = os.path.join(path,"pd_help.html")
67        self.path_sm = os.path.join(path,"smear_computation.html")
68        from sans.perspectives.fitting import get_data_path as fit_path
69        fitting_path = fit_path(media='media')
70       
71        _html_file = [("load_data_help.html", "Load a File"),
72                      ("single_fit_help.html", "Single Fit"),
73                      ("simultaneous_fit_help.html", "Simultaneous Fit"),
74                      ("batch_help.html", "Batch Fit"),
75                      ("model_use_help.html", "Model Selection"),
76                      ("%s" % self.path, "Model Functions"),
77                      ("%s" % self.path_pd, "Polydispersion Distributions"),
78                      ("%s" % self.path_sm, "Smear Computation"),
79                      ("key_help.html", "Key Combination"),
80                      ("status_bar_help.html", "Status Bar Help"),
81                      ]
82
83                   
84        page1="""<html>
85            <body>
86             <p>Select topic on Menu</p>
87            </body>
88            </html>"""
89        page="""<html>
90            <body>
91            <ul>
92            """
93        for (p, title) in _html_file:
94            pp = os.path.join(fitting_path, p)
95            page += """<li><a href ="%s" target="showframe">%s</a><br></li>""" % (pp, title)
96        page += """</ul>
97                    </body>
98                    </html>
99                """
100        #page += """
101        #    <li><a href ="%s" target="showframe">Model Functions</a><br></li>
102        #   <li><a href ="%s" target="showframe">Polydispersion Distributions</a><br></li>
103        #    <li><a href ="%s" target="showframe">Smear Computation</a><br></li>
104        #    </ul>
105        #    </body>
106        #    </html>""" % (self.path, self.path_pd, self.path_sm)
107       
108        self.rhelp.SetPage(page1)
109        self.lhelp.SetPage(page)
110        self.lhelp.Bind(wx.html.EVT_HTML_LINK_CLICKED,self.OnLinkClicked )
111       
112        #open the help frame a the current page
113        if  pageToOpen!= None:
114            self.rhelp.LoadPage(str( pageToOpen))
115           
116        vbox.Add(self.rhelp,1, wx.EXPAND)
117        vboxl.Add(self.lhelp, 1, wx.EXPAND)
118        rpanel.SetSizer(vbox)
119        lpanel.SetSizer(vboxl)
120        lpanel.SetFocus()
121       
122        vbox1 = wx.BoxSizer(wx.HORIZONTAL)
123        vbox1.Add(splitter,1,wx.EXPAND)
124        splitter.AppendWindow(lpanel, 200)
125        splitter.AppendWindow(rpanel)
126        self.SetSizer(vbox1)
127       
128        self.Centre()
129        self.Show(True)
130       
131    def OnButtonClicked(self, event):
132        """
133        Function to diplay Model html page related to the hyperlinktext selected
134        """
135       
136        self.rhelp.LoadPage(self.path)
137       
138    def OnLinkClicked(self, event):
139        """
140        Function to diplay html page related to the hyperlinktext selected
141        """
142        link= event.GetLinkInfo().GetHref()
143       
144        self.rhelp.LoadPage(os.path.abspath(link))
145   
146       
147"""
148Example: ::
149
150    class ViewApp(wx.App):
151        def OnInit(self):
152            frame = HelpWindow(None, -1, 'HelpWindow')   
153            frame.Show(True)
154            self.SetTopWindow(frame)
155           
156            return True
157           
158   
159    if __name__ == "__main__":
160    app = ViewApp(0)
161    app.MainLoop() 
162
163"""   
Note: See TracBrowser for help on using the repository browser.