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

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 c067d12 was fdc3cb0, checked in by Jae Cho <jhjcho@…>, 13 years ago

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