source: sasview/sansview/perspectives/fitting/help_panel.py @ cb69775

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 cb69775 was 5062bbf, checked in by Gervaise Alina <gervyh@…>, 15 years ago

working on documentation

  • Property mode set to 100644
File size: 4.3 KB
Line 
1#!/usr/bin/python
2
3import wx
4import wx.html as html
5from wx.lib.splitter import MultiSplitterWindow
6import os
7
8
9class HelpWindow(wx.Frame):
10    """
11    """
12    def __init__(self, parent, id, title= 'HelpWindow', pageToOpen=None):
13        wx.Frame.__init__(self, parent, id, title, size=(850, 500))
14        """
15        contains help info
16        """
17     
18        splitter = MultiSplitterWindow(self, style=wx.SP_LIVE_UPDATE)
19        rpanel = wx.Panel(splitter, -1)
20        lpanel = wx.Panel(splitter, -1,style=wx.BORDER_SUNKEN)
21       
22        vbox = wx.BoxSizer(wx.VERTICAL)
23        header = wx.Panel(rpanel, -1)
24        header.SetBackgroundColour('#6666FF')
25        header.SetForegroundColour('WHITE')
26        hbox = wx.BoxSizer(wx.HORIZONTAL)
27        st = wx.StaticText(header, -1, 'Contents', (5, 5))
28        font = st.GetFont()
29        font.SetPointSize(10)
30        st.SetFont(font)
31        hbox.Add(st, 1, wx.TOP | wx.BOTTOM | wx.LEFT, 5)
32        header.SetSizer(hbox)
33        vbox.Add(header, 0, wx.EXPAND)
34       
35        vboxl= wx.BoxSizer(wx.VERTICAL)
36        headerl = wx.Panel(lpanel, -1, size=(-1, 20))
37       
38        headerl.SetBackgroundColour('#6666FF')
39        headerl.SetForegroundColour('WHITE')
40        hboxl = wx.BoxSizer(wx.HORIZONTAL)
41        lst = wx.StaticText(headerl, -1, 'Menu', (5, 5))
42        fontl = lst.GetFont()
43        fontl.SetPointSize(10)
44        lst.SetFont(fontl)
45        hboxl.Add(lst, 1, wx.TOP | wx.BOTTOM | wx.LEFT, 5)
46        headerl.SetSizer(hboxl)
47        vboxl.Add(headerl, 0, wx.EXPAND)
48        self.lhelp = html.HtmlWindow(lpanel, -1, style=wx.NO_BORDER)
49        self.rhelp = html.HtmlWindow(rpanel, -1, style=wx.NO_BORDER, size=(500,-1))
50        page1="""<html>
51            <body>
52             <p>Select topic on Menu</p>
53            </body>
54            </html>"""
55        page="""<html>
56            <body>
57            <ul>
58            <li><a href ="media/change_scale_help.html" target ="showframe">Change Scale</a><br></li>
59            <li><a href ="media/reset_Graph_help.html" target ="showframe">Graph Help</a><br></li>
60            <li><a href ="media/status_bar_help.html" target ="showframe">Status Bar Help</a><br></li>
61            <li><a href ="media/load_data_help.html" target ="showframe">Load a File</a><br></li>
62            <li><a href ="media/simultaneous_fit_help.html" target ="showframe">Simultaneous Fit</a><br></li>
63            <li><a href ="media/single_fit_help.html" target ="showframe">Single Fit</a><br></li>
64            <li><a href ="media/model_use_help.html" target ="showframe">Visualize Model</a><br></li>
65            <li><a href ="media/averaging_help.html" target ="showframe">Data Averaging</a><br></li>
66            <li><a href ="media/model_functions.html" target ="showframe">Model Functions</a><br></li>
67            </ul>
68            </body>
69            </html>"""
70        self.rhelp.SetPage(page1)
71        self.lhelp.SetPage(page)
72        self.lhelp.Bind(wx.html.EVT_HTML_LINK_CLICKED,self.OnLinkClicked )
73       
74        #open the help frame a the current page
75        if  pageToOpen!= None:
76            self.rhelp.LoadPage(str( pageToOpen))
77           
78        vbox.Add(self.rhelp,1, wx.EXPAND)
79        vboxl.Add(self.lhelp, 1, wx.EXPAND)
80        rpanel.SetSizer(vbox)
81        lpanel.SetSizer(vboxl)
82        lpanel.SetFocus()
83       
84        vbox1 = wx.BoxSizer(wx.HORIZONTAL)
85        vbox1.Add(splitter,1,wx.EXPAND)
86        splitter.AppendWindow(lpanel, 200)
87        splitter.AppendWindow(rpanel)
88        self.SetSizer(vbox1)
89       
90        self.Centre()
91        self.Show(True)
92       
93    def OnButtonClicked(self, event):
94        """
95        Function to diplay html page related to the hyperlinktext selected
96        """
97        self.rhelp.LoadPage("media/modelfunction.html")
98       
99    def OnLinkClicked(self, event):
100        """
101        Function to diplay html page related to the hyperlinktext selected
102        """
103        link= event.GetLinkInfo().GetHref()
104        self.rhelp.LoadPage(link)
105"""
106Example: ::
107
108    class ViewApp(wx.App):
109        def OnInit(self):
110            frame = HelpWindow(None, -1, 'HelpWindow')   
111            frame.Show(True)
112            self.SetTopWindow(frame)
113           
114            return True
115           
116   
117    if __name__ == "__main__":
118    app = ViewApp(0)
119    app.MainLoop() 
120
121"""   
Note: See TracBrowser for help on using the repository browser.