Module Gnumed.wxpython.gui.gmManual

GNUMed manuals in a HTML browser window

A very basic HTML browser with back/forward history buttons with the main pourpose of browsing the gnumed manuals The manuals should reside where the manual_path points to.

@copyright: GPL v2 or later @thanks: this code has been heavily "borrowed" from Robin Dunn's extraordinary wxPython sample

Classes

class ManualHtmlPanel (parent, frame)

Expand source code

class ManualHtmlPanel(wx.Panel):
        def __init__(self, parent, frame):
                wx.Panel.__init__(self, parent, -1)
                self.frame = frame

                # get base directory for manuals from broker
                paths = gmTools.gmPaths(app_name = 'gnumed', wx = wx)
                candidates = [
                        os.path.join(paths.local_base_dir, 'doc', 'user-manual'),
                        '/usr/share/doc/gnumed/user-manual/',
                        os.path.join(paths.system_app_data_dir, 'doc', 'user-manual')
                ]
                for self.docdir in candidates:
                        if os.access(self.docdir, os.R_OK):
                                _log.info('found Manual path [%s]', self.docdir)
                                break

                self.box = wx.BoxSizer(wx.VERTICAL)

                infobox = wx.BoxSizer(wx.HORIZONTAL)
                n = wx.NewId()
                self.infoline = wx.TextCtrl(self, n, style=wx.TE_READONLY)
                self.infoline.SetBackgroundColour(wx.LIGHT_GREY)
                infobox.Add(self.infoline, 1, wx.GROW|wx.ALL)
                self.box.Add(infobox, 0, wx.GROW)

                self.html = ManualHtmlWindow(self, -1)
                self.html.SetRelatedFrame(frame, "")
                self.html.SetRelatedStatusBar(0)
                self.box.Add(self.html, 1, wx.GROW)

                self.SetSizer(self.box)
                self.SetAutoLayout(True)

                self.already_loaded = None
        #--------------------------------------------------------
        def FirstLoad(self):
                if not self.already_loaded:
                        self.already_loaded = 1
                        self.OnShowDefault(None)
        #--------------------------------------------------------
        def ShowTitle(self, title=''):
                self.infoline.Clear()
                self.infoline.WriteText(title)
        #--------------------------------------------------------
        def OnShowDefault(self, event):
                name = os.path.join(self.docdir, 'index.html')
                if os.access (name, os.F_OK):
                        self.html.LoadPage(name)
                else:
                        _log.error("cannot load local document %s", name)
                        self.html.LoadPage('https://www.gnumed.de/documentation/')
        #--------------------------------------------------------
        def OnLoadFile(self, event):
                dlg = wx.FileDialog(self, wildcard = '*.htm*', style=wx.FD_OPEN)
                if dlg.ShowModal():
                        path = dlg.GetPath()
                        self.html.LoadPage(path)
                dlg.DestroyLater()
        #--------------------------------------------------------
        def OnBack(self, event):
                self.html.HistoryBack()
        #--------------------------------------------------------
        def OnForward(self, event):
                self.html.HistoryForward()
        #--------------------------------------------------------
        def OnViewSource(self, event):
                return 1
                # FIXME:
                #from wxPython.lib.dialogs import wx.ScrolledMessageDialog
                source = self.html.GetParser().GetSource()
                dlg = wx.ScrolledMessageDialog(self, source, _('HTML Source'))
                dlg.ShowModal()
                dlg.DestroyLater()
        #--------------------------------------------------------
        def OnPrint(self, event):
                self.printer.PrintFile(self.html.GetOpenedPage())

Panel() Panel(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr)

A panel is a window on which controls are placed.

Ancestors

• wx._core.Panel
• wx._core.Window
• wx._core.WindowBase
• wx._core.EvtHandler
• wx._core.Object
• wx._core.Trackable
• sip.wrapper
• sip.simplewrapper

Methods

def FirstLoad(self)

Expand source code

def FirstLoad(self):
        if not self.already_loaded:
                self.already_loaded = 1
                self.OnShowDefault(None)

def OnBack(self, event)

Expand source code

def OnBack(self, event):
        self.html.HistoryBack()

def OnForward(self, event)

Expand source code

def OnForward(self, event):
        self.html.HistoryForward()

def OnLoadFile(self, event)

Expand source code

def OnLoadFile(self, event):
        dlg = wx.FileDialog(self, wildcard = '*.htm*', style=wx.FD_OPEN)
        if dlg.ShowModal():
                path = dlg.GetPath()
                self.html.LoadPage(path)
        dlg.DestroyLater()

def OnPrint(self, event)

Expand source code

def OnPrint(self, event):
        self.printer.PrintFile(self.html.GetOpenedPage())

def OnShowDefault(self, event)

Expand source code

def OnShowDefault(self, event):
        name = os.path.join(self.docdir, 'index.html')
        if os.access (name, os.F_OK):
                self.html.LoadPage(name)
        else:
                _log.error("cannot load local document %s", name)
                self.html.LoadPage('https://www.gnumed.de/documentation/')

def OnViewSource(self, event)

Expand source code

def OnViewSource(self, event):
        return 1
        # FIXME:
        #from wxPython.lib.dialogs import wx.ScrolledMessageDialog
        source = self.html.GetParser().GetSource()
        dlg = wx.ScrolledMessageDialog(self, source, _('HTML Source'))
        dlg.ShowModal()
        dlg.DestroyLater()

def ShowTitle(self, title='')

Expand source code

def ShowTitle(self, title=''):
        self.infoline.Clear()
        self.infoline.WriteText(title)

class ManualHtmlWindow (parent, id)

Expand source code

class ManualHtmlWindow(wx.html.HtmlWindow):
        def __init__(self, parent, id):
                wx.html.HtmlWindow.__init__(self, parent, id)
                self.parent = parent

        def OnSetTitle(self, title=''):
                self.parent.ShowTitle(title)

HtmlWindow() HtmlWindow(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=HW_DEFAULT_STYLE, name="htmlWindow")

wxHtmlWindow is probably the only class you will directly use unless you want to do something special (like adding new tag handlers or MIME filters).

Ancestors

• wx._html.HtmlWindow
• wx._core.ScrolledWindow
• wx._core._ScrolledWindowBase
• wx._core.Panel
• wx._core.Window
• wx._core.WindowBase
• wx._core.EvtHandler
• wx._core.Object
• wx._core.Trackable
• wx._html.HtmlWindowInterface
• sip.wrapper
• sip.simplewrapper

Methods

def OnSetTitle(self, title='')

Expand source code

def OnSetTitle(self, title=''):
        self.parent.ShowTitle(title)

OnSetTitle(title)

Called on parsing